diff options
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | index.html | 58 |
2 files changed, 44 insertions, 16 deletions
@@ -1,2 +1,2 @@ index.html: ../master/rf.1 - man -T html -O fragment $< > $@ + man -T html -O fragment $< | sed 's/<a class="permalink"/& style="color: black; text-decoration: none;"/;s/<h2/<h3/;s/<h1/<h2/;s </h2 </h3 ;s </h1 </h2 ' > $@ @@ -7,27 +7,27 @@ </table> <div class="manual-text"> <section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<h2 class="Sh" id="NAME"><a class="permalink" style="color: black; text-decoration: none;" href="#NAME">NAME</a></h2> <code class="Nm">rf</code> — <div class="Nd">alternative reference system for (t)roff</div> </section> <section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<h2 class="Sh" id="SYNOPSIS"><a class="permalink" style="color: black; text-decoration: none;" href="#SYNOPSIS">SYNOPSIS</a></h2> <table class="Nm"> <tr> <td><code class="Nm">rf</code></td> - <td><code class="Li"><</code> <var class="Ar">file</var></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> +<h2 class="Sh" id="DESCIPTION"><a class="permalink" style="color: black; text-decoration: none;" href="#DESCIPTION">DESCIPTION</a></h2> <code class="Nm">rf</code> is a reference system for troff and other roff derivatives. It differs from <a class="Xr">refer(1)</a>, the traditional troff reference system, in a couple important ways: <ol class="Bl-enum"> <li>References are not stored in a separate file. They are defined via macros - in the troff document itself. + in the troff document itself, usually at the end. <p class="Pp">This means that you can move, copy and share your troff document without needing to worry about an additional reference file. Furthermore, you never run the risk of accidentally losing the @@ -40,16 +40,44 @@ more basic functionality than <a class="Xr">refer(1)</a>. This means that you can learn all of it in five minutes.</li> </ol> +<p class="Pp">The performance of <code class="Nm">rf</code> primarily depends on + the number of entries in the reference list at the end of the document. On + my HP Compaq dc5700 from 2007, the relationship between number of entries in + the reference list and total execution time is roughly the following:</p> +<table class="Bl-column Bd-indent"> + <tr> + <td><i class="Em">Entries</i></td> + <td><i class="Em">Time</i></td> + </tr> + <tr> + <td>3</td> + <td>0.03s</td> + </tr> + <tr> + <td>50</td> + <td>0.09s</td> + </tr> + <tr> + <td>107</td> + <td>0.15s</td> + </tr> + <tr> + <td>182</td> + <td>0.24s</td> + </tr> +</table> +<p class="Pp">I would deem it rare to have more than a couple of hundred + references in a troff document.</p> </section> <section class="Sh"> -<h1 class="Sh" id="USAGE"><a class="permalink" href="#USAGE">USAGE</a></h1> +<h2 class="Sh" id="USAGE"><a class="permalink" style="color: black; text-decoration: none;" href="#USAGE">USAGE</a></h2> <code class="Nm">rf</code> is controlled by several macros, all consisting of one uppercase and one lowercase letter, beginning with either an ‘F’ (format macros) or an ‘R’ (inline reference and reference list macros). These are listed below in alphabetical order. <section class="Ss"> -<h2 class="Ss" id="Format_macros"><a class="permalink" href="#Format_macros">Format - macros</a></h2> +<h3 class="Ss" id="Format_macros"><a class="permalink" style="color: black; text-decoration: none;" href="#Format_macros">Format + macros</a></h3> <dl class="Bl-tag"> <dt><b class="Sy">Ff</b></dt> <dd>Defines the format for “full” inline references, which @@ -72,8 +100,8 @@ <a class="Sx" href="#FORMAT_SYNTAX">FORMAT SYNTAX</a>.</p> </section> <section class="Ss"> -<h2 class="Ss" id="Inline_reference_macros"><a class="permalink" href="#Inline_reference_macros">Inline - reference macros</a></h2> +<h3 class="Ss" id="Inline_reference_macros"><a class="permalink" style="color: black; text-decoration: none;" href="#Inline_reference_macros">Inline + reference macros</a></h3> <dl class="Bl-tag"> <dt><b class="Sy">Rf</b></dt> <dd>Inserts a “full” inline reference, which usually contains @@ -112,8 +140,8 @@ there has been a gradual change in attitudes towards ... </div> </section> <section class="Ss"> -<h2 class="Ss" id="Reference_list_macros"><a class="permalink" href="#Reference_list_macros">Reference - list macros</a></h2> +<h3 class="Ss" id="Reference_list_macros"><a class="permalink" style="color: black; text-decoration: none;" href="#Reference_list_macros">Reference + list macros</a></h3> <dl class="Bl-tag"> <dt><b class="Sy">Ra</b></dt> <dd>Adds to the list of <i class="Em">authors</i> of the current reference. @@ -144,8 +172,8 @@ there has been a gradual change in attitudes towards ... </section> </section> <section class="Sh"> -<h1 class="Sh" id="FORMAT_SYNTAX"><a class="permalink" href="#FORMAT_SYNTAX">FORMAT - SYNTAX</a></h1> +<h2 class="Sh" id="FORMAT_SYNTAX"><a class="permalink" style="color: black; text-decoration: none;" href="#FORMAT_SYNTAX">FORMAT + SYNTAX</a></h2> In a format definition, use a percent (%) sigil followed by a single letter to interpolate any given field of the reference. The letter following the percent sign corresponds to the second letter of the reference list macros described @@ -171,7 +199,7 @@ In a format definition, use a percent (%) sigil followed by a single letter to these these automatically.</p> </section> <section class="Sh"> -<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<h2 class="Sh" id="AUTHORS"><a class="permalink" style="color: black; text-decoration: none;" href="#AUTHORS">AUTHORS</a></h2> <code class="Nm">rf</code> was written by John Ankarström <<a class="Mt" href="mailto:john">john</a> <a class="Mt" href="mailto:(on)">(on)</a> |