aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2020-11-11 12:56:13 +0100
committerJohn Ankarström <john@ankarstrom.se>2020-11-11 12:56:13 +0100
commitcd6d3a48204415f4547048db0f4d0ac7b9414ffc (patch)
tree0d9c67da4ee893bffdb28f93a63fa78cc326abf0
parentcf79f696236666c6f695eb6b7fa9046b5f9fcbc5 (diff)
downloadrf-cd6d3a48204415f4547048db0f4d0ac7b9414ffc.tar.gz
add example document to manual
-rw-r--r--rf.169
1 files changed, 69 insertions, 0 deletions
diff --git a/rf.1 b/rf.1
index 605bac3..d85121b 100644
--- a/rf.1
+++ b/rf.1
@@ -200,6 +200,75 @@ Finally, you usually don't need to worry about excessive spaces and stray punctu
.Nm
removes many of these these automatically.
.
+.Sh EXAMPLE
+Below is an example of an ms-based troff document using
+.Nm rf
+references.
+.Bd -literal -offset indent
+\&.de noop
+\&..
+\&.blm noop
+
+\&.SH
+Previous work
+
+\&.LP
+Davidson
+\&.Rx '' 1991
+has performed a study [...]
+
+\&.PP
+[...] which leads to a higher total cholesterol level
+\&.Rf Smith 2007 .
+
+\&.SH
+Literature
+
+\&.XP
+\&.Ra Davidson, H.
+\&.Ry 1991
+\&.Rt Seminal Work
+\&.Rc London
+\&.Rp Another Press
+
+\&.XP
+\&.Ra Smith, P.
+\&.Ry 2007
+\&.Rt Modern Society
+\&.Rc New York
+\&.Rp Some Press
+.Ed
+.Pp
+When given the above file,
+.Nm
+will output the following code:
+.Bd -literal -offset indent
+\&.de noop
+\&..
+\&.blm noop
+
+\&.SH
+Previous work
+
+\&.LP
+Davidson
+(1991)
+has performed a study [...]
+
+\&.PP
+[...] which leads to a higher total cholesterol level
+(Smith 2007).
+
+\&.SH
+Literature
+
+\&.XP
+Davidson, H. (1991). \\fISeminal Work\\fR. London: Another Press.
+
+\&.XP
+Smith, P. (2007). \\fIModern Society\\fR. New York: Some Press.
+.Ed
+.
.Sh AUTHORS
.Nm
was written by John Ankarström