diff options
author | Loïc Hoguin <[email protected]> | 2016-10-30 16:59:51 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-10-30 16:59:51 +0200 |
commit | ace1e250489c858abc33989df4fbed46627975c7 (patch) | |
tree | 1fe226295279c9775c580c832bf2d6e7a82518af /guide/asciidoc.html | |
parent | 463f04d2cfb806c858c786931cb905ac77629cfa (diff) | |
download | erlang.mk-ace1e250489c858abc33989df4fbed46627975c7.tar.gz erlang.mk-ace1e250489c858abc33989df4fbed46627975c7.tar.bz2 erlang.mk-ace1e250489c858abc33989df4fbed46627975c7.zip |
Update user guide
Diffstat (limited to 'guide/asciidoc.html')
-rw-r--r-- | guide/asciidoc.html | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/guide/asciidoc.html b/guide/asciidoc.html index 0fcb434..ab8d579 100644 --- a/guide/asciidoc.html +++ b/guide/asciidoc.html @@ -48,7 +48,7 @@ file is <a class="ulink" href="https://github.com/ninenines/erlang.mk/blob/maste location. This is <span class="emphasis"><em>doc/src/guide/</em></span> for the user guide, and <span class="emphasis"><em>doc/src/manual/</em></span> for the function reference. In the case of the user guide, the entry point is always <span class="emphasis"><em>doc/src/guide/book.asciidoc</em></span>.</p><p>For manual pages, it is good practice to use section 3 for -modules, and section 7 for the application itself.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_2"></a>13.3. Configuration</h2></div></div></div><p>All of the AsciiDoc related configuration can be done directly +modules, and section 7 for the application itself.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_3"></a>13.3. Configuration</h2></div></div></div><p>All of the AsciiDoc related configuration can be done directly inside the files themselves.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage"></a>13.4. Usage</h2></div></div></div><p>To build all documentation:</p><pre class="programlisting">$ make docs</pre><p>To build only the AsciiDoc documentation:</p><pre class="programlisting">$ make asciidoc</pre><p>To build only the user guide:</p><pre class="programlisting">$ make asciidoc-guide</pre><p>To build only the manual:</p><pre class="programlisting">$ make asciidoc-manual</pre><p>To install man pages on Unix:</p><pre class="programlisting">$ make install-docs</pre><p>Erlang.mk allows customizing the installation path and sections of the man pages to be installed. The <code class="literal">MAN_INSTALL_PATH</code> variable defines where man pages will be installed. It defaults to |