gnu/usr.bin/groff/man/groff_ms.man

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