Imported Upstream version 1.22.4
[platform/upstream/groff.git] / contrib / mm / mmroff.1.man
1 .TH MMROFF @MAN1EXT@ "@MDATE@" "groff @VERSION@"
2 .SH NAME
3 mmroff \- cross-reference preprocessor for GNU roff mm macro package
4 .
5 .
6 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
7 .do nr mmroff_C \n[.C]
8 .cp 0
9 .
10 .
11 .\" ====================================================================
12 .\" Legal Terms
13 .\" ====================================================================
14 .\"
15 .\" Copyright (C) 1989-2018 Free Software Foundation, Inc.
16 .\"
17 .\" Permission is granted to make and distribute verbatim copies of this
18 .\" manual provided the copyright notice and this permission notice are
19 .\" preserved on all copies.
20 .\"
21 .\" Permission is granted to copy and distribute modified versions of
22 .\" this manual under the conditions for verbatim copying, provided that
23 .\" the entire resulting derived work is distributed under the terms of
24 .\" a permission notice identical to this one.
25 .\"
26 .\" Permission is granted to copy and distribute translations of this
27 .\" manual into another language, under the above conditions for
28 .\" modified versions, except that this permission notice may be
29 .\" included in translations approved by the Free Software Foundation
30 .\" instead of in the original English.
31 .
32 .
33 .\" ====================================================================
34 .SH SYNOPSIS
35 .\" ====================================================================
36 .
37 .SY mmroff
38 .OP \-x
39 .I groff-arguments
40 .YS
41 .
42 .
43 .\" ====================================================================
44 .SH DESCRIPTION
45 .\" ====================================================================
46 .
47 .I mmroff
48 is a simple preprocessor for
49 .IR groff ,
50 used for expanding cross references in
51 .IR m@TMAC_M_PREFIX@m ;
52 see
53 .IR groff_mm (@MAN7EXT@).
54 .
55 .I groff
56 is executed twice, first with
57 .B \-z
58 and
59 .B \-rRef=1
60 to collect all cross references and then to do the real processing
61 when the cross-reference file is up to date.
62 .
63 .
64 .\" ====================================================================
65 .SH OPTIONS
66 .\" ====================================================================
67 .
68 .TP
69 .B \-x
70 Just create the cross-reference file.
71 .
72 This can be used to refresh the cross-reference file; it isn't
73 always needed to have accurate cross references and by using this
74 option
75 .I groff
76 will only be run once.
77 .
78 .
79 .\" ====================================================================
80 .SH AUTHORS
81 .\" ====================================================================
82 .
83 .B mmroff
84 was written by
85 .MT jh@\:axis.se
86 Jörgen Hägg
87 .ME
88 of Lund, Sweden.
89 .
90 .
91 .\" ====================================================================
92 .SH "SEE ALSO"
93 .\" ====================================================================
94 .
95 .IR groff_mm (@MAN7EXT@),
96 .IR groff_mmse (@MAN7EXT@),
97 .IR groff (@MAN1EXT@),
98 .IR @g@troff (@MAN1EXT@),
99 .IR @g@tbl (@MAN1EXT@),
100 .IR @g@pic (@MAN1EXT@),
101 .IR @g@eqn (@MAN1EXT@)
102 .
103 .
104 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
105 .cp \n[mmroff_C]
106 .
107 .
108 .\" Local Variables:
109 .\" mode: nroff
110 .\" coding: latin-1
111 .\" End:
112 .\" vim: set filetype=groff: