diff options
| -rw-r--r-- | docs/doc/wasm-decompile.1.html | 96 | ||||
| -rwxr-xr-x | scripts/generate-html-docs.sh | 36 |
2 files changed, 132 insertions, 0 deletions
diff --git a/docs/doc/wasm-decompile.1.html b/docs/doc/wasm-decompile.1.html new file mode 100644 index 00000000..88ea9b93 --- /dev/null +++ b/docs/doc/wasm-decompile.1.html @@ -0,0 +1,96 @@ +<!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; } + div.Nd, div.Bf, div.Op { display: inline; } + span.Pa, span.Ad { font-style: italic; } + span.Ms { font-weight: bold; } + dl.Bl-diag > dt { font-weight: bold; } + code.Nm, code.Fl, code.Cm, code.Ic, code.In, code.Fd, code.Fn, + code.Cd { font-weight: bold; font-family: inherit; } + </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="permalink" href="#NAME">NAME</a></h1> +<code class="Nm" title="Nm">wasm-decompile</code> — +<div class="Nd" title="Nd">translate from the binary format to readable C-like + syntax</div> +<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><code class="Nm" title="Nm">wasm-decompile</code></td> + <td>[<div class="Op">options</div>] + <var class="Ar" title="Ar">file</var></td> + </tr> +</table> +<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<code class="Nm" title="Nm">wasm-decompile</code> translate from the binary + format to readable C-like syntax. +<div class="Pp"></div> +The options are as follows: +<dl class="Bl-tag"> + <dt><a class="permalink" href="#v"><code class="Fl" title="Fl" id="v">-v</code></a>, + <code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-verbose</code></dt> + <dd>Use multiple times for more info</dd> + <dt><code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-help</code></dt> + <dd>Print a help message</dd> + <dt><a class="permalink" href="#o"><code class="Fl" title="Fl" id="o">-o</code></a>, + <code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-output=FILENAME</code></dt> + <dd>Output file for the generated wast file, by default use stdout</dd> + <dt><code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-enable-exceptions</code></dt> + <dd>Experimental exception handling</dd> + <dt><code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-disable-mutable-globals</code></dt> + <dd>Import/export mutable globals</dd> + <dt><code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-enable-saturating-float-to-int</code></dt> + <dd>Saturating float-to-int operators</dd> + <dt><code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-enable-sign-extension</code></dt> + <dd>Sign-extension operators</dd> + <dt><code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-enable-simd</code></dt> + <dd>SIMD support</dd> + <dt><code class="Fl" title="Fl">-</code><code class="Fl" title="Fl">-enable-threads</code></dt> + <dd>Threading support</dd> +</dl> +<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +Parse binary file test.wasm and write text file test.dcmp +<div class="Pp"></div> +<div class="Bd Bd-indent"><code class="Li">$ wasm-decompile test.wasm -o + test.dcmp</code></div> +<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<a class="Xr" title="Xr" href="wasm2wat.1.html">wasm2wat(1)</a>, + <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="permalink" 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, 2020</td> + <td class="foot-os">Debian</td> + </tr> +</table> +</body> +</html> diff --git a/scripts/generate-html-docs.sh b/scripts/generate-html-docs.sh new file mode 100755 index 00000000..cf70dacb --- /dev/null +++ b/scripts/generate-html-docs.sh @@ -0,0 +1,36 @@ +#!/bin/bash +# +# Copyright 2020 WebAssembly Community Group participants +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +set -o nounset +set -o errexit + +SCRIPT_DIR="$(dirname "$(readlink -f "$0")")" +ROOT_DIR="$(dirname "${SCRIPT_DIR}")" +MAN_DIR="$ROOT_DIR/man" +DOC_DIR="$ROOT_DIR/docs/doc" + +if ! which mandoc > /dev/null; then + echo 'mandoc not found' + exit +fi + +set -x +for file in "$MAN_DIR"/*.1; do + mandoc -T html -O man='%N.%S.html' "$file" > "$DOC_DIR/$(basename "$file").html" +done +set +x + |