From dab6c180bf966c495bf7f06ff355fe1d9c82c4ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= Date: Wed, 11 Nov 2020 11:32:37 +0100 Subject: regenerate manual (add performance info) --- index.html | 58 +++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 43 insertions(+), 15 deletions(-) (limited to 'index.html') diff --git a/index.html b/index.html index 6f5e32d..c5cc048 100644 --- a/index.html +++ b/index.html @@ -7,27 +7,27 @@
-

+

rf —
alternative reference system for (t)roff
-

+

- +
rf< filefile
-

+

rf is a reference system for troff and other roff derivatives. It differs from refer(1), the traditional troff reference system, in a couple important ways:
  1. 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.

    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 refer(1). This means that you can learn all of it in five minutes.

+

The performance of rf 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:

+ + + + + + + + + + + + + + + + + + + + + +
EntriesTime
30.03s
500.09s
1070.15s
1820.24s
+

I would deem it rare to have more than a couple of hundred + references in a troff document.

-

+

rf 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.
-

+

Ff
Defines the format for “full” inline references, which @@ -72,8 +100,8 @@ FORMAT SYNTAX.

-

+

Rf
Inserts a “full” inline reference, which usually contains @@ -112,8 +140,8 @@ there has been a gradual change in attitudes towards ...
-

+

Ra
Adds to the list of authors of the current reference. @@ -144,8 +172,8 @@ there has been a gradual change in attitudes towards ...
-

+

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.

-

+

rf was written by John Ankarström <john (on) -- cgit v1.2.3