diff options
author | John Ankarström <john@ankarstrom.se> | 2020-12-02 00:12:18 +0100 |
---|---|---|
committer | John Ankarström <john@ankarstrom.se> | 2020-12-02 00:12:18 +0100 |
commit | 104f2006ea454c2f6d4e0fccbba7c1467da1d7d9 (patch) | |
tree | 8310d8ee1c3f70ffd78c0dd6646ea81cdc04f4ac | |
parent | b44b23f79590d2bd9874985a253f247f33d03b20 (diff) | |
download | mht-104f2006ea454c2f6d4e0fccbba7c1467da1d7d9.tar.gz |
Add documentation
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | index.html | 151 |
2 files changed, 153 insertions, 0 deletions
diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ab73cf5 --- /dev/null +++ b/Makefile @@ -0,0 +1,2 @@ +index.html: + mandoc -T html -O fragment ../master/mht.1 > index.html diff --git a/index.html b/index.html new file mode 100644 index 0000000..991444e --- /dev/null +++ b/index.html @@ -0,0 +1,151 @@ +<table class="head"> + <tr> + <td class="head-ltitle">mht(1)</td> + <td class="head-vol">General Commands Manual</td> + <td class="head-rtitle">mht(1)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<code class="Nm">mht</code> — +<div class="Nd">troff for HTML</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<table class="Nm"> + <tr> + <td><code class="Nm">mht</code></td> + <td>[<var class="Ar">file</var>]</td> + </tr> +</table> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCIPTION"><a class="permalink" href="#DESCIPTION">DESCIPTION</a></h1> +<code class="Nm">mht</code> is a utility that generates HTML from + <a class="Xr">troff(1)</a> source code. +<p class="Pp">While <code class="Nm">mht</code> is named like a troff macro + package and uses troff syntax, it is a standalone utility that does not use + troff itself. As such, it supports only a subset of the standard troff + requests.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="USAGE"><a class="permalink" href="#USAGE">USAGE</a></h1> +This section describes the various types of requests supported by + <code class="Nm">mht</code>. On the left side are the name and arity of each + request, separated by a slash. On the right side is the HTML expansion of each + request. +<p class="Pp">In the HTML expansion of all element requests, a backslash and a + dollar sign followed by a number (e.g. \$1) signify a parameter + expansion.</p> +<p class="Pp">In block element requests, a percent sign (%) signifies the lines + following the request until the next block element request.</p> +<p class="Pp">Finally, in contiguous element requests, whatever text is on the + outside of the area delimited by braces ({...}) is removed when two of the + same contiguous element requests are placed next to one another.</p> +<section class="Ss"> +<h2 class="Ss" id="Standard_troff_requests"><a class="permalink" href="#Standard_troff_requests">Standard + troff requests</a></h2> +<dl class="Bl-tag"> + <dt><b class="Sy">br/0</b></dt> + <dd><br></dd> +</dl> +</section> +<section class="Ss"> +<h2 class="Ss" id="Contiguous_element_requests"><a class="permalink" href="#Contiguous_element_requests">Contiguous + element requests</a></h2> +<dl class="Bl-tag"> + <dt><b class="Sy">Qp/0</b></dt> + <dd><blockquote>{<p>%</p>}</blockquote></dd> +</dl> +</section> +<section class="Ss"> +<h2 class="Ss" id="Block_element_requests"><a class="permalink" href="#Block_element_requests">Block + element requests</a></h2> +<dl class="Bl-tag"> + <dt><b class="Sy">Pp/0</b></dt> + <dd><p>%</p></dd> + <dt><b class="Sy">Pr/0</b></dt> + <dd><pre>%</pre></dd> + <dt><b class="Sy">Sh/0</b></dt> + <dd><h3>%</h3></dd> + <dt><b class="Sy">Sh/1</b></dt> + <dd><h\$1>%</h\$1></dd> + <dt><b class="Sy">Ti/0</b></dt> + <dd><title>%</title></dd> +</dl> +</section> +<section class="Ss"> +<h2 class="Ss" id="Inline_element_requests"><a class="permalink" href="#Inline_element_requests">Inline + element requests</a></h2> +<dl class="Bl-tag"> + <dt><b class="Sy">Au/1</b></dt> + <dd><meta name="author" content="\$1"/></dd> + <dt><b class="Sy">Bd/1</b></dt> + <dd><b>\$1</b></dd> + <dt><b class="Sy">Bd/2</b></dt> + <dd><b>\$1</b>\$2</dd> + <dt><b class="Sy">Bd/3</b></dt> + <dd>\$3<b>\$1</b>\$2</dd> + <dt><b class="Sy">br/0</b></dt> + <dd><br/></dd> + <dt><b class="Sy">Cd/1</b></dt> + <dd><code>\$1</code></dd> + <dt><b class="Sy">Cd/2</b></dt> + <dd><code>\$1</code>\$2</dd> + <dt><b class="Sy">Cd/3</b></dt> + <dd>\$3<code>\$1</code>\$2</dd> + <dt><b class="Sy">Cs/1</b></dt> + <dd><meta http-equiv="Content-Type" content="text/html; + charset=\$1"/></dd> + <dt><b class="Sy">Em/1</b></dt> + <dd><em>\$1</em></dd> + <dt><b class="Sy">Em/2</b></dt> + <dd><em>\$1</em>\$2</dd> + <dt><b class="Sy">Em/3</b></dt> + <dd>\$3<em>\$1</em>\$2</dd> + <dt><b class="Sy">Hy/2</b></dt> + <dd><a href="\$2">\$1</a></dd> + <dt><b class="Sy">Im/2</b></dt> + <dd><img src="\$1" alt="\$2"/></dd> + <dt><b class="Sy">It/1</b></dt> + <dd><i>\$1</i></dd> + <dt><b class="Sy">It/2</b></dt> + <dd><i>\$1</i>\$2</dd> + <dt><b class="Sy">It/3</b></dt> + <dd>\$3<i>\$1</i>\$2</dd> + <dt><b class="Sy">St/1</b></dt> + <dd><strong>\$1</strong></dd> + <dt><b class="Sy">St/2</b></dt> + <dd><strong>\$1</strong>\$2</dd> + <dt><b class="Sy">St/3</b></dt> + <dd>\$3<strong>\$1</strong>\$2</dd> + <dt><b class="Sy">Tt/1</b></dt> + <dd><tt>\$1</tt></dd> + <dt><b class="Sy">Tt/2</b></dt> + <dd><tt>\$1</tt>\$2</dd> + <dt><b class="Sy">Tt/3</b></dt> + <dd>\$3<tt>\$1</tt>\$2</dd> + <dt><b class="Sy">Ul/1</b></dt> + <dd><u>\$1</u></dd> + <dt><b class="Sy">Ul/2</b></dt> + <dd><u>\$1</u>\$2</dd> + <dt><b class="Sy">Ul/3</b></dt> + <dd>\$3<u>\$1</u>\$2</dd> +</dl> +</section> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<code class="Nm">mht</code> is written by John Ankarström + <<a class="Mt" href="mailto:john">john</a> + <a class="Mt" href="mailto:(at)">(at)</a> + <a class="Mt" href="mailto:ankarstrom.se">ankarstrom.se</a>>. +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">December 2, 2020</td> + <td class="foot-os">Linux 5.4.72-0-lts</td> + </tr> +</table> |