<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/doc/man/includes/options-output-format.md - fork/cargo @ 0.91.0</title>
<meta name="description" content="src/doc/man/includes/options-output-format.md in fork/cargo at 0.91.0.">
<meta property="og:title" content="src/doc/man/includes/options-output-format.md - fork/cargo @ 0.91.0">
<meta property="og:description" content="src/doc/man/includes/options-output-format.md in fork/cargo at 0.91.0.">
<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="0.91.0" data-tip="840b83a10fb0e039a83f4d70ad032892c287570a">
<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="f4e2eac630b06bf13906ea609f2b42cb15600d7d">Auto merge of #12252 - charmitro:master, r=weihanglo</span><span class="snapshot-sha sha" data-commit="f4e2eac630b06bf13906ea609f2b42cb15600d7d">f4e2eac63</span><time datetime="2024-01-11T18:32:07+00:00" title="2024-01-11 18:32:07 +0000">2024-01-11</time></p>
<header class="topbar"><details class="switcher"><summary>0.91.0</summary><div class="menu"><strong>branches</strong><a 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 class="current" 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/0.91.0/tree/src/">src</a> / <a href="/fork/cargo/ref/0.91.0/tree/src/doc/">doc</a> / <a href="/fork/cargo/ref/0.91.0/tree/src/doc/man/">man</a> / <a href="/fork/cargo/ref/0.91.0/tree/src/doc/man/includes/">includes</a> / <span class="cur">options-output-format.md</span></nav>
<span class="view-stats"><span>474 B</span><span>9 lines</span></span><span class="actions"><a class="raw" href="/fork/cargo/raw/218cacfa0723e97f92ed13c5688d71319f7ba49b/src/doc/man/includes/options-output-format.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"><p>{{#option "<code>--output-format</code>"}}
The output type for the documentation emitted. Valid values:</p>
<ul>
<li><code>html</code> (default): Emit the documentation in HTML format.</li>
<li><code>json</code>: Emit the documentation in the <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types">experimental JSON format</a>.</li>
</ul>
<p>This option is only available on the <a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly channel</a>
and requires the <code>-Z unstable-options</code> flag to enable.
{{/option}}</p>
</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">{{#option &quot;`--output-format`&quot;}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">The output type for the documentation emitted. Valid values:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>* </a-p>`html` (default): Emit the documentation in HTML format.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>* </a-p>`json`: Emit the documentation in the [experimental JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types).</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">This option is only available on the [nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">and requires the `-Z unstable-options` flag to enable.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">{{/option}}</span></span></pre></div></div>
</main>
</body>
</html>
