1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
.\" Copyright (c) 2008 Stijn van Dongen
.TH "pud-ref" 7 "4 Sep 2008" "pud-ref 1\&.002, 08-248" "MISCELLANEOUS "
.po 2m
.de ZI
.\" Zoem Indent/Itemize macro I.
.br
'in +\\$1
.nr xa 0
.nr xa -\\$1
.nr xb \\$1
.nr xb -\\w'\\$2'
\h'|\\n(xau'\\$2\h'\\n(xbu'\\
..
.de ZJ
.br
.\" Zoem Indent/Itemize macro II.
'in +\\$1
'in +\\$2
.nr xa 0
.nr xa -\\$2
.nr xa -\\w'\\$3'
.nr xb \\$2
\h'|\\n(xau'\\$3\h'\\n(xbu'\\
..
.if n .ll -2m
.am SH
.ie n .in 4m
.el .in 8m
..
.SH NAME
pud-ref \- A description of the Portable Unix Documentation macros for referencing
.SH DESCRIPTION
The following macros are used by the PUD manual macros
(see \fBpud-man(7)\fP) and the PUD FAQ macros
(\fBpud-faq(7)\fP)\&.
.SH MACROS
.ZI 3m "\fB\erefload#2\fP"
\&
'in -3m
.ZI 3m "\fB\erefloadx#2\fP"
\&
'in -3m
'in +3m
\&
.br
Both macros take as first argument
a label that uniquely defines the reference\&.
The second argument is a vararg containing key-value pairs\&.
These macros are usually not needed in PUD documents; they are
lower level facilities used by high level PUD macros\&.
.in -3m
.ZI 3m "\fB\eref#2\fP"
\&
.br
The first argument is a label\&. The second argument should be a key
associated with that label\&. The result is the value associated
with the label/key pair\&.
These macros are usually not needed in PUD documents; they are
lower level facilities used by high level PUD macros (e\&.g\&. \fC\eiref#2\fP,
and \fC\esecref#1\fP)\&.
.in -3m
.ZI 3m "\fB\erefcaption#1\fP"
\&
'in -3m
.ZI 3m "\fB\erefnumber#1\fP"
\&
'in -3m
.ZI 3m "\fB\ereflevel#1\fP"
\&
'in -3m
'in +3m
\&
.br
The argument is a label\&. The result is respectively the caption, number,
or level associated with that label\&.
.in -3m
.ZI 3m "\e\fBreference#1\fP"
\&
'in -3m
.ZI 3m "\e\fBrefer#1\fP"
\&
'in -3m
'in +3m
\&
.br
The first associates a number with the label that is in the first argument,
and prints it inbeween square brackets\&. The label is anchored to this
location\&. The second outputs the associated number inbetween brackets, and
makes it carry a link to the anchor\&. For example, I am about
to create a link\ \&[1] and another link\ \&[2]
to the items appearing below\&.
[1] The first reference\&.
[2] The second reference\&.
If you prefer another bibliography style, find the macros
and adapt them according to your needs \- they are very simple\&.
\fC\ereference#2\fP currently writes data to the file \fC\e__fnbase__\&.zmr\fP,
to be read back in using a \fC\eload{\e__fnbase__\&.zmr}\fP statement\&.
This is automatically done when using the PUD man or FAQ packages\&.
.in -3m
|
