Penguin
Recent Changes
Annotated edit history of groff_ms(7) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 GROFF_MS
2 !!!GROFF_MS
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 FILES
7 SEE ALSO
8 ----
9 !!NAME
10
11
12 groff_ms - groff ms macros
13 !!SYNOPSIS
14
15
16 __groff -ms__ [[ ''options''... ] [[ ''files''...
17 ]__
18 groff -m ms__ [[ ''options''... ] [[ ''files''...
19 ]
20 !!DESCRIPTION
21
22
23 This manual page describes the GNU version of the ms macros,
24 which is part of the groff document formatting system. The
25 groff ms macros are intended to be compatible with the
26 documented behaviour of the 4.3 BSD Unix ms
27 macros subject to the following limitations:
28
29
30 the internals of groff ms are not similar to the internals
31 of Unix ms and so documents that depend upon implementation
32 details of Unix ms may well not work with groff
33 ms;
34
35
36 there is no support for typewriter-like
37 devices;
38
39
40 Berkeley localisms, in particular the __TM__ and
41 __CT__ macros, are not implemented;
42
43
44 groff ms does not provide cut marks;
45
46
47 multiple line spacing is not allowed (use a larger vertical
48 spacing instead);
49
50
51 groff ms does not work in compatibility mode (eg with the
52 __-C__ option);
53
54
55 the error-handling policy of groff ms is to detect and
56 report errors, rather than silently to ignore
57 them.
58
59
60 The groff ms macros make use of many features of GNU troff
61 and therefore cannot be used with any other
62 troff.
63
64
65 Bell Labs localisms are not implemented in either the
66 BSD ms macros or in the groff ms
67 macros.
68
69
70 Some Unix ms documentation says that the __CW__ and
71 __GW__ number registers can be used to control the column
72 width and gutter width respectively. This is not the case.
73 These number registers are not used in groff
74 ms.
75
76
77 Macros that cause a reset set the indent. Macros that change
78 the indent do not increment or decrement the indent, but
79 rather set it absolutely. This can cause problems for
80 documents that define additional macros of their own. The
81 solution is to use not the __in__ request but instead the
82 __RS__ and __RE__ macros.
83
84
85 The number register __GS__ is set to 1 by the groff ms
86 macros, but is not used by the Unix ms macros. It is
87 intended that documents that need to determine whether they
88 are being formatted with Unix ms or groff ms make use of
89 this number register.
90
91
92 Footnotes are implemented so that they can safely be used
93 within keeps and displays. Automatically numbered footnotes
94 within floating keeps are not recommended. It is safe to
95 have another __**__ between a __**__ and the
96 corresponding __.FS__; it is required only that each
97 __.FS__ occur after the corresponding __**__ and that
98 the occurrences of __.FS__ are in the same order as the
99 corresponding occurrences of __**__.
100
101
102 The strings __*{__ and __*}__ can be used to begin and
103 end a superscript.
104
105
106 Some Unix V10 ms features are implemented. The __B__,
107 __I__ and __BI__ macros can have an optional third
108 argument which will be printed in the current font before
109 the first argument. There is a macro __CW__ like __B__
110 that changes to a constant-width font.
111
112
113 The following strings can be redefined to adapt the groff ms
114 macros to languages other than English:
115
116
117 String Default Value
118 REFERENCES References
119 ABSTRACT ABSTRACT
120 TOC Table of Contents
121 MONTH1 January
122 MONTH2 February
123 MONTH3 March
124 MONTH4 April
125 MONTH5 May
126 MONTH6 June
127 MONTH7 July
128 MONTH8 August
129 MONTH9 September
130 MONTH10 October
131 MONTH11 November
132 MONTH12 December
133 The font family is reset from the string __FAM__; at initialization if this string is undefined it is set to the current font family. The point size, vertical spacing, and inter-paragraph spacing for footnotes are taken from the number registers __FPS__, __FVS__, and __FPD__; at initialization these are set to __n(PS-2__, __n[[FPS]+2__, and __n(PD/2__ respectively; however, if any of these registers has been defined before initialization, it will not be set. The hyphenation flags (as set by the __.hy__ request) are set from the __HY__ register; if this has not been defined at initialization, it will be set to 14.
134
135
136 Right-aligned displays are available with __.DS R__ and
137 __.RD__.
138
139
140 The following conventions are used for names of macros,
141 strings and number registers. External names available to
142 documents that use the groff ms macros contain only
143 uppercase letters and digits. Internally the macros are
144 divided into modules. Names used only within one module are
145 of the form ''module''__*__''name''. Names used
146 outside the module in which they are defined are of the form
147 ''module''__@__''name''. Names associated with a
148 particular environment are of the form
149 ''environment''__:__''name;'' these are used only
150 within the __par__ module, and ''name'' does not have
151 a module prefix. Constructed names used to implement arrays
152 are of the form ''array''__!__''index''. Thus the
153 groff ms macros reserve the following names:
154
155
156 names containing __*__;
157
158
159 names containing __@__;
160
161
162 names containing __:__;
163
164
165 names containing only uppercase letters and
166 digits.
167 !!FILES
168
169
170 __/usr/share/groff/1.17.2/tmac/ms.tmac__ (a wrapper file
171 for __s.tmac__)__
172 /usr/share/groff/1.17.2/tmac/s.tmac__
173 !!SEE ALSO
174
175
176 groff(1), troff(1), tbl(1),
177 pic(1), eqn(1)__
178 ms__(7)
179 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.