<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>crates/mdman/doc/mdman.md - fork/cargo @ master</title>
<meta name="description" content="crates/mdman/doc/mdman.md in fork/cargo at master.">
<meta property="og:title" content="crates/mdman/doc/mdman.md - fork/cargo @ master">
<meta property="og:description" content="crates/mdman/doc/mdman.md in fork/cargo at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="623444427f04292f3a3c7eac560cfa65ba0bb88e">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/cargo</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/cargo</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="ba45764a2c0101a7bac8168f8ea8ba408e9ac6e9">Auto merge of #12067 - cuishuang:master, r=weihanglo</span><span class="snapshot-sha sha" data-commit="ba45764a2c0101a7bac8168f8ea8ba408e9ac6e9">ba45764a2</span><time datetime="2023-05-02T11:08:35+00:00" title="2023-05-02 11:08:35 +0000">2023-05-02</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/cargo/ref/master/">master</a><strong>tags</strong><a href="/fork/cargo/ref/0.87.0/">0.87.0</a><a href="/fork/cargo/ref/0.88.0/">0.88.0</a><a href="/fork/cargo/ref/0.89.0/">0.89.0</a><a href="/fork/cargo/ref/0.90.0/">0.90.0</a><a href="/fork/cargo/ref/0.91.0/">0.91.0</a><a href="/fork/cargo/ref/0.92.0/">0.92.0</a><a href="/fork/cargo/ref/0.93.0/">0.93.0</a><a href="/fork/cargo/ref/home-0.5.12/">home-0.5.12</a><a class="all" href="/fork/cargo/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/cargo/">cargo</a> / <a href="/fork/cargo/ref/master/tree/crates/">crates</a> / <a href="/fork/cargo/ref/master/tree/crates/mdman/">mdman</a> / <a href="/fork/cargo/ref/master/tree/crates/mdman/doc/">doc</a> / <span class="cur">mdman.md</span></nav>
<span class="view-stats"><span>3.3 KiB</span><span>95 lines</span></span><span class="actions"><a class="raw" href="/fork/cargo/raw/bfa394648caf7c3e84102e02024fdf6564e6d4ce/crates/mdman/doc/mdman.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>mdman(1)</h1>
<h2>NAME</h2>
<p>mdman - Converts markdown to a man page</p>
<h2>SYNOPSIS</h2>
<p><code>mdman</code> [<em>options</em>] <code>-t</code> <em>type</em> <code>-o</code> <em>outdir</em> <em>sources...</em></p>
<h2>DESCRIPTION</h2>
<p>Converts a markdown file to a man page.</p>
<p>The source file is first processed as a
<a href="https://handlebarsjs.com/">handlebars</a> template. Then, it is processed as
markdown into the target format. This supports different output formats,
such as troff or plain text.</p>
<p>Every man page should start with a level-1 header with the man name and
section, such as <code># mdman(1)</code>.</p>
<p>The handlebars template has several special tags to assist with generating the
man page:</p>
<p>{{{{raw}}}}</p>
<ul>
<li>
<p>Every block of command-line options must be wrapped between <code>{{#options}}</code>
and <code>{{/options}}</code> tags. This tells the processor where the options start
and end.</p>
</li>
<li>
<p>Each option must be expressed with a <code>{{#option}}</code> block. The parameters to
the block are a sequence of strings indicating the option. For example,
<code>{{#option "`-p` _spec_..." "`--package` _spec_..."}}</code> is an option that
has two different forms. The text within the string is processed as markdown.
It is recommended to use formatting similar to this example.</p>
<p>The content of the <code>{{#option}}</code> block should contain a detailed description
of the option.</p>
<p>Use the <code>{{/option}}</code> tag to end the option block.</p>
</li>
<li>
<p>References to other man pages should use the <code>{{man name section}}</code>
expression. For example, <code>{{man "mdman" 1}}</code> will generate a reference to
the <code>mdman(1)</code> man page. For non-troff output, the <code>--man</code> option will tell
<code>mdman</code> how to create links to the man page. If there is no matching <code>--man</code>
option, then it links to a file named <em>name</em><code>.md</code> in the same directory.</p>
</li>
<li>
<p>Variables can be set with <code>{{*set name="value"}}</code>. These variables can
then be referenced with <code>{{name}}</code> expressions.</p>
</li>
<li>
<p>Partial templates should be placed in a directory named <code>includes</code>
next to the source file. Templates can be included with an expression like
<code>{{&gt; template-name}}</code>.</p>
</li>
<li>
<p>Other helpers include:</p>
<ul>
<li><code>{{lower value}}</code> Converts the given value to lowercase.
{{{{/raw}}}}</li>
</ul>
</li>
</ul>
<h2>OPTIONS</h2>
<p>{{#options}}</p>
<p>{{#option "<code>-t</code> <em>type</em>"}}
Specifies the output type. The following output types are supported:</p>
<ul>
<li><code>man</code> — A troff-style man page. Outputs with a numbered extension (like
<code>.1</code>) matching the man page section.</li>
<li><code>md</code> — A markdown file, after all handlebars processing has been finished.
Outputs with the <code>.md</code> extension.</li>
<li><code>txt</code> — A text file, rendered for situations where a man page viewer isn't
available. Outputs with the <code>.txt</code> extension.
{{/option}}</li>
</ul>
<p>{{#option "<code>-o</code> <em>outdir</em>"}}
Specifies the directory where to save the output.
{{/option}}</p>
<p>{{#option "<code>--url</code> <em>base_url</em>"}}
Specifies a base URL to use for relative URLs within the document. Any
relative URL will be joined with this URL.
{{/option}}</p>
<p>{{#option "<code>--man</code> <em>name</em><code>:</code><em>section</em><code>=</code><em>url</em>"}}
Specifies a URL to use for the given man page. When the <code>\{{man name section}}</code> expression is used, the given URL will be inserted as a link. This
may be specified multiple times. If a man page reference does not have a
matching <code>--man</code> entry, then a relative link to a file named <em>name</em><code>.md</code> will
be used.
{{/option}}</p>
<p>{{#option "<em>sources...</em>"}}
The source input filename, may be specified multiple times.
{{/option}}</p>
<p>{{/options}}</p>
<h2>EXAMPLES</h2>
<ol>
<li>
<p>Convert the given documents to man pages:</p>
<pre><code>mdman -t man -o doc doc/mdman.md
</code></pre>
</li>
</ol>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>mdman(1)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>##</a-p> <a-tt>NAME</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">mdman - Converts markdown to a man page</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>##</a-p> <a-tt>SYNOPSIS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">`mdman` [_options_] `-t` _type_ `-o` _outdir_ _sources..._</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>##</a-p> <a-tt>DESCRIPTION</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">Converts a markdown file to a man page.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">The source file is first processed as a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">[handlebars](https://handlebarsjs.com/) template. Then, it is processed as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">markdown into the target format. This supports different output formats,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">such as troff or plain text.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">Every man page should start with a level-1 header with the man name and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">section, such as `# mdman(1)`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">The handlebars template has several special tags to assist with generating the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">man page:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">{{{{raw}}}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>- </a-p>Every block of command-line options must be wrapped between `{{#options}}`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>  </a-p>and `{{/options}}` tags. This tells the processor where the options start</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>  </a-p>and end.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>- </a-p>Each option must be expressed with a `{{#option}}` block. The parameters to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>  </a-p>the block are a sequence of strings indicating the option. For example,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>  </a-p>```{{#option &quot;`-p` _spec_...&quot; &quot;`--package` _spec_...&quot;}}``` is an option that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>  </a-p>has two different forms. The text within the string is processed as markdown.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>  </a-p>It is recommended to use formatting similar to this example.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>  The content of the `{{#option}}` block should contain a detailed description</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>  of the option.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>  Use the `{{/option}}` tag to end the option block.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>- References to other man pages should use the `{{man name section}}`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>  expression. For example, `{{man &quot;mdman&quot; 1}}` will generate a reference to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>  the `mdman(1)` man page. For non-troff output, the `--man` option will tell</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>  `mdman` how to create links to the man page. If there is no matching `--man`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>  option, then it links to a file named _name_`.md` in the same directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>- Variables can be set with `{{*set name=&quot;value&quot;}}`. These variables can</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>  then be referenced with `{{name}}` expressions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>- Partial templates should be placed in a directory named `includes`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>  next to the source file. Templates can be included with an expression like</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>  `{{&gt; template-name}}`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>- Other helpers include:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>    - `{{lower value}}` Converts the given value to lowercase.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>{{{{/raw}}}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>## </a-p><a-tt>OPTIONS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>{{#options}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>{{#option &quot;`-t` _type_&quot;}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>Specifies the output type. The following output types are supported:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>- `man` — A troff-style man page. Outputs with a numbered extension (like</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>  `.1`) matching the man page section.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>- `md` — A markdown file, after all handlebars processing has been finished.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>  Outputs with the `.md` extension.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>- `txt` — A text file, rendered for situations where a man page viewer isn&#39;t</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>  available. Outputs with the `.txt` extension.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>{{/option}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>{{#option &quot;`-o` _outdir_&quot;}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>Specifies the directory where to save the output.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>{{/option}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>{{#option &quot;`--url` _base_url_&quot;}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>Specifies a base URL to use for relative URLs within the document. Any</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>relative URL will be joined with this URL.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>{{/option}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>{{#option &quot;`--man` _name_`:`_section_`=`_url_&quot;}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>Specifies a URL to use for the given man page. When the `\{{man name</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>section}}` expression is used, the given URL will be inserted as a link. This</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>may be specified multiple times. If a man page reference does not have a</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>matching `--man` entry, then a relative link to a file named _name_`.md` will</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>be used.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>{{/option}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>{{#option &quot;_sources..._&quot;}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>The source input filename, may be specified multiple times.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>{{/option}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>{{/options}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>## </a-p><a-tt>EXAMPLES</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>1. Convert the given documents to man pages:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>   </a-p>    mdman -t man -o doc doc/mdman.md</span></span></pre></div></div>
</main>
</body>
</html>
