groff_ms.man revision 18099
1.ig \"-*- nroff -*- 2Copyright (C) 1989-1995 Free Software Foundation, Inc. 3 4Permission is granted to make and distribute verbatim copies of 5this manual provided the copyright notice and this permission notice 6are preserved on all copies. 7 8Permission is granted to copy and distribute modified versions of this 9manual under the conditions for verbatim copying, provided that the 10entire resulting derived work is distributed under the terms of a 11permission notice identical to this one. 12 13Permission is granted to copy and distribute translations of this 14manual into another language, under the above conditions for modified 15versions, except that this permission notice may be included in 16translations approved by the Free Software Foundation instead of in 17the original English. 18.. 19.TH GROFF_MS @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@" 20.SH NAME 21groff_ms \- groff ms macros 22.SH SYNOPSIS 23.B groff 24.B \-m@TMAC_S_PREFIX@s 25[ 26.IR options .\|.\|. 27] 28[ 29.IR files .\|.\|. 30] 31.SH DESCRIPTION 32This manual page describes the GNU version of the ms macros, 33which is part of the groff document formatting system. 34The groff ms macros are intended to be compatible with the 35documented behaviour of the 4.3 36.SM BSD 37Unix ms macros subject to the following limitations: 38.IP \(bu 39the internals of groff ms are not similar to the internals of Unix ms 40and so documents that depend upon implementation details of Unix ms 41may well not work with groff ms; 42.IP \(bu 43there is no support for typewriter-like devices; 44.IP \(bu 45Berkeley localisms, in particular the 46.B TM 47and 48.B CT 49macros, are not implemented; 50.IP \(bu 51groff ms 52does not provide cut marks; 53.IP \(bu 54multiple line spacing is not allowed 55(use a larger vertical spacing instead); 56.IP \(bu 57groff ms does not work in compatibility mode (eg with the 58.B \-C 59option); 60.IP \(bu 61the error-handling policy of groff ms 62is to detect and report errors, 63rather than silently to ignore them. 64.LP 65The groff ms macros make use of many features of GNU troff 66and therefore cannot be used with any other troff. 67.LP 68Bell Labs localisms are not implemented in either the 69.SM BSD 70ms macros or in the groff ms macros. 71.LP 72Some Unix ms documentation says that the 73.B CW 74and 75.B GW 76number registers can be used to control the column width and 77gutter width respectively. 78This is not the case. 79These number registers are not used in groff ms. 80.LP 81Macros that cause a reset set the indent. 82Macros that change the indent do not increment or decrement 83the indent, but rather set it absolutely. 84This can cause problems for documents that define 85additional macros of their own. 86The solution is to use not the 87.B in 88request but instead the 89.B RS 90and 91.B RE 92macros. 93.LP 94The number register 95.B GS 96is set to 1 by the groff ms macros, 97but is not used by the Unix ms macros. 98It is intended that documents that need to determine whether 99they are being formatted with Unix ms or groff ms make use of this 100number register. 101.LP 102Footnotes are implemented so that they can safely be used within 103keeps and displays. 104Automatically numbered footnotes within floating keeps are 105not recommended. 106It is safe to have another 107.B \e** 108between a 109.B \e** 110and the corresponding 111.BR .FS ; 112it is required only that each 113.B .FS 114occur after the corresponding 115.B \e** 116and that the occurrences of 117.B .FS 118are in the same order as the corresponding occurrences of 119.BR \e** . 120.LP 121The strings 122.B \e*{ 123and 124.B \e*} 125can be used to begin and end a superscript. 126.LP 127Some Unix V10 ms features are implemented. 128The 129.BR B , 130.BR I 131and 132.B BI 133macros can have an optional third argument which will be printed 134in the current font before the first argument. 135There is a macro 136.B CW 137like 138.B B 139that changes to a constant-width font. 140.LP 141The following strings can be redefined to adapt the groff ms macros 142to languages other than English: 143.LP 144.nf 145.ta \w'REFERENCES'u+2n 146String Default Value 147.sp .3v 148REFERENCES References 149ABSTRACT ABSTRACT 150TOC Table of Contents 151MONTH1 January 152MONTH2 February 153MONTH3 March 154MONTH4 April 155MONTH5 May 156MONTH6 June 157MONTH7 July 158MONTH8 August 159MONTH9 September 160MONTH10 October 161MONTH11 November 162MONTH12 December 163.fi 164.LP 165The font family is reset from the string 166.BR FAM ; 167at initialization if this string is undefined it is set to the current 168font family. 169The point size, vertical spacing, and inter-paragraph spacing for footnotes 170are taken from the number registers 171.BR FPS , 172.BR FVS , 173and 174.BR FPD ; 175at initialization these are set to 176.BR \en(PS-2 , 177.BR \en[FPS]+2 , 178and 179.B \en(PD/2 180respectively; however, if any of these registers has been defined 181before initialization, it will not be set. 182The hyphenation flags (as set by the 183.B .hy 184request) are set from the 185.B HY 186register; 187if this has not been defined at initialization, 188it will be set to 14. 189.LP 190Right-aligned displays are available with 191.B ".DS R" 192and 193.BR .RD . 194.LP 195The following conventions are used for names of macros, strings and 196number registers. 197External names available to documents that use the groff ms 198macros contain only uppercase letters and digits. 199Internally the macros are divided into modules. 200Names used only within one module are of the form 201.IB module * name\fR. 202Names used outside the module in which they are defined are of the form 203.IB module @ name\fR. 204Names associated with a particular environment are of the form 205.IB environment : name; 206these are used only within the 207.B par 208module, 209and 210.I name 211does not have a module prefix. 212Constructed names used to implement arrays are of the form 213.IB array ! index\fR. 214Thus the groff ms macros reserve the following names: 215.IP \(bu 216names containing 217.BR * ; 218.IP \(bu 219names containing 220.BR @ ; 221.IP \(bu 222names containing 223.BR : ; 224.IP \(bu 225names containing only uppercase letters and digits. 226.SH FILES 227.B @MACRODIR@/tmac.@TMAC_S_PREFIX@s 228.SH "SEE ALSO" 229.BR groff (@MAN1EXT@), 230.BR @g@troff (@MAN1EXT@), 231.BR @g@tbl (@MAN1EXT@), 232.BR @g@pic (@MAN1EXT@), 233.BR @g@eqn (@MAN1EXT@) 234.br 235.BR ms (@MAN7EXT@) 236