dbd50b9d39d7730a3d5c9fccabfa9ac578df653e
[platform/upstream/groff.git] / contrib / mm / mmroff.man
1 .TH MMROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
2 .SH NAME
3 mmroff \- cross reference preprocessor
4 .
5 .
6 .\" --------------------------------------------------------------------
7 .\" Legalese
8 .\" --------------------------------------------------------------------
9 .
10 .de co
11 Copyright \[co] 1989-2014 Free Software Foundation, Inc.
12
13 Permission is granted to make and distribute verbatim copies of
14 this manual provided the copyright notice and this permission notice
15 are preserved on all copies.
16
17 Permission is granted to copy and distribute modified versions of this
18 manual under the conditions for verbatim copying, provided that the
19 entire resulting derived work is distributed under the terms of a
20 permission notice identical to this one.
21
22 Permission is granted to copy and distribute translations of this
23 manual into another language, under the above conditions for modified
24 versions, except that this permission notice may be included in
25 translations approved by the Free Software Foundation instead of in
26 the original English.
27 ..
28 .
29 .de au
30 This document was written by
31 .MT jh@axis.se
32 Jörgen Hägg, Lund, Sweden
33 .ME .
34 ..
35 .
36 .\" --------------------------------------------------------------------
37 .SH SYNOPSIS
38 .\" --------------------------------------------------------------------
39 .
40 .B mmroff
41 [
42 .I \-x
43 ]
44 .I groff_arguments
45 .
46 .
47 .\" --------------------------------------------------------------------
48 .SH DESCRIPTION
49 .\" --------------------------------------------------------------------
50 .
51 .B mmroff
52 is a simple preprocessor for
53 .BR groff ,
54 it is used for expanding cross references in
55 .BR m@TMAC_M_PREFIX@m ,
56 see
57 .BR groff_mm (@MAN7EXT@).
58 .
59 .B groff
60 is executed twice, first with
61 .B \-z
62 and
63 .B \-rRef=1
64 to collect all cross references and then to do the real processing
65 when the cross reference file is up to date.
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\[aq]t
73 always needed to have accurate cross references and by using this
74 option
75 .B groff
76 will only be run once.
77 .
78 .
79 .\" --------------------------------------------------------------------
80 .\".SH BUGS
81 .\" --------------------------------------------------------------------
82 .
83 .
84 .\" --------------------------------------------------------------------
85 .SH FILES
86 .\" --------------------------------------------------------------------
87 .
88 .TP
89 .B @MACRODIR@/@TMAC_M_PREFIX@m.tmac
90 .TP
91 .B @TMAC_MDIR@/*.cov
92 .TP
93 .B @TMAC_MDIR@/*.MT
94 .TP
95 .B @TMAC_MDIR@/locale
96 .
97 .
98 .na
99 .\" --------------------------------------------------------------------
100 .SH "SEE ALSO"
101 .\" --------------------------------------------------------------------
102 .
103 .BR groff_mm (@MAN7EXT@),
104 .BR groff_mmse (@MAN7EXT@),
105 .BR groff (@MAN1EXT@),
106 .BR @g@troff (@MAN1EXT@),
107 .BR @g@tbl (@MAN1EXT@),
108 .BR @g@pic (@MAN1EXT@),
109 .BR @g@eqn (@MAN1EXT@)
110 .
111 .
112 .\" --------------------------------------------------------------------
113 .SH COPYING
114 .\" --------------------------------------------------------------------
115 .co
116 .\" --------------------------------------------------------------------
117 .SH AUTHORS
118 .\" --------------------------------------------------------------------
119 .
120 .
121 .
122 .\" Local Variables:
123 .\" mode: nroff
124 .\" coding: latin-1
125 .\" End: