aboutsummaryrefslogtreecommitdiff
path: root/rf.1
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2020-11-11 12:56:02 +0100
committerJohn Ankarström <john@ankarstrom.se>2020-11-11 12:56:02 +0100
commitcf79f696236666c6f695eb6b7fa9046b5f9fcbc5 (patch)
tree4ebf6d3da0430820b33fb61e5a13d1102fd7ff00 /rf.1
parent7843645fef1470cddd503b1ffa1c7c337d21e74c (diff)
downloadrf-cf79f696236666c6f695eb6b7fa9046b5f9fcbc5.tar.gz
clarify manual
Diffstat (limited to 'rf.1')
-rw-r--r--rf.118
1 files changed, 11 insertions, 7 deletions
diff --git a/rf.1 b/rf.1
index a3461fc..605bac3 100644
--- a/rf.1
+++ b/rf.1
@@ -50,7 +50,7 @@ On my HP Compaq dc5700 from 2007, the relationship between number of entries in
.It 182 Ta 0.24s
.El
.Pp
-I would deem it rare to have more than a couple of hundred references in a troff document.
+I would deem it rare to have more than a couple of hundred unique references in a troff document.
.
.Sh USAGE
.Nm
@@ -168,11 +168,12 @@ Defines the
of publication.
.El
.Pp
-Of these macros,
-.Sy \&Ra
-and
-.Sy \&Ry
-are the most important.
+In the final output,
+.Nm
+prints a formatted version of each reference entry in place of its definition.
+.Nm
+does not change the order of reference entries.
+This means that you can arrange your references freely.
.Sh FORMAT SYNTAX
In a format definition, use a percent (%)
sigil followed by a single letter to interpolate any given field of the reference.
@@ -192,6 +193,9 @@ Note that all fields are inserted literally, except
.Em %a ,
from which the forenames of the authors are removed.
.Pp
+Note also that you can use troff requests and other macros in your format by starting with a dot. This will expand to a valid request/macro in the output of
+.Nm .
+.Pp
Finally, you usually don't need to worry about excessive spaces and stray punctuation marks, as
.Nm
removes many of these these automatically.
@@ -199,4 +203,4 @@ removes many of these these automatically.
.Sh AUTHORS
.Nm
was written by John Ankarström
-.Aq Mt john (on) ankarstrom.se .
+.Aq Mt john (at) ankarstrom.se .