summaryrefslogtreecommitdiff
path: root/docs/doc/wasm2c.1
diff options
context:
space:
mode:
authorBen Smith <binji@chromium.org>2020-01-17 16:19:18 -0800
committerBen Smith <binji@chromium.org>2020-01-17 16:19:18 -0800
commit0b99d31dd8b4c16e213680494589ad5b6702ea47 (patch)
treedd29bd53a0e501825882386263fb417f5fa8ba65 /docs/doc/wasm2c.1
parent7c80d05e37dc02870c680869ae3f04ac6d9637ee (diff)
downloadwabt-0b99d31dd8b4c16e213680494589ad5b6702ea47.tar.gz
wabt-0b99d31dd8b4c16e213680494589ad5b6702ea47.tar.bz2
wabt-0b99d31dd8b4c16e213680494589ad5b6702ea47.zip
Move documentation to docs/ directory
It's easier to update than gh-pages
Diffstat (limited to 'docs/doc/wasm2c.1')
-rw-r--r--docs/doc/wasm2c.160
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/doc/wasm2c.1 b/docs/doc/wasm2c.1
new file mode 100644
index 00000000..1d6c1fb3
--- /dev/null
+++ b/docs/doc/wasm2c.1
@@ -0,0 +1,60 @@
+.Dd $Mdocdate$
+.Dt WABT 1
+.Os
+.Sh NAME
+.Nm wasm2c
+.Nd convert a WebAssembly binary file to a C source and header
+.Sh SYNOPSIS
+.Nm wasm2c
+.Op options
+.Ar file
+.Sh DESCRIPTION
+.Nm
+takes a WebAssembly module and produces an equivalent C source and header.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl v , Fl Fl verbose
+Use multiple times for more info
+.It Fl Fl help
+Print a help message
+.It Fl o , Fl Fl output=FILENAME
+Output file for the generated C source file, by default use stdout
+.It Fl Fl enable-exceptions
+Experimental exception handling
+.It Fl Fl disable-mutable-globals
+Import/export mutable globals
+.It Fl Fl enable-saturating-float-to-int
+Saturating float-to-int operators
+.It Fl Fl enable-sign-extension
+Sign-extension operators
+.It Fl Fl enable-simd
+SIMD support
+.It Fl Fl enable-threads
+Threading support
+.It Fl Fl no-debug-names
+Ignore debug names in the binary file
+.El
+.Sh EXAMPLES
+Parse binary file test.wasm and write test.c and test.h
+.Pp
+.Dl $ wasm2c test.wasm -o test.c
+.Pp
+Parse test.wasm, write test.c and test.h, but ignore the debug names, if any
+.Pp
+.Dl $ wasm2c test.wasm --no-debug-names -o test.c
+.Sh SEE ALSO
+.Xr wasm-interp 1 ,
+.Xr wasm-objdump 1 ,
+.Xr wasm-opcodecnt 1 ,
+.Xr wasm-strip 1 ,
+.Xr wasm-validate 1 ,
+.Xr wasm2wat 1 ,
+.Xr wast2json 1 ,
+.Xr wat-desugar 1 ,
+.Xr wat2wasm 1 ,
+.Xr spectest-interp 1
+.Sh BUGS
+If you find a bug, please report it at
+.br
+.Lk https://github.com/WebAssembly/wabt/issues .