Debian Codegraph @

upstream/debian-trixie/man1/mmroff.1

raw
1 .TH mmroff 1 "3 June 2025" "groff 1.23.0"
2 .SH Name
3 mmroff \- cross-referencing front end for GNU
4 .I roff mm
5 macro package
6 .
7 .
8 .\" ====================================================================
9 .\" Legal Terms
10 .\" ====================================================================
11 .\"
12 .\" Copyright (C) 1989-2023 Free Software Foundation, Inc.
13 .\"
14 .\" Permission is granted to make and distribute verbatim copies of this
15 .\" manual provided the copyright notice and this permission notice are
16 .\" preserved on all copies.
17 .\"
18 .\" Permission is granted to copy and distribute modified versions of
19 .\" this manual under the conditions for verbatim copying, provided that
20 .\" the entire resulting derived work is distributed under the terms of
21 .\" a permission notice identical to this one.
22 .\"
23 .\" Permission is granted to copy and distribute translations of this
24 .\" manual into another language, under the above conditions for
25 .\" modified versions, except that this permission notice may be
26 .\" included in translations approved by the Free Software Foundation
27 .\" instead of in the original English.
28 .
29 .
30 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
31 .do nr *groff_mmroff_1_man_C \n[.cp]
32 .cp 0
33 .
34 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
35 .nr do-fallback 0
36 .if !\n(.f .nr do-fallback 1 \" mandoc
37 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
38 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
39 .if \n[do-fallback] \{\
40 . de MR
41 . ie \\n(.$=1 \
42 . I \%\\$1
43 . el \
44 . IR \%\\$1 (\\$2)\\$3
45 . .
46 .\}
47 .rr do-fallback
48 .
49 .
50 .\" ====================================================================
51 .SH Synopsis
52 .\" ====================================================================
53 .
54 .SY mmroff
55 .RB [ \-x ]
56 .IR groff-argument \~.\|.\|.
57 .YS
58 .
59 .
60 .SY mmroff
61 .B \-\-help
62 .YS
63 .
64 .
65 .SY mmroff
66 .B \-\-version
67 .YS
68 .
69 .
70 .\" ====================================================================
71 .SH Description
72 .\" ====================================================================
73 .
74 .I mmroff
75 is a simple wrapper for
76 .IR groff ,
77 used to expand cross references in
78 .IR m\%m ;
79 see
80 .MR groff_mm 7 .
81 .
82 It runs
83 .I groff
84 with the
85 .B \-mm
86 option twice,
87 first with
88 .B \-z
89 and
90 .B \-rRef=1
91 to populate cross-reference and index files with their corresponding
92 entries,
93 and then again to produce the document.
94 .
95 It also handles the inclusion of PostScript images with the
96 .B PIC
97 macro.
98 .
99 Documents that do not use these features of
100 .I "groff mm"
101 (the
102 .BR INITI ,
103 .BR IND ,
104 .BR INDP ,
105 .BR INITR ,
106 .BR SETR ,
107 .BR GETHN ,
108 .BR GETPN ,
109 .BR GETR ,
110 .BR GETST ,
111 and
112 .B PIC
113 macros)
114 do not require
115 .IR \%mmroff .
116 .
117 .
118 .\" ====================================================================
119 .SH Options
120 .\" ====================================================================
121 .
122 .B \-\-help
123 displays
124 a usage message,
125 while
126 .B \-\-version
127 shows version information;
128 both exit afterward.
129 .
130 .
131 .TP
132 .B \-x
133 Create or update the cross-reference file and exit.
134 .
135 .
136 .\" ====================================================================
137 .SH Authors
138 .\" ====================================================================
139 .
140 .I mmroff
141 was written by
142 .MT jh@\:axis\:.se
143 J\[o ad]rgen H\[a ad]gg
144 .ME
145 of Lund,
146 Sweden.
147 .
148 .
149 .\" ====================================================================
150 .SH "See also"
151 .\" ====================================================================
152 .
153 .MR groff_mm 7 ,
154 .MR groff_mmse 7
155 (only in Swedish locales),
156 .MR groff 1 ,
157 .MR \%troff 1 ,
158 .MR \%tbl 1 ,
159 .MR \%pic 1 ,
160 .MR \%eqn 1
161 .
162 .
163 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
164 .cp \n[*groff_mmroff_1_man_C]
165 .do rr *groff_mmroff_1_man_C
166 .
167 .
168 .\" Local Variables:
169 .\" fill-column: 72
170 .\" mode: nroff
171 .\" End:
172 .\" vim: set filetype=groff textwidth=72: