summaryrefslogtreecommitdiff
path: root/contrib/mm/mmroff.1.man
blob: 0a34b3a4ce42e42b235e865448cff7f1455e30cb (plain)
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
.TH mmroff @MAN1EXT@ "@MDATE@" "groff @VERSION@"
.SH Name
mmroff \- cross-referencing front end for GNU
.I roff mm
macro package
.
.
.\" ====================================================================
.\" Legal Terms
.\" ====================================================================
.\"
.\" Copyright (C) 1989-2023 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
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of
.\" this manual under the conditions for verbatim copying, provided that
.\" the entire resulting derived work is distributed under the terms of
.\" a permission notice identical to this one.
.\"
.\" Permission is granted to copy and distribute translations of this
.\" manual into another language, under the above conditions for
.\" modified versions, except that this permission notice may be
.\" included in translations approved by the Free Software Foundation
.\" instead of in the original English.
.
.
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
.do nr *groff_mmroff_1_man_C \n[.cp]
.cp 0
.
.\" Define fallback for groff 1.23's MR macro if the system lacks it.
.nr do-fallback 0
.if !\n(.f           .nr do-fallback 1 \" mandoc
.if  \n(.g .if !d MR .nr do-fallback 1 \" older groff
.if !\n(.g           .nr do-fallback 1 \" non-groff *roff
.if \n[do-fallback]  \{\
.  de MR
.    ie \\n(.$=1 \
.      I \%\\$1
.    el \
.      IR \%\\$1 (\\$2)\\$3
.  .
.\}
.rr do-fallback
.
.
.\" ====================================================================
.SH Synopsis
.\" ====================================================================
.
.SY mmroff
.RB [ \-x ]
.I groff-arguments
.YS
.
.
.SY mmroff
.B \-\-help
.YS
.
.
.SY mmroff
.B \-\-version
.YS
.
.
.\" ====================================================================
.SH Description
.\" ====================================================================
.
.I mmroff
is a simple wrapper for
.IR groff ,
used to expand cross references in
.IR m@TMAC_M_PREFIX@m ;
see
.MR groff_mm @MAN7EXT@ .
.
It runs
.I groff
with the
.B \-mm
option twice,
first with
.B \-z
and
.B \-rRef=1
to collect cross references and update the cross-reference file,
and then again to produce the document.
.
Documents that do not use
.IR "groff mm" 's
referencing system
(the
.BR INITR ,
.BR SETR ,
.BR GETHN ,
.BR GETPN ,
.BR GETR ,
and
.B GETST
macros)
do not require
.IR mmroff .
.
.
.\" ====================================================================
.SH Options
.\" ====================================================================
.
.B \-\-help
displays
a usage message,
while
.B \-\-version
shows version information;
both exit afterward.
.
.
.TP
.B \-x
Create or update the cross-reference file and exit.
.
.
.\" ====================================================================
.SH Authors
.\" ====================================================================
.
.I mmroff
was written by
.MT jh@\:axis\:.se
J\[o ad]rgen H\[a ad]gg
.ME
of Lund,
Sweden.
.
.
.\" ====================================================================
.SH "See also"
.\" ====================================================================
.
.MR groff_mm @MAN7EXT@ ,
.MR groff_mmse @MAN7EXT@ ,
.MR groff @MAN1EXT@ ,
.MR @g@troff @MAN1EXT@ ,
.MR @g@tbl @MAN1EXT@ ,
.MR @g@pic @MAN1EXT@ ,
.MR @g@eqn @MAN1EXT@
.
.
.\" Restore compatibility mode (for, e.g., Solaris 10/11).
.cp \n[*groff_mmroff_1_man_C]
.do rr *groff_mmroff_1_man_C
.
.
.\" Local Variables:
.\" fill-column: 72
.\" mode: nroff
.\" End:
.\" vim: set filetype=groff textwidth=72: