mdoc-0.2.0.0: examples/mdoc-dump.1.html

<!DOCTYPE html>
<html>
<!-- This is an automatically generated file.  Do not edit.
   vim: ft=nroff.mustache
 -->
<head>
  <meta charset="utf-8"/>
  <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
  <link rel="stylesheet" href="./style.css" type="text/css" media="all"/>
  <title>MDOC-DUMP(1)</title>
</head>
<body>
<table class="head">
  <tr>
    <td class="head-ltitle">MDOC-DUMP(1)</td>
    <td class="head-vol">General Commands Manual</td>
    <td class="head-rtitle">MDOC-DUMP(1)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">mdoc-dump</code> &#x2014; <span class="Nd">parse
    and dump an mdoc file</span></p>
</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">mdoc-dump</code></td>
    <td>[<code class="Fl">-cv</code>]
      [<code class="Fl">--color=</code><var class="Ar">auto|always|never</var>]
      [<code class="Fl">--update-mdocdate</code>]
      [<var class="Ar">FILE&#x00A0;...</var>]</td>
  </tr>
</table>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The options are as follows:</p>
<dl class="Bl-tag">
  <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a>,
    <code class="Fl">--check</code></dt>
  <dd>Check that re-rendering parsed as mdoc matches input</dd>
  <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a>,
    <code class="Fl">--debug</code></dt>
  <dd>Log more verbosely</dd>
  <dt id="color="><a class="permalink" href="#color="><code class="Fl">--color=</code></a><var class="Ar">auto|always|never</var></dt>
  <dd>When to colorize the output</dd>
  <dt id="update"><a class="permalink" href="#update"><code class="Fl">--update-mdocdate</code></a></dt>
  <dd>Update any $Mdocdate$ macros in the output</dd>
  <dt><var class="Ar">FILE</var></dt>
  <dd>Read from the given file (if specified multiple times, output is
      concatenated; if none are specified, stdin is read)</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h1>
<p class="Pp">The following environment variables affect the execution of
    <code class="Nm">mdoc-dump</code>:</p>
<dl class="Bl-tag">
  <dt id="MDOC_DUMP_COLOR"><a class="permalink" href="#MDOC_DUMP_COLOR"><code class="Ev">MDOC_DUMP_COLOR</code></a></dt>
  <dd>When to colorize the output</dd>
  <dt id="MDOC_DUMP_DEBUG"><a class="permalink" href="#MDOC_DUMP_DEBUG"><code class="Ev">MDOC_DUMP_DEBUG</code></a></dt>
  <dd>Log more verbosely</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="EXIT_STATUS"><a class="permalink" href="#EXIT_STATUS">EXIT
  STATUS</a></h1>
<p class="Pp">The <code class="Nm">mdoc-dump</code> utility exits&#x00A0;0 on
    success, and&#x00A0;&gt;0 if an error occurs.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr" href="https://man.openbsd.org/mdoc.7">mdoc(7)</a></p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">September 22, 2026</td>
    <td class="foot-os">Linux 6.19.11-arch1-1</td>
  </tr>
</table>
</body>
</html>