OSDN Git Service

Import translated manuals from JM CVS Repository.
[linuxjm/jm.git] / manual / GNU_groff / original / man7 / groff_ms.7
1 .ig
2 Copyright (C) 1989-1995, 2001 Free Software Foundation, Inc.
3
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.
7
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.
12
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
17 the original English.
18 ..
19 .TH GROFF_MS 7 "27 June 2001" "Groff Version 1.17.2"
20 .SH NAME
21 groff_ms \- groff ms macros
22 .SH SYNOPSIS
23 .B groff
24 .B \-ms
25 [
26 .IR options .\|.\|.
27 ]
28 [
29 .IR files .\|.\|.
30 ]
31 .br
32 .B groff
33 .B \-m\ ms
34 [
35 .IR options .\|.\|.
36 ]
37 [
38 .IR files .\|.\|.
39 ]
40 .SH DESCRIPTION
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
45 .SM BSD
46 Unix ms macros subject to the following limitations:
47 .IP \(bu
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;
51 .IP \(bu
52 there is no support for typewriter-like devices;
53 .IP \(bu
54 Berkeley localisms, in particular the
55 .B TM
56 and
57 .B CT
58 macros, are not implemented;
59 .IP \(bu
60 groff ms
61 does not provide cut marks;
62 .IP \(bu
63 multiple line spacing is not allowed
64 (use a larger vertical spacing instead);
65 .IP \(bu
66 groff ms does not work in compatibility mode (eg with the
67 .B \-C
68 option);
69 .IP \(bu
70 the error-handling policy of groff ms
71 is to detect and report errors,
72 rather than silently to ignore them.
73 .LP
74 The groff ms macros make use of many features of GNU troff
75 and therefore cannot be used with any other troff.
76 .LP
77 Bell Labs localisms are not implemented in either the
78 .SM BSD
79 ms macros or in the groff ms macros.
80 .LP
81 Some Unix ms documentation says that the
82 .B CW
83 and
84 .B GW
85 number registers can be used to control the column width and
86 gutter width respectively.
87 This is not the case.
88 These number registers are not used in groff ms.
89 .LP
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
96 .B in
97 request but instead the
98 .B RS
99 and
100 .B RE
101 macros.
102 .LP
103 The number register
104 .B GS
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
109 number register.
110 .LP
111 Footnotes are implemented so that they can safely be used within
112 keeps and displays.
113 Automatically numbered footnotes within floating keeps are
114 not recommended.
115 It is safe to have another
116 .B \e**
117 between a
118 .B \e**
119 and the corresponding
120 .BR .FS ;
121 it is required only that each
122 .B .FS
123 occur after the corresponding
124 .B \e**
125 and that the occurrences of
126 .B .FS
127 are in the same order as the corresponding occurrences of
128 .BR \e** .
129 .LP
130 The strings
131 .B \e*{
132 and
133 .B \e*}
134 can be used to begin and end a superscript.
135 .LP
136 Some Unix V10 ms features are implemented.
137 The
138 .BR B ,
139 .BR I
140 and
141 .B BI
142 macros can have an optional third argument which will be printed
143 in the current font before the first argument.
144 There is a macro
145 .B CW
146 like
147 .B B
148 that changes to a constant-width font.
149 .LP
150 The following strings can be redefined to adapt the groff ms macros
151 to languages other than English:
152 .LP
153 .nf
154 .ta \w'REFERENCES'u+2n
155 String  Default Value
156 .sp .3v
157 REFERENCES      References
158 ABSTRACT        ABSTRACT
159 TOC     Table of Contents
160 MONTH1  January
161 MONTH2  February
162 MONTH3  March
163 MONTH4  April
164 MONTH5  May
165 MONTH6  June
166 MONTH7  July
167 MONTH8  August
168 MONTH9  September
169 MONTH10 October
170 MONTH11 November
171 MONTH12 December
172 .fi
173 .LP
174 The font family is reset from the string
175 .BR FAM ;
176 at initialization if this string is undefined it is set to the current
177 font family.
178 The point size, vertical spacing, and inter-paragraph spacing for footnotes
179 are taken from the number registers
180 .BR FPS ,
181 .BR FVS ,
182 and
183 .BR FPD ;
184 at initialization these are set to
185 .BR \en(PS-2 ,
186 .BR \en[FPS]+2 ,
187 and
188 .B \en(PD/2
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
192 .B .hy
193 request) are set from the
194 .B HY
195 register;
196 if this has not been defined at initialization,
197 it will be set to 14.
198 .LP
199 Right-aligned displays are available with
200 .B ".DS R"
201 and
202 .BR .RD .
203 .LP
204 The following conventions are used for names of macros, strings and
205 number registers.
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
216 .B par
217 module,
218 and
219 .I name
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:
224 .IP \(bu
225 names containing
226 .BR * ;
227 .IP \(bu
228 names containing
229 .BR @ ;
230 .IP \(bu
231 names containing
232 .BR : ;
233 .IP \(bu
234 names containing only uppercase letters and digits.
235 .SH FILES
236 .B /usr/share/groff/1.17.2/tmac/ms.tmac
237 (a wrapper file for
238 .BR s.tmac )
239 .br
240 .B /usr/share/groff/1.17.2/tmac/s.tmac
241 .SH "SEE ALSO"
242 .BR groff (1),
243 .BR troff (1),
244 .BR tbl (1),
245 .BR pic (1),
246 .BR eqn (1)
247 .br
248 .BR ms (7)
249 .
250 .\" Local Variables:
251 .\" mode: nroff
252 .\" End: