diff options
| author | Ben Smith <binji@chromium.org> | 2020-01-17 16:33:03 -0800 |
|---|---|---|
| committer | Ben Smith <binji@chromium.org> | 2020-01-17 16:33:03 -0800 |
| commit | 8bd065771ad7f87c839c2ac76ad924b33d961db5 (patch) | |
| tree | 7ccf0844bad5c11c0e90ad396b2e013a6df18d42 /docs | |
| parent | 0b99d31dd8b4c16e213680494589ad5b6702ea47 (diff) | |
| download | wabt-8bd065771ad7f87c839c2ac76ad924b33d961db5.tar.gz wabt-8bd065771ad7f87c839c2ac76ad924b33d961db5.tar.bz2 wabt-8bd065771ad7f87c839c2ac76ad924b33d961db5.zip | |
Put rendered man page html in docs, not .1 files
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/doc/spectest-interp.1 | 63 | ||||
| -rw-r--r-- | docs/doc/spectest-interp.1.html | 98 | ||||
| -rw-r--r-- | docs/doc/wasm-decompile.1 | 55 | ||||
| -rw-r--r-- | docs/doc/wasm-interp.1 | 74 | ||||
| -rw-r--r-- | docs/doc/wasm-interp.1.html | 115 | ||||
| -rw-r--r-- | docs/doc/wasm-objdump.1 | 50 | ||||
| -rw-r--r-- | docs/doc/wasm-objdump.1.html | 87 | ||||
| -rw-r--r-- | docs/doc/wasm-opcodecnt.1 | 46 | ||||
| -rw-r--r-- | docs/doc/wasm-opcodecnt.1.html | 84 | ||||
| -rw-r--r-- | docs/doc/wasm-strip.1 | 38 | ||||
| -rw-r--r-- | docs/doc/wasm-strip.1.html | 70 | ||||
| -rw-r--r-- | docs/doc/wasm-validate.1 | 60 | ||||
| -rw-r--r-- | docs/doc/wasm-validate.1.html | 93 | ||||
| -rw-r--r-- | docs/doc/wasm2c.1 | 60 | ||||
| -rw-r--r-- | docs/doc/wasm2c.1.html | 95 | ||||
| -rw-r--r-- | docs/doc/wasm2wat.1 | 70 | ||||
| -rw-r--r-- | docs/doc/wasm2wat.1.html | 108 | ||||
| -rw-r--r-- | docs/doc/wast2json.1 | 69 | ||||
| -rw-r--r-- | docs/doc/wast2json.1.html | 108 | ||||
| -rw-r--r-- | docs/doc/wat-desugar.1 | 70 | ||||
| -rw-r--r-- | docs/doc/wat-desugar.1.html | 108 | ||||
| -rw-r--r-- | docs/doc/wat2wasm.1 | 74 | ||||
| -rw-r--r-- | docs/doc/wat2wasm.1.html | 113 |
23 files changed, 1079 insertions, 729 deletions
diff --git a/docs/doc/spectest-interp.1 b/docs/doc/spectest-interp.1 deleted file mode 100644 index aab0c5fa..00000000 --- a/docs/doc/spectest-interp.1 +++ /dev/null @@ -1,63 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm spectest-interp -.Nd read a Spectest JSON file, and run its tests in the interpreter -.Sh SYNOPSIS -.Nm spectest-interp -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -reads a Spectest JSON file, and runs its tests in the interpreter. -.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 this help message -.It Fl Fl enable-exceptions -Enable Experimental exception handling -.It Fl Fl disable-mutable-globals -Disable Import/export mutable globals -.It Fl Fl enable-saturating-float-to-int -Enable Saturating float-to-int operators -.It Fl Fl enable-sign-extension -Enable Sign-extension operators -.It Fl Fl enable-simd -Enable SIMD support -.It Fl Fl enable-threads -Enable Threading support -.It Fl Fl enable-multi-value -Enable Multi-value -.It Fl Fl enable-tail-call -Enable Tail-call support -.It Fl V , Fl Fl value-stack-size=SIZE -Size in elements of the value stack -.It Fl C , Fl Fl call-stack-size=SIZE -Size in elements of the call stack -.It Fl t , Fl Fl trace -Trace execution -.El -.Sh EXAMPLES -Parse test.json and run the spec tests -.Pp -.Dl $ spectest-interp test.json -.Pp -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 1 , -.Xr wasm2wat 1 , -.Xr wast2json 1 , -.Xr wat-desugar 1 , -.Xr wat2wasm 1 -.Sh BUGS -If you find a bug, please report it at -.br -.Lk https://github.com/WebAssembly/wabt/issues . diff --git a/docs/doc/spectest-interp.1.html b/docs/doc/spectest-interp.1.html new file mode 100644 index 00000000..d88cbe5c --- /dev/null +++ b/docs/doc/spectest-interp.1.html @@ -0,0 +1,98 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">spectest-interp</b> — + <span class="Nd" title="Nd">read a Spectest JSON file, and run its tests in + the interpreter</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">spectest-interp</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">spectest-interp</b> reads a Spectest JSON file, and + runs its tests in the interpreter. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print this help message</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Enable Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Disable Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Enable Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Enable Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">Enable SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Enable Threading support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-multi-value</b></dt> + <dd class="It-tag">Enable Multi-value</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-tail-call</b></dt> + <dd class="It-tag">Enable Tail-call support</dd> + <dt class="It-tag"><a class="selflink" href="#V"><b class="Fl" title="Fl" id="V">-V</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-value-stack-size=SIZE</b></dt> + <dd class="It-tag">Size in elements of the value stack</dd> + <dt class="It-tag"><a class="selflink" href="#C"><b class="Fl" title="Fl" id="C">-C</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-call-stack-size=SIZE</b></dt> + <dd class="It-tag">Size in elements of the call stack</dd> + <dt class="It-tag"><a class="selflink" href="#t"><b class="Fl" title="Fl" id="t">-t</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-trace</b></dt> + <dd class="It-tag">Trace execution</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse test.json and run the spec tests +<div class="Pp"></div> +<div class="D1"><code class="Li">$ spectest-interp test.json</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wasm-decompile.1 b/docs/doc/wasm-decompile.1 deleted file mode 100644 index 178f694d..00000000 --- a/docs/doc/wasm-decompile.1 +++ /dev/null @@ -1,55 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wasm-decompile -.Nd translate from the binary format to readable C-like syntax -.Sh SYNOPSIS -.Nm wasm-decompile -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -translate from the binary format to readable C-like syntax. -.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 wast 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 -.El -.Sh EXAMPLES -Parse binary file test.wasm and write text file test.dcmp -.Pp -.Dl $ wasm-decompile test.wasm -o test.dcmp -.Sh SEE ALSO -.Xr wasm2wat 1 , -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 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 . diff --git a/docs/doc/wasm-interp.1 b/docs/doc/wasm-interp.1 deleted file mode 100644 index eaba8ee8..00000000 --- a/docs/doc/wasm-interp.1 +++ /dev/null @@ -1,74 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wasm-interp -.Nd decode and run a WebAssembly binary file -.Sh SYNOPSIS -.Nm wasm-interp -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -decodes and runs a WebAssembly binary file using a stack-based interpreter. -.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 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 V , Fl Fl value-stack-size=SIZE -Size in elements of the value stack -.It Fl C , Fl Fl call-stack-size=SIZE -Size in elements of the call stack -.It Fl t , Fl Fl trace -Trace execution -.It Fl Fl run-all-exports -Run all the exported functions, in order. Useful for testing -.It Fl Fl host-print -Include an importable function named "host.print" for printing to stdout -.El -.Sh EXAMPLES -Parse binary file test.wasm, and type-check it -.Pp -.Dl $ wasm-interp test.wasm -.Pp -Parse test.wasm and run all its exported functions -.Pp -.Dl $ wasm-interp test.wasm --run-all-exports -.Pp -Parse test.wasm, run the exported functions and trace the output -.Pp -.Dl $ wasm-interp test.wasm --run-all-exports --trace -.Pp -Parse test.wasm and run all its exported functions, setting the value stack size to 100 elements -.Pp -.Dl $ wasm-interp test.wasm -V 100 --run-all-exports -.Sh SEE ALSO -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 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 . diff --git a/docs/doc/wasm-interp.1.html b/docs/doc/wasm-interp.1.html new file mode 100644 index 00000000..04103178 --- /dev/null +++ b/docs/doc/wasm-interp.1.html @@ -0,0 +1,115 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wasm-interp</b> — + <span class="Nd" title="Nd">decode and run a WebAssembly binary file</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wasm-interp</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wasm-interp</b> decodes and runs a WebAssembly binary + file using a stack-based interpreter. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Threading support</dd> + <dt class="It-tag"><a class="selflink" href="#V"><b class="Fl" title="Fl" id="V">-V</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-value-stack-size=SIZE</b></dt> + <dd class="It-tag">Size in elements of the value stack</dd> + <dt class="It-tag"><a class="selflink" href="#C"><b class="Fl" title="Fl" id="C">-C</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-call-stack-size=SIZE</b></dt> + <dd class="It-tag">Size in elements of the call stack</dd> + <dt class="It-tag"><a class="selflink" href="#t"><b class="Fl" title="Fl" id="t">-t</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-trace</b></dt> + <dd class="It-tag">Trace execution</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-run-all-exports</b></dt> + <dd class="It-tag">Run all the exported functions, in order. Useful for + testing</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-host-print</b></dt> + <dd class="It-tag">Include an importable function named "host.print" + for printing to stdout</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse binary file test.wasm, and type-check it +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm-interp test.wasm</code></div> +<div class="Pp"></div> +Parse test.wasm and run all its exported functions +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm-interp test.wasm + --run-all-exports</code></div> +<div class="Pp"></div> +Parse test.wasm, run the exported functions and trace the output +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm-interp test.wasm --run-all-exports + --trace</code></div> +<div class="Pp"></div> +Parse test.wasm and run all its exported functions, setting the value stack size + to 100 elements +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm-interp test.wasm -V 100 + --run-all-exports</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wasm-objdump.1 b/docs/doc/wasm-objdump.1 deleted file mode 100644 index 1ac9c258..00000000 --- a/docs/doc/wasm-objdump.1 +++ /dev/null @@ -1,50 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wasm-objdump -.Nd print information about a wasm binary -.Sh SYNOPSIS -.Nm wasm-objdump -.Op options -.Ar -.Sh DESCRIPTION -.Nm -prints information about a wasm binary, similar to objdump. -.Pp -The options are as follows: -.Bl -tag -width Ds -.It Fl h , Fl Fl headers -Print headers -.It Fl j , Fl Fl section=SECTION -Select just one section -.It Fl s , Fl Fl full-contents -Print raw section contents -.It Fl d , Fl Fl disassemble -Disassemble function bodies -.It Fl Fl debug -Print extra debug information -.It Fl x , Fl Fl details -Show section details -.It Fl r , Fl Fl reloc -Show relocations inline with disassembly -.It Fl Fl help -Print a help message -.El -.Sh EXAMPLES -.Dl $ wasm-objdump test.wasm -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 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 . diff --git a/docs/doc/wasm-objdump.1.html b/docs/doc/wasm-objdump.1.html new file mode 100644 index 00000000..6965e1cb --- /dev/null +++ b/docs/doc/wasm-objdump.1.html @@ -0,0 +1,87 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wasm-objdump</b> — + <span class="Nd" title="Nd">print information about a wasm binary</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wasm-objdump</b></td> + <td>[<span class="Op">options</span>] <var class="Ar" title="Ar">file + ...</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wasm-objdump</b> prints information about a wasm + binary, similar to objdump. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#h"><b class="Fl" title="Fl" id="h">-h</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-headers</b></dt> + <dd class="It-tag">Print headers</dd> + <dt class="It-tag"><a class="selflink" href="#j"><b class="Fl" title="Fl" id="j">-j</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-section=SECTION</b></dt> + <dd class="It-tag">Select just one section</dd> + <dt class="It-tag"><a class="selflink" href="#s"><b class="Fl" title="Fl" id="s">-s</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-full-contents</b></dt> + <dd class="It-tag">Print raw section contents</dd> + <dt class="It-tag"><a class="selflink" href="#d"><b class="Fl" title="Fl" id="d">-d</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disassemble</b></dt> + <dd class="It-tag">Disassemble function bodies</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-debug</b></dt> + <dd class="It-tag">Print extra debug information</dd> + <dt class="It-tag"><a class="selflink" href="#x"><b class="Fl" title="Fl" id="x">-x</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-details</b></dt> + <dd class="It-tag">Show section details</dd> + <dt class="It-tag"><a class="selflink" href="#r"><b class="Fl" title="Fl" id="r">-r</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-reloc</b></dt> + <dd class="It-tag">Show relocations inline with disassembly</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +<div class="D1"><code class="Li">$ wasm-objdump test.wasm</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wasm-opcodecnt.1 b/docs/doc/wasm-opcodecnt.1 deleted file mode 100644 index ac1cd1fb..00000000 --- a/docs/doc/wasm-opcodecnt.1 +++ /dev/null @@ -1,46 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wasm-opcodecnt -.Nd count opcode usage for instructions -.Sh SYNOPSIS -.Nm wasm-opcodecnt -.Op options -.Ar -.Sh DESCRIPTION -.Nm -reads a file in the wasm binary format, and counts opcode usage for instructions. -.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 opcode counts, by default use stdout -.It Fl c , Fl Fl cutoff=N -Cutoff for reporting counts less than N -.It Fl s , Fl Fl separator=SEPARATOR -Separator text between element and count when reporting counts expected filename argument -.El -.Sh EXAMPLES -Parse binary file test.wasm and write pcode dist file test.dist -.Pp -.Dl $ wasm-opcodecnt test.wasm -o test.dist -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 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 . diff --git a/docs/doc/wasm-opcodecnt.1.html b/docs/doc/wasm-opcodecnt.1.html new file mode 100644 index 00000000..5efdf62e --- /dev/null +++ b/docs/doc/wasm-opcodecnt.1.html @@ -0,0 +1,84 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wasm-opcodecnt</b> — + <span class="Nd" title="Nd">count opcode usage for instructions</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wasm-opcodecnt</b></td> + <td>[<span class="Op">options</span>] <var class="Ar" title="Ar">file + ...</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wasm-opcodecnt</b> reads a file in the wasm binary + format, and counts opcode usage for instructions. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> + <dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-output=FILENAME</b></dt> + <dd class="It-tag">Output file for the opcode counts, by default use + stdout</dd> + <dt class="It-tag"><a class="selflink" href="#c"><b class="Fl" title="Fl" id="c">-c</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-cutoff=N</b></dt> + <dd class="It-tag">Cutoff for reporting counts less than N</dd> + <dt class="It-tag"><a class="selflink" href="#s"><b class="Fl" title="Fl" id="s">-s</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-separator=SEPARATOR</b></dt> + <dd class="It-tag">Separator text between element and count when reporting + counts expected filename argument</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse binary file test.wasm and write pcode dist file test.dist +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm-opcodecnt test.wasm -o + test.dist</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wasm-strip.1 b/docs/doc/wasm-strip.1 deleted file mode 100644 index 2c563690..00000000 --- a/docs/doc/wasm-strip.1 +++ /dev/null @@ -1,38 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wasm-strip -.Nd remove sections of a WebAssembly binary file -.Sh SYNOPSIS -.Nm wasm-strip -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -removes sections of a WebAssembly binary file. -.Pp -The options are as follows: -.Bl -tag -width Ds -.It Fl Fl help -Print a help message -.El -.Sh EXAMPLES -Remove all custom sections from test.wasm -.Pp -.Dl $ wasm-strip test.wasm -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 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 . diff --git a/docs/doc/wasm-strip.1.html b/docs/doc/wasm-strip.1.html new file mode 100644 index 00000000..5af61609 --- /dev/null +++ b/docs/doc/wasm-strip.1.html @@ -0,0 +1,70 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wasm-strip</b> — + <span class="Nd" title="Nd">remove sections of a WebAssembly binary + file</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wasm-strip</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wasm-strip</b> removes sections of a WebAssembly binary + file. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Remove all custom sections from test.wasm +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm-strip test.wasm</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wasm-validate.1 b/docs/doc/wasm-validate.1 deleted file mode 100644 index ebc7ccfb..00000000 --- a/docs/doc/wasm-validate.1 +++ /dev/null @@ -1,60 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wasm-validate -.Nd validate a file in the WebAssembly binary format -.Sh SYNOPSIS -.Nm wasm-validate -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -reads a file in the WebAssembly binary format and validates it. -.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 this help message -.It Fl Fl enable-exceptions -Enable Experimental exception handling -.It Fl Fl disable-mutable-globals -Disable Import/export mutable globals -.It Fl Fl enable-saturating-float-to-int -Enable Saturating float-to-int operators -.It Fl Fl enable-sign-extension -Enable Sign-extension operators -.It Fl Fl enable-simd -Enable SIMD support -.It Fl Fl enable-threads -Enable Threading support -.It Fl Fl enable-multi-value -Enable Multi-value -.It Fl Fl enable-tail-call -Enable Tail-call support -.It Fl Fl no-debug-names -Ignore debug names in the binary file -.It Fl Fl ignore-custom-section-errors -Ignore errors in custom sections -.El -.Sh EXAMPLES -Validate binary file test.wasm -.Pp -.Dl $ wasm-validate test.wasm -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm2c 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 . diff --git a/docs/doc/wasm-validate.1.html b/docs/doc/wasm-validate.1.html new file mode 100644 index 00000000..4c74a7f5 --- /dev/null +++ b/docs/doc/wasm-validate.1.html @@ -0,0 +1,93 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wasm-validate</b> — + <span class="Nd" title="Nd">validate a file in the WebAssembly binary + format</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wasm-validate</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wasm-validate</b> reads a file in the WebAssembly + binary format and validates it. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print this help message</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Enable Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Disable Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Enable Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Enable Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">Enable SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Enable Threading support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-multi-value</b></dt> + <dd class="It-tag">Enable Multi-value</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-tail-call</b></dt> + <dd class="It-tag">Enable Tail-call support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-debug-names</b></dt> + <dd class="It-tag">Ignore debug names in the binary file</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-ignore-custom-section-errors</b></dt> + <dd class="It-tag">Ignore errors in custom sections</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Validate binary file test.wasm +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm-validate test.wasm</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wasm2c.1 b/docs/doc/wasm2c.1 deleted file mode 100644 index 1d6c1fb3..00000000 --- a/docs/doc/wasm2c.1 +++ /dev/null @@ -1,60 +0,0 @@ -.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 . diff --git a/docs/doc/wasm2c.1.html b/docs/doc/wasm2c.1.html new file mode 100644 index 00000000..fff71a84 --- /dev/null +++ b/docs/doc/wasm2c.1.html @@ -0,0 +1,95 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wasm2c</b> — <span class="Nd" title="Nd">convert + a WebAssembly binary file to a C source and header</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wasm2c</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wasm2c</b> takes a WebAssembly module and produces an + equivalent C source and header. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> + <dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-output=FILENAME</b></dt> + <dd class="It-tag">Output file for the generated C source file, by default use + stdout</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Threading support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-debug-names</b></dt> + <dd class="It-tag">Ignore debug names in the binary file</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse binary file test.wasm and write test.c and test.h +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm2c test.wasm -o test.c</code></div> +<div class="Pp"></div> +Parse test.wasm, write test.c and test.h, but ignore the debug names, if any +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm2c test.wasm --no-debug-names -o + test.c</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wasm2wat.1 b/docs/doc/wasm2wat.1 deleted file mode 100644 index 6a6eb7a6..00000000 --- a/docs/doc/wasm2wat.1 +++ /dev/null @@ -1,70 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wasm2wat -.Nd translate from the binary format to the text format -.Sh SYNOPSIS -.Nm wasm2wat -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -does the inverse of wat2wasm, translate from the binary format back to the text format (also known as a .wat). -.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 wast file, by default use stdout -.It Fl f , Fl Fl fold-exprs -Write folded expressions where possible -.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 inline-exports -Write all exports inline -.It Fl Fl inline-imports -Write all imports inline -.It Fl Fl no-debug-names -Ignore debug names in the binary file -.It Fl Fl generate-names -Give auto-generated names to non-named functions, types, etc. -.It Fl Fl no-check -Don't check for invalid modules -.El -.Sh EXAMPLES -Parse binary file test.wasm and write text file test.wast -.Pp -.Dl $ wasm2wat test.wasm -o test.wat -.Pp -Parse test.wasm, write test.wat, but ignore the debug names, if any -.Pp -.Dl $ wasm2wat test.wasm --no-debug-names -o test.wat -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 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 . diff --git a/docs/doc/wasm2wat.1.html b/docs/doc/wasm2wat.1.html new file mode 100644 index 00000000..07bd3ed3 --- /dev/null +++ b/docs/doc/wasm2wat.1.html @@ -0,0 +1,108 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wasm2wat</b> — + <span class="Nd" title="Nd">translate from the binary format to the text + format</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wasm2wat</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wasm2wat</b> does the inverse of wat2wasm, translate + from the binary format back to the text format (also known as a .wat). +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> + <dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-output=FILENAME</b></dt> + <dd class="It-tag">Output file for the generated wast file, by default use + stdout</dd> + <dt class="It-tag"><a class="selflink" href="#f"><b class="Fl" title="Fl" id="f">-f</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-fold-exprs</b></dt> + <dd class="It-tag">Write folded expressions where possible</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Threading support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-inline-exports</b></dt> + <dd class="It-tag">Write all exports inline</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-inline-imports</b></dt> + <dd class="It-tag">Write all imports inline</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-debug-names</b></dt> + <dd class="It-tag">Ignore debug names in the binary file</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-generate-names</b></dt> + <dd class="It-tag">Give auto-generated names to non-named functions, types, + etc.</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-check</b></dt> + <dd class="It-tag">Don't check for invalid modules</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse binary file test.wasm and write text file test.wast +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm2wat test.wasm -o test.wat</code></div> +<div class="Pp"></div> +Parse test.wasm, write test.wat, but ignore the debug names, if any +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wasm2wat test.wasm --no-debug-names -o + test.wat</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wast2json.1 b/docs/doc/wast2json.1 deleted file mode 100644 index 32f8acc8..00000000 --- a/docs/doc/wast2json.1 +++ /dev/null @@ -1,69 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wast2json -.Nd convert a file in the wasm spec test format to a JSON file and associated wasm binary files -.Sh SYNOPSIS -.Nm wast2json -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -reads a file in the wasm spec test format, checks it for errors, and converts it to a JSON file and associated wasm binary files. -.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 this help message -.It Fl Fl debug-parser -Turn on debugging the parser of wast files -.It Fl Fl enable-exceptions -Enable Experimental exception handling -.It Fl Fl disable-mutable-globals -Disable Import/export mutable globals -.It Fl Fl enable-saturating-float-to-int -Enable Saturating float-to-int operators -.It Fl Fl enable-sign-extension -Enable Sign-extension operators -.It Fl Fl enable-simd -Enable SIMD support -.It Fl Fl enable-threads -Enable Threading support -.It Fl Fl enable-multi-value -Enable Multi-value -.It Fl Fl enable-tail-call -Enable Tail-call support -.It Fl o , Fl Fl output=FILE -output wasm binary file -.It Fl r , Fl Fl relocatable -Create a relocatable wasm binary (suitable for linking with e.g. lld) -.It Fl Fl no-canonicalize-leb128s -Write all LEB128 sizes as 5-bytes instead of their minimal size -.It Fl Fl debug-names -Write debug names to the generated binary file -.It Fl Fl no-check -Don't check for invalid modules -.El -.Sh EXAMPLES -Parse spec-test.wast, and write files to spec-test.json. -Modules are written to spec-test.0.wasm, spec-test.1.wasm, etc. -.Pp -.Dl $ wast2json spec-test.wast -o spec-test.json -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 1 , -.Xr wasm2wat 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 . diff --git a/docs/doc/wast2json.1.html b/docs/doc/wast2json.1.html new file mode 100644 index 00000000..29b9cf77 --- /dev/null +++ b/docs/doc/wast2json.1.html @@ -0,0 +1,108 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wast2json</b> — + <span class="Nd" title="Nd">convert a file in the wasm spec test format to a + JSON file and associated wasm binary files</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wast2json</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wast2json</b> reads a file in the wasm spec test + format, checks it for errors, and converts it to a JSON file and associated + wasm binary files. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print this help message</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-debug-parser</b></dt> + <dd class="It-tag">Turn on debugging the parser of wast files</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Enable Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Disable Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Enable Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Enable Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">Enable SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Enable Threading support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-multi-value</b></dt> + <dd class="It-tag">Enable Multi-value</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-tail-call</b></dt> + <dd class="It-tag">Enable Tail-call support</dd> + <dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-output=FILE</b></dt> + <dd class="It-tag">output wasm binary file</dd> + <dt class="It-tag"><a class="selflink" href="#r"><b class="Fl" title="Fl" id="r">-r</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-relocatable</b></dt> + <dd class="It-tag">Create a relocatable wasm binary (suitable for linking with + e.g. lld)</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-canonicalize-leb128s</b></dt> + <dd class="It-tag">Write all LEB128 sizes as 5-bytes instead of their minimal + size</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-debug-names</b></dt> + <dd class="It-tag">Write debug names to the generated binary file</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-check</b></dt> + <dd class="It-tag">Don't check for invalid modules</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse spec-test.wast, and write files to spec-test.json. Modules are written to + spec-test.0.wasm, spec-test.1.wasm, etc. +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wast2json spec-test.wast -o + spec-test.json</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1.html">wat2wasm(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wat-desugar.1 b/docs/doc/wat-desugar.1 deleted file mode 100644 index 4e826bee..00000000 --- a/docs/doc/wat-desugar.1 +++ /dev/null @@ -1,70 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wat-desugar -.Nd parse .wat text form and print "canonical" flat format -.Sh SYNOPSIS -.Nm wat-desugar -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -parses .wat text form as supported by the spec interpreter (s-expressions, flat syntax, or mixed) and prints "canonical" flat format. -.Pp -The options are as follows: -.Bl -tag -width Ds -.It Fl Fl help -Print a help message -.It Fl o , Fl Fl output=FILE -Output file for the formatted file -.It Fl Fl debug-parser -Turn on debugging the parser of wat files -.It Fl f , Fl Fl fold-exprs -Write folded expressions where possible -.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 inline-exports -Write all exports inline -.It Fl Fl inline-imports -Write all imports inline -.It Fl Fl generate-names -Give auto-generated names to non-named functions, types, etc. -.El -.Sh EXAMPLES -Write output to stdout -.Pp -.Dl $ wat-desugar test.wat -.Pp -Write output to test2.wat -.Pp -.Dl $ wat-desugar test.wat -o test2.wat -.Pp -Generate names for indexed variables -.Pp -.Dl $ wat-desugar --generate-names test.wat -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 1 , -.Xr wasm2wat 1 , -.Xr wast2json 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 . diff --git a/docs/doc/wat-desugar.1.html b/docs/doc/wat-desugar.1.html new file mode 100644 index 00000000..5ea79065 --- /dev/null +++ b/docs/doc/wat-desugar.1.html @@ -0,0 +1,108 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wat-desugar</b> — + <span class="Nd" title="Nd">parse .wat text form and print canonical flat + format</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wat-desugar</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wat-desugar</b> parses .wat text form as supported by + the spec interpreter (s-expressions, flat syntax, or mixed) and prints + "canonical" flat format. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> + <dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-output=FILE</b></dt> + <dd class="It-tag">Output file for the formatted file</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-debug-parser</b></dt> + <dd class="It-tag">Turn on debugging the parser of wat files</dd> + <dt class="It-tag"><a class="selflink" href="#f"><b class="Fl" title="Fl" id="f">-f</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-fold-exprs</b></dt> + <dd class="It-tag">Write folded expressions where possible</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Threading support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-inline-exports</b></dt> + <dd class="It-tag">Write all exports inline</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-inline-imports</b></dt> + <dd class="It-tag">Write all imports inline</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-generate-names</b></dt> + <dd class="It-tag">Give auto-generated names to non-named functions, types, + etc.</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Write output to stdout +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wat-desugar test.wat</code></div> +<div class="Pp"></div> +Write output to test2.wat +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wat-desugar test.wat -o + test2.wat</code></div> +<div class="Pp"></div> +Generate names for indexed variables +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wat-desugar --generate-names + test.wat</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat2wasm.1,.html">wat2wasm(1,)</a> + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/docs/doc/wat2wasm.1 b/docs/doc/wat2wasm.1 deleted file mode 100644 index 3987a465..00000000 --- a/docs/doc/wat2wasm.1 +++ /dev/null @@ -1,74 +0,0 @@ -.Dd $Mdocdate$ -.Dt WABT 1 -.Os -.Sh NAME -.Nm wat2wasm -.Nd translate from WebAssembly text format to the WebAssembly binary format -.Sh SYNOPSIS -.Nm wat2wasm -.Op options -.Ar file -.Sh DESCRIPTION -.Nm -translates from WebAssembly text format to the WebAssembly binary format. -.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 Fl debug-parser -Turn on debugging the parser of wat files -.It Fl d , Fl Fl dump-module -Print a hexdump of the module to 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 o , Fl Fl output=FILE -output wasm binary file -.It Fl r , Fl Fl relocatable -Create a relocatable wasm binary (suitable for linking with e.g. lld) -.It Fl Fl no-canonicalize-leb128s -Write all LEB128 sizes as 5-bytes instead of their minimal size -.It Fl Fl debug-names -Write debug names to the generated binary file -.It Fl Fl no-check -Don't check for invalid modules -.El -.Sh EXAMPLES -Parse and typecheck test.wat -.Pp -.Dl $ wat2wasm test.wat -.Pp -parse test.wat and write to binary file test.wasm -.Pp -.Dl $ wat2wasm test.wat -o test.wasm -.Pp -Parse spec-test.wast, and write verbose output to stdout (including the meaning of every byte) -.Pp -.Dl $ wat2wasm spec-test.wast -v -.Sh SEE ALSO -.Xr wasm-interp 1 , -.Xr wasm-objdump 1 , -.Xr wasm-opcodecnt 1 , -.Xr wasm-strip 1 , -.Xr wasm-validate 1 , -.Xr wasm2c 1 , -.Xr wasm2wat 1 , -.Xr wast2json 1 , -.Xr wat-desugar 1 , -.Xr spectest-interp 1 -.Sh BUGS -If you find a bug, please report it at -.br -.Lk https://github.com/WebAssembly/wabt/issues . diff --git a/docs/doc/wat2wasm.1.html b/docs/doc/wat2wasm.1.html new file mode 100644 index 00000000..32d5de6c --- /dev/null +++ b/docs/doc/wat2wasm.1.html @@ -0,0 +1,113 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <style> + table.head, table.foot { width: 100%; } + td.head-rtitle, td.foot-os { text-align: right; } + td.head-vol { text-align: center; } + div.Pp { margin: 1ex 0ex; } + </style> + <title>WABT(1)</title> +</head> +<body> +<table class="head"> + <tr> + <td class="head-ltitle">WABT(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">WABT(1)</td> + </tr> +</table> +<div class="manual-text"> +<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> +<b class="Nm" title="Nm">wat2wasm</b> — + <span class="Nd" title="Nd">translate from WebAssembly text format to the + WebAssembly binary format</span> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><b class="Nm" title="Nm">wat2wasm</b></td> + <td>[<span class="Op">options</span>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<b class="Nm" title="Nm">wat2wasm</b> translates from WebAssembly text format to + the WebAssembly binary format. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-verbose</b></dt> + <dd class="It-tag">Use multiple times for more info</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-help</b></dt> + <dd class="It-tag">Print a help message</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-debug-parser</b></dt> + <dd class="It-tag">Turn on debugging the parser of wat files</dd> + <dt class="It-tag"><a class="selflink" href="#d"><b class="Fl" title="Fl" id="d">-d</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-dump-module</b></dt> + <dd class="It-tag">Print a hexdump of the module to stdout</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-exceptions</b></dt> + <dd class="It-tag">Experimental exception handling</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-disable-mutable-globals</b></dt> + <dd class="It-tag">Import/export mutable globals</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-saturating-float-to-int</b></dt> + <dd class="It-tag">Saturating float-to-int operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-sign-extension</b></dt> + <dd class="It-tag">Sign-extension operators</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-simd</b></dt> + <dd class="It-tag">SIMD support</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-enable-threads</b></dt> + <dd class="It-tag">Threading support</dd> + <dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-output=FILE</b></dt> + <dd class="It-tag">output wasm binary file</dd> + <dt class="It-tag"><a class="selflink" href="#r"><b class="Fl" title="Fl" id="r">-r</b></a>, + <b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-relocatable</b></dt> + <dd class="It-tag">Create a relocatable wasm binary (suitable for linking with + e.g. lld)</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-canonicalize-leb128s</b></dt> + <dd class="It-tag">Write all LEB128 sizes as 5-bytes instead of their minimal + size</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-debug-names</b></dt> + <dd class="It-tag">Write debug names to the generated binary file</dd> + <dt class="It-tag"><b class="Fl" title="Fl">-</b><b class="Fl" title="Fl">-no-check</b></dt> + <dd class="It-tag">Don't check for invalid modules</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse and typecheck test.wat +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wat2wasm test.wat</code></div> +<div class="Pp"></div> +parse test.wat and write to binary file test.wasm +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wat2wasm test.wat -o test.wasm</code></div> +<div class="Pp"></div> +Parse spec-test.wast, and write verbose output to stdout (including the meaning + of every byte) +<div class="Pp"></div> +<div class="D1"><code class="Li">$ wat2wasm spec-test.wast -v</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm-interp.1.html">wasm-interp(1)</a>, + <a class="Xr" title="Xr" href="wasm-objdump.1.html">wasm-objdump(1)</a>, + <a class="Xr" title="Xr" href="wasm-opcodecnt.1.html">wasm-opcodecnt(1)</a>, + <a class="Xr" title="Xr" href="wasm-strip.1.html">wasm-strip(1)</a>, + <a class="Xr" title="Xr" href="wasm-validate.1.html">wasm-validate(1)</a>, + <a class="Xr" title="Xr" href="wasm2c.1.html">wasm2c(1)</a>, + <a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <a class="Xr" title="Xr" href="wast2json.1.html">wast2json(1)</a>, + <a class="Xr" title="Xr" href="wat-desugar.1.html">wat-desugar(1)</a>, + <a class="Xr" title="Xr" href="spectest-interp.1.html">spectest-interp(1)</a> +<h1 class="Sh" title="Sh" id="BUGS"><a class="selflink" href="#BUGS">BUGS</a></h1> +If you find a bug, please report it at +<div> </div> +<a class="Lk" title="Lk" href="https://github.com/WebAssembly/wabt/issues">https://github.com/WebAssembly/wabt/issues</a>.</div> +<table class="foot"> + <tr> + <td class="foot-date">December 17, 2018</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> |