plan9port

fork of plan9port with libvec, libstr and libsdb
Log | Files | Refs | README | LICENSE

ms.7 (6814B)


      1 .TH MS 7
      2 .hc %
      3 .SH NAME
      4 ms \- macros for formatting manuscripts
      5 .SH SYNOPSIS
      6 .B "nroff -ms"
      7 [
      8 .I options
      9 ]
     10 .I file ...
     11 .br
     12 .B "troff -ms"
     13 [
     14 .I options
     15 ]
     16 .I file ...
     17 .SH DESCRIPTION
     18 This package of
     19 .I nroff
     20 and
     21 .MR troff (1)
     22 macro definitions provides a canned formatting
     23 facility for tech%nical papers in various formats.
     24 .PP
     25 The macro requests are defined below.
     26 Many
     27 .I nroff
     28 and
     29 .I troff
     30 requests are unsafe in conjunction with
     31 this package, but the following requests may be used with
     32 impunity after the first
     33 .BR .PP :
     34 .LR .bp ,
     35 .LR .br ,
     36 .LR .sp ,
     37 .LR .ls ,
     38 .LR .na .
     39 .PP
     40 Output of the
     41 .MR eqn (1) ,
     42 .MR tbl (1) ,
     43 .MR pic (1)
     44 and
     45 .MR grap (1)
     46 preprocessors
     47 for equations, tables, pictures, and graphs is acceptable as input.
     48 .SH FILES
     49 .B \*9/tmac/tmac.s
     50 .SH "SEE ALSO"
     51 .br
     52 M. E. Lesk,
     53 ``Typing Documents on the UNIX System: Using the \-ms Macros with Troff and Nroff'',
     54 .I
     55 Unix Research System Programmer's Manual,
     56 Tenth Edition, Volume 2.
     57 .br
     58 .IR eqn (1), 
     59 .IR troff (1), 
     60 .MR tbl (1) ,
     61 .MR pic (1)
     62 .SH REQUESTS
     63 .ta \w'..ND \fIdate\fR 'u +\w'Initial 'u +\w'Cause 'u
     64 .br
     65 .di x
     66 			\ka
     67 .br
     68 .di
     69 .in \nau
     70 .ti0
     71 Request	Initial	Cause	Explanation
     72 .ti0
     73 	Value	Break
     74 .br
     75 .in \nau
     76 .ti0
     77 \fL\&.1C\fP	yes	yes	One column format on a new page.
     78 .ti0
     79 \fL\&.2C\fP	no	yes	Two column format.
     80 .ti0
     81 \fL\&.AB\fP	no	yes	Begin abstract.
     82 .ti0
     83 \fL\&.AE\fP	-	yes	End abstract.
     84 .ti0
     85 \fL\&.AI\fP	no	yes	Author's institution follows.
     86 Suppressed in
     87 .BR .TM .
     88 .ti0
     89 \fL\&.AT\fP	no	yes	Print `Attached' and turn off line filling.
     90 .ti0
     91 \fL\&.AU\fP\fP\fP \fIx y\fR	no	yes	Author's name follows.
     92 .IR x " is location and " y " is"
     93 extension, ignored except in
     94 .BR TM .
     95 .ti0
     96 \fL\&.B\fP \fIx y\fR	no	no	Print
     97 .I x
     98 in boldface, append
     99 .IR y ;
    100 if no argument switch to boldface.
    101 .ti0
    102 \fL\&.B1\fP	no	yes	Begin text to be enclosed in a box.
    103 .ti0
    104 \fL\&.B2\fP	no	yes	End boxed text.
    105 .ti0
    106 \fL\&.BI\fP \fIx y\fR	no	no	Print
    107 .I x
    108 in bold italic and append
    109 .IR y ;
    110 if no argument switch to bold italic.
    111 .ti0
    112 \fL\&.BT\fP	date	no	Bottom title, automatically invoked at
    113 foot of page.
    114 May be redefined.
    115 .ti0
    116 \fL\&.BX\fP \fIx\fR	no	no	Print
    117 .I x
    118 in a box.
    119 .ti0
    120 \fL\&.CW\fP \fIx y\fR	no	no	Constant width font for
    121 .IR x ,
    122 append
    123 .IR y ;
    124 if no argument switch to constant width.
    125 .ti0
    126 \fL\&.CT\fP	no	yes	Print `Copies to' and turn off line filling.
    127 .ti0
    128 \fL\&.DA\fP \fIx\fR	nroff	no	`Date line' at bottom of page
    129 is
    130 .IR x .
    131 Default is today.
    132 .ti0
    133 \fL\&.DE\fP	-	yes	End displayed text.
    134 Implies
    135 .BR .KE .
    136 .ti0
    137 \fL\&.DS\fP \fIx\fR	no	yes	Start of displayed text,
    138 to appear verbatim line-by-line:
    139 .L I
    140 indented (default),
    141 .L L
    142 left-justified,
    143 .L C
    144 centered,
    145 .L B
    146 (block) centered with straight left margin.
    147 Implies
    148 .BR .KS .
    149 .ti0
    150 \fL\&.EG\fP	no	-	Print document in BTL format for `Engineer's Notes.'  Must be first.
    151 .ti0
    152 \fL\&.EN\fP	-	yes	Space after equation
    153 produced by
    154 .I neqn
    155 or
    156 .MR eqn (1) .
    157 .ti0
    158 \fL\&.EQ\fP \fIx y\fR	-	yes	Display equation.
    159 Equation number is
    160 .IR y .
    161 Optional 
    162 .I x
    163 is
    164 .BR I ", " L ", " C
    165 as in
    166 .BR .DS .
    167 .ti0
    168 \fL\&.FE\fP	-	yes	End footnote.
    169 .ti0
    170 \fL\&.FP\fP \fIx\fR	-	no	Set font positions for a family, e.g.,
    171 .L .FP luxisans
    172 .ti0
    173 \fL\&.FS\fP	no	no	Start footnote.
    174 The note will be moved to the bottom of the page.
    175 .ti0
    176 \fL\&.HO\fP	-	no	`Bell Laboratories, Holmdel,
    177 New Jersey 07733'.
    178 .ti0
    179 \fL\&.I\fP \fIx y\fR	no	no	Italicize
    180 .IR x ,
    181 append
    182 .IR y ;
    183 if no argument switch to italic.
    184 .ti0
    185 \fL\&.IH\fP	no	no	`Bell Laboratories, Naperville, Illinois 60540'
    186 .ti0
    187 \fL\&.IM\fP	no	no	Print document in BTL format for an internal memorandum.  Must be first.
    188 .ti0
    189 \fL\&.IP\fP \fIx y\fR	no	yes	Start indented paragraph,
    190 with hanging tag
    191 .IR x .
    192 Indentation is
    193 .I y
    194 ens (default 5).
    195 .ti0
    196 \fL\&.KE\fP	-	yes	End keep.
    197 Put kept text on next page if not enough room.
    198 .ti0
    199 \fL\&.KF\fP	no	yes	Start floating keep.
    200 If the kept text must be moved to the next page,
    201 float later text back to this page.
    202 .ti0
    203 \fL\&.KS\fP	no	yes	Start keeping following text.
    204 .ti0
    205 \fL\&.LG\fP	no	no	Make letters larger.
    206 .ti0
    207 \fL\&.LP\fP	yes	yes	Start left-blocked paragraph.
    208 .ti0
    209 \fL\&.LT\fP	no	yes	Start a letter; a non-empty first argument
    210 produces a full Lucent letterhead, a second argument is a room number,
    211 a third argument is a telephone number.
    212 .ti0
    213 \fL\&.MF\fP	-	-	Print document in BTL format for `Memorandum for File.'  Must be first.
    214 .ti0
    215 \fL\&.MH\fP	-	no	`Bell Laboratories, Murray Hill,
    216 New Jersey 07974'.
    217 .ti0
    218 \fL\&.MR\fP	-	-	Print document in BTL format for `Memorandum for Record.'  Must be first.
    219 .ti0
    220 \fL\&.ND\fP \fIdate\fR	troff	no	Use date supplied (if any) only in
    221 special BTL format positions; omit from page footer.
    222 .ti0
    223 \fL\&.NH\fP \fIn\fR	-	yes	Same as
    224 .BR .SH ,
    225 with automatic section
    226 numbers  like `1.2.3';
    227 .I n
    228 is subsection level (default 1).
    229 .ti0
    230 \fL\&.NL\fP	yes	no	Make letters normal size.
    231 .ti0
    232 \fL\&.P1\fP	-	yes	Begin program display in constant width font.
    233 .ti0
    234 \fL\&.P2\fP	-	yes	End program display.
    235 .ti0
    236 \fL\&.PE\fP	-	yes	End picture; see
    237 .MR pic (1) .
    238 .ti0
    239 \fL\&.PF\fP	-	yes	End picture; restore vertical
    240 position.
    241 .ti0
    242 \fL\&.PP\fP	no	yes	Begin paragraph.
    243 First line indented.
    244 .ti0
    245 \fL\&.PS\fP \fIh w\fR	-	yes	Start picture; height
    246 and width in inches.
    247 .ti0
    248 \fL\&.PY\fP	-	no	`Bell Laboratories, Piscataway, New Jersey 08854'
    249 .ti0
    250 \fL\&.QE\fP	-	yes	End quoted material.
    251 .ti0
    252 \fL\&.QP\fP	-	yes	Begin quoted paragraph (indent both margins).
    253 .ti0
    254 \fL\&.QS\fP	-	yes	Begin quoted material (indent both margins).
    255 .ti0
    256 \fL\&.R\fP	yes	no	Roman text follows.
    257 .ti0
    258 \fL\&.RE\fP	-	yes	End relative indent level.
    259 .ti0
    260 \fL\&.RP\fP	no	-	Cover sheet and first page for released
    261 paper.
    262 Must precede other requests.
    263 .ti0
    264 \fL\&.RS\fP	-	yes	Start level of relative indentation
    265 from which subsequent indentation is measured.
    266 .ti0
    267 \fL\&.SG\fP \fIx\fR	no	yes	Insert signature(s) of author(s),
    268 ignored except in 
    269 .B .TM
    270 and
    271 .BR .LT .
    272 .IR x " is the reference line (initials of author and typist)."
    273 .ti0
    274 \fL\&.SH\fP	-	yes	Section head follows,
    275 font automatically bold.
    276 .ti0
    277 \fL\&.SM\fP	no	no	Make letters smaller.
    278 .ti0
    279 \fL\&.TA\fP\ \fIx\fR...	5...	no	Set tabs in ens.
    280 Default is 5 10 15 ...
    281 .ti0
    282 \fL\&.TE\fP	-	yes	End table; see
    283 .MR tbl (1) .
    284 .ti0
    285 \fL\&.TH\fP	-	yes	End heading section of table.
    286 .ti0
    287 \fL\&.TL\fP	no	yes	Title follows.
    288 .ti0
    289 \fL\&.TM\fP\ \fIx\fR...	no	-	Print document in BTL technical memorandum format.
    290 Arguments are TM number, (quoted list of) case number(s), and file number.
    291 Must precede other requests.
    292 .ti0
    293 \fL\&.TR\fP \fIx\fR	-	-	Print in BTL technical report format; report number is \fIx\fR.  Must be first.
    294 .ti0
    295 \fL\&.TS\fP \fIx\fR	-	yes	Begin table; if
    296 .I x
    297 is
    298 .B H
    299 table heading is repeated on new pages.
    300 .ti0
    301 \fL\&.UL\fP \fIx\fR	-	no	Underline argument (even in troff).
    302 .ti0
    303 \fL\&.UX\fP\ \fIy z\fP	-	no	`\fIz\fRUNIX\fIy\fP';
    304 first use gives registered trademark notice.
    305 .ti0
    306 \fL\&.WH\fP	-	no	`Bell Laboratories, Whippany,
    307 New Jersey 07981'.
    308 .hc