Debian Codegraph @

upstream/debian-unstable/man1/mmroff.1

raw
1 .TH mmroff 1 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 mmroff \- reference- and PostScript inclusion-handling front end for GNU
4 .I roff mm
5 macro package
6 .
7 .
8 .\" ====================================================================
9 .\" Legal Terms
10 .\" ====================================================================
11 .\"
12 .\" Copyright 1989-2025 Free Software Foundation, Inc.
13 .\"
14 .\" This file is part of mm, a reimplementation of the Documenter's
15 .\" Workbench (DWB) troff memorandum macro package for use with GNU
16 .\" troff.
17 .\"
18 .\" mm is distributed with groff, the GNU roff typesetting system.
19 .\"
20 .\" Permission is granted to make and distribute verbatim copies of this
21 .\" manual provided the copyright notice and this permission notice are
22 .\" preserved on all copies.
23 .\"
24 .\" Permission is granted to copy and distribute modified versions of
25 .\" this manual under the conditions for verbatim copying, provided that
26 .\" the entire resulting derived work is distributed under the terms of
27 .\" a permission notice identical to this one.
28 .\"
29 .\" Permission is granted to copy and distribute translations of this
30 .\" manual into another language, under the above conditions for
31 .\" modified versions, except that this permission notice may be
32 .\" included in translations approved by the Free Software Foundation
33 .\" instead of in the original English.
34 .
35 .
36 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
37 .do nr *groff_mmroff_1_man_C \n[.cp]
38 .cp 0
39 .
40 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
41 .nr do-fallback 0
42 .if !\n(.f .nr do-fallback 1 \" mandoc
43 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
44 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
45 .if \n[do-fallback] \{\
46 . de MR
47 . ie \\n(.$=1 \
48 . I \%\\$1
49 . el \
50 . IR \%\\$1 (\\$2)\\$3
51 . .
52 .\}
53 .rr do-fallback
54 .
55 .
56 .\" ====================================================================
57 .SH Synopsis
58 .\" ====================================================================
59 .
60 .SY mmroff
61 .RB [ \-x ]
62 .IR groff-argument \~.\|.\|.
63 .YS
64 .
65 .
66 .P
67 .SY mmroff
68 .B \-\-help
69 .YS
70 .
71 .
72 .P
73 .SY mmroff
74 .B \%\-\-version
75 .YS
76 .
77 .
78 .\" ====================================================================
79 .SH Description
80 .\" ====================================================================
81 .
82 .I mmroff
83 is a simple wrapper for
84 .IR groff ,
85 used to expand internal references in
86 .I m\%m
87 documents;
88 see
89 .MR groff_mm 7 .
90 .
91 It runs
92 .I groff
93 with the
94 .B \-mm
95 option twice,
96 first with
97 .B \-z
98 and
99 .B \-rRef=1
100 to populate reference and index files with their corresponding entries,
101 and then without to produce the document.
102 .
103 It also handles the inclusion of PostScript images with the
104 .B PIC
105 macro.
106 .
107 Documents that do not use these features of
108 .I "groff mm"
109 (the
110 .BR INITI ,
111 .BR IND ,
112 .BR INDP ,
113 .BR INITR ,
114 .BR SETR ,
115 .BR GETHN ,
116 .BR GETPN ,
117 .BR GETR ,
118 .BR GETST ,
119 and
120 .B PIC
121 macros)
122 do not require
123 .IR \%mmroff .
124 .
125 .
126 .\" ====================================================================
127 .SH Options
128 .\" ====================================================================
129 .
130 .B \-\-help
131 displays
132 a usage message,
133 while
134 .B \%\-\-version
135 shows version information;
136 both exit afterward.
137 .
138 .
139 .TP
140 .B \-x
141 Create or update the reference list file and exit.
142 .
143 .
144 .\" ====================================================================
145 .SH Environment
146 .\" ====================================================================
147 .
148 Normally,
149 the path separator in environment variables ending with
150 .I PATH
151 is the colon;
152 this may vary depending on the operating system.
153 .
154 For example,
155 Windows uses a semicolon instead.
156 .
157 .
158 .TP
159 .I GROFF_BIN_PATH
160 Locate
161 .I groff \" system
162 commands
163 in these directories,
164 followed by those in
165 .IR PATH .
166 .
167 If not set,
168 the installation directory of GNU
169 .I roff
170 executables,
171 .IR /usr/\:\%bin ,
172 is searched before
173 .IR PATH .
174 .
175 .
176 .\" ====================================================================
177 .SH "Exit status"
178 .\" ====================================================================
179 .
180 .I mmroff
181 exits with status
182 .B 0
183 if the
184 .B \-\-help
185 or
186 .B \%\-\-version
187 options were specified,
188 or if
189 .B \-x
190 was specified and the program successfully
191 created or updated the reference list file.
192 .
193 It exits with status
194 .B 1
195 if it was unable to create necessary files.
196 .
197 Otherwise,
198 it exits with the status of
199 .IR groff .
200 .
201 .
202 .\" ====================================================================
203 .SH Authors
204 .\" ====================================================================
205 .
206 .I mmroff
207 was written by
208 .MT jh@\:axis\:.se
209 J\[o ad]rgen H\[a ad]gg
210 .ME
211 of Lund,
212 Sweden.
213 .
214 .
215 .\" ====================================================================
216 .SH "See also"
217 .\" ====================================================================
218 .
219 .MR groff_mm 7 ,
220 .MR groff_mmse 7
221 (only in Swedish locales),
222 .MR groff 1 ,
223 .MR \%troff 1 ,
224 .MR \%tbl 1 ,
225 .MR \%pic 1 ,
226 .MR \%eqn 1
227 .
228 .
229 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
230 .cp \n[*groff_mmroff_1_man_C]
231 .do rr *groff_mmroff_1_man_C
232 .
233 .
234 .\" Local Variables:
235 .\" fill-column: 72
236 .\" mode: nroff
237 .\" End:
238 .\" vim: set filetype=groff textwidth=72: