[groff] 01/01: refer(1): Complete example.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit efb745cb43990b5feb2d8dbbfb2cbf74ddf99021
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Aug 4 09:29:41 2021 +1000

    refer(1): Complete example.
    
    I accidentally committed it in an interim state.
---
 src/preproc/refer/refer.1.man | 38 ++++++++++++++++++--------------------
 1 file changed, 18 insertions(+), 20 deletions(-)

diff --git a/src/preproc/refer/refer.1.man b/src/preproc/refer/refer.1.man
index 7a843d1..e52bfe9 100644
--- a/src/preproc/refer/refer.1.man
+++ b/src/preproc/refer/refer.1.man
@@ -7,7 +7,7 @@
 .\" Legal Terms
 .\" ====================================================================
 .\"
-.\" Copyright (C) 1989-2020 Free Software Foundation, Inc.
+.\" Copyright (C) 1989-2021 Free Software Foundation, Inc.
 .\"
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
@@ -1855,7 +1855,7 @@ document to cite that entry.
 .RS
 .EX
 $ \c
-.B cat > db
+.B cat > my\-db\-file
 .B %A Daniel P.\[rs]& Friedman
 .B %A Matthias Felleisen
 .B %C Cambridge, Massachusetts
@@ -1863,8 +1863,14 @@ $ \c
 .B %I The MIT Press
 .B %T The Little Schemer, Fourth Edition
 $ \c
-.B @g@refer \-p db
-\&.lf 1 scheme.roff
+.B refer -p my\-db\-file
+.B Read the book
+.B .[
+.B friedman
+.B .]
+.B on your summer vacation.
+.I <Control+D>
+\&.lf 1 \-
 Read the book\[rs]*([.1\[rs]*(.]
 \&.ds [F 1
 \&.]\-
@@ -1876,7 +1882,7 @@ Read the book\[rs]*([.1\[rs]*(.]
 \&.nr [T 0
 \&.nr [A 0
 \&.][ 2 book
-\&.lf 5 scheme.roff
+\&.lf 5 \-
 on your summer vacation.
 .EE
 .RE
@@ -1893,7 +1899,10 @@ and
 strings;
 (c) calls a macro
 .RB \[lq] ]\- \[rq];
-and defines strings and registers with the label and bibliographic data.
+(d) defines strings and registers containing the label and bibliographic
+data for the reference;
+and (e) calls a macro
+.RB \[lq] ][ \[rq].
 .
 As discussed in subsection \[lq]Macro interface\[rq] above,
 it is up to the document or a macro package to employ and format this
@@ -1908,7 +1917,7 @@ to this task.
 .RS
 .EX
 $ \c
-.B @g@refer \-p db | groff \-ms
+.B (export REFER=my\-db\-file; groff \-R \-ms)
 .B .LP
 .B Read the book
 .B .[
@@ -1924,23 +1933,12 @@ $ \c
 .
 .
 .LP
-We have used
-.IR \%@g@refer 's
-.I opening-text
-and
-.I closing-text
-parameters with
-.IR "groff ms" 's
-superscripting strings to produce a superscripted footnote for the label
-inserted by
-.IR \%@g@refer .
-.
 .IR ms 's
 automatic footnote numbering mechanism is not aware of
 .IR \%@g@refer 's
 label numbering,
-so we have manually specified a symbolic footnote for our
-non-bibliographic aside.
+so we have manually specified a (superscripted) symbolic footnote for
+our non-bibliographic aside.
 .
 .
 .\" ====================================================================