2 Copyright (C) 1989-1995, 2001 Free Software Foundation, Inc.
4 Permission is granted to make and distribute verbatim copies of
5 this manual provided the copyright notice and this permission notice
6 are preserved on all copies.
8 Permission is granted to copy and distribute modified versions of this
9 manual under the conditions for verbatim copying, provided that the
10 entire resulting derived work is distributed under the terms of a
11 permission notice identical to this one.
13 Permission is granted to copy and distribute translations of this
14 manual into another language, under the above conditions for modified
15 versions, except that this permission notice may be included in
16 translations approved by the Free Software Foundation instead of in
19 .TH GROFF_MS @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
21 groff_ms \- groff ms macros
41 This manual page describes the GNU version of the ms macros,
42 which is part of the groff document formatting system.
43 The groff ms macros are intended to be compatible with the
44 documented behaviour of the 4.3
46 Unix ms macros subject to the following limitations:
48 the internals of groff ms are not similar to the internals of Unix ms
49 and so documents that depend upon implementation details of Unix ms
50 may well not work with groff ms;
52 there is no support for typewriter-like devices;
54 Berkeley localisms, in particular the
58 macros, are not implemented;
61 does not provide cut marks;
63 multiple line spacing is not allowed
64 (use a larger vertical spacing instead);
66 groff ms does not work in compatibility mode (eg with the
70 the error-handling policy of groff ms
71 is to detect and report errors,
72 rather than silently to ignore them.
74 The groff ms macros make use of many features of GNU troff
75 and therefore cannot be used with any other troff.
77 Bell Labs localisms are not implemented in either the
79 ms macros or in the groff ms macros.
81 Some Unix ms documentation says that the
85 number registers can be used to control the column width and
86 gutter width respectively.
88 These number registers are not used in groff ms.
90 Macros that cause a reset set the indent.
91 Macros that change the indent do not increment or decrement
92 the indent, but rather set it absolutely.
93 This can cause problems for documents that define
94 additional macros of their own.
95 The solution is to use not the
97 request but instead the
105 is set to 1 by the groff ms macros,
106 but is not used by the Unix ms macros.
107 It is intended that documents that need to determine whether
108 they are being formatted with Unix ms or groff ms make use of this
111 Footnotes are implemented so that they can safely be used within
113 Automatically numbered footnotes within floating keeps are
115 It is safe to have another
119 and the corresponding
121 it is required only that each
123 occur after the corresponding
125 and that the occurrences of
127 are in the same order as the corresponding occurrences of
134 can be used to begin and end a superscript.
136 Some Unix V10 ms features are implemented.
142 macros can have an optional third argument which will be printed
143 in the current font before the first argument.
148 that changes to a constant-width font.
150 The following strings can be redefined to adapt the groff ms macros
151 to languages other than English:
154 .ta \w'REFERENCES'u+2n
157 REFERENCES References
159 TOC Table of Contents
174 The font family is reset from the string
176 at initialization if this string is undefined it is set to the current
178 The point size, vertical spacing, and inter-paragraph spacing for footnotes
179 are taken from the number registers
184 at initialization these are set to
189 respectively; however, if any of these registers has been defined
190 before initialization, it will not be set.
191 The hyphenation flags (as set by the
193 request) are set from the
196 if this has not been defined at initialization,
197 it will be set to 14.
199 Right-aligned displays are available with
204 The following conventions are used for names of macros, strings and
206 External names available to documents that use the groff ms
207 macros contain only uppercase letters and digits.
208 Internally the macros are divided into modules.
209 Names used only within one module are of the form
210 .IB module * name\fR.
211 Names used outside the module in which they are defined are of the form
212 .IB module @ name\fR.
213 Names associated with a particular environment are of the form
214 .IB environment : name;
215 these are used only within the
220 does not have a module prefix.
221 Constructed names used to implement arrays are of the form
222 .IB array ! index\fR.
223 Thus the groff ms macros reserve the following names:
234 names containing only uppercase letters and digits.
236 .B @MACRODIR@/ms.tmac
242 .BR groff (@MAN1EXT@),
243 .BR @g@troff (@MAN1EXT@),
244 .BR @g@tbl (@MAN1EXT@),
245 .BR @g@pic (@MAN1EXT@),
246 .BR @g@eqn (@MAN1EXT@)