usr/src/man/man5/ms.5

   1 '\" te
   2 .\" Copyright (c) 1992, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH MS 5 "Feb 25, 1992"
   7 .SH NAME
   8 ms \- text formatting macros
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBnroff\fR  \fB-ms\fR [\fIoptions\fR] \fIfilename\fR...
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBtroff\fR  \fB-ms\fR [\fIoptions\fR] \fIfilename\fR...
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 This package of \fBnroff\fR(1) and \fBtroff\fR(1) macro definitions provides a
  24 formatting facility for various styles of articles, theses, and books. When
  25 producing 2-column output on a terminal or lineprinter, or when reverse line
  26 motions are needed, filter the output through \fBcol\fR(1). All external
  27 \fB-ms\fR macros are defined below.
  28 .sp
  29 .LP
  30 Note: this  \fB-ms\fR macro package is an extended version written at Berkeley
  31 and is a superset of the standard  \fB-ms\fR macro packages as supplied by Bell
  32 Labs.  Some of the Bell Labs macros have been removed; for instance, it is
  33 assumed that the user has little interest in producing headers stating that the
  34 memo was generated at Whippany Labs.
  35 .sp
  36 .LP
  37 Many \fBnroff\fR and \fBtroff\fR requests are unsafe in conjunction with this
  38 package. However, the first four requests below may be used with impunity after
  39 initialization, and the last two may be used even before initialization:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fB\&.bp\fR\fR
  44 .ad
  45 .RS 11n
  46 begin new page
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fB\&.br\fR\fR
  53 .ad
  54 .RS 11n
  55 break output line
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB\&.sp\fR\fI n\fR\fR
  62 .ad
  63 .RS 11n
  64 insert n spacing lines
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fB\&.ce\fR\fI n\fR\fR
  71 .ad
  72 .RS 11n
  73 center next n lines
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB\&.ls\fR\fI n\fR\fR
  80 .ad
  81 .RS 11n
  82 line spacing: \fIn\fR\fB=1\fR single, \fIn\fR\fB=2\fR double space
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB\&.na\fR\fR
  89 .ad
  90 .RS 11n
  91 no alignment of right margin
  92 .RE
  93
  94 .sp
  95 .LP
  96 Font and point size changes with \fB\ef\fR and \fB\es\fR are also allowed; for
  97 example, \fB\efIword\efR\fR will italicize \fIword\fR. Output of the
  98 \fBtbl\fR(1), \fBeqn\fR(1) and \fBrefer\fR(1) preprocessors for equations,
  99 tables, and references is acceptable as input.
 100 .SH REQUESTS
 101 .sp
 102
 103 .sp
 104 .TS
 105 c | c | c | c
 106 l | l | l | l .
 107 Macro Name      Initial Value   Break? Reset?   Explanation
 108 _
 109 \fB\&.AB\fR \fIx\fR     -       y       T{
 110 begin abstract; if \fIx\fR=no do not label abstract
 111 T}
 112 _
 113 \fB\&.AE\fR     -       y       end abstract
 114 _
 115 \fB\&.AI\fR     -       y       author's institution
 116 _
 117 \fB\&.AM\fR     -       n       better accent mark definitions
 118 _
 119 \fB\&.AU\fR     -       y       author's name
 120 _
 121 \fB\&.B\fR \fIx\fR      -       n       embolden \fIx\fR; if no \fIx\fR, switch to boldface
 122 _
 123 \fB\&.B1\fR     -       y       begin text to be enclosed in a box
 124 _
 125 \fB\&.B2\fR     -       y       end boxed text and print it
 126 _
 127 \fB\&.BT\fR     date    n       bottom title, printed at foot of page
 128 _
 129 \fB\&.BX\fR \fIx\fR     -       n       print word \fIx\fR in a box
 130 _
 131 \fB\&.CM\fR     if t    n       cut mark between pages
 132 _
 133 \fB\&.CT\fR     -       y,y     T{
 134 chapter title: page number moved to CF (TM only)
 135 T}
 136 _
 137 \fB\&.DA\fR \fIx\fR     if n    n       T{
 138 force date \fIx\fR at bottom of page; today if no \fIx\fR
 139 T}
 140 _
 141 \fB\&.DE\fR     -       y       end display (unfilled text) of any kind
 142 _
 143 \fB\&.DS\fR \fIx y\fR   I       y       T{
 144 begin display with keep; \fIx\fR=I,\|L,\|C,\|B; \fIy\fR=indent
 145 T}
 146 _
 147 \fB\&.ID\fR\fI y\fR     8n,.5i  y       indented display with no keep; \fIy\fR=indent
 148 _
 149 \fB\&.LD\fR     -       y       left display with no keep
 150 _
 151 \fB\&.CD\fR     -       y       centered display with no keep
 152 _
 153 \fB\&.BD\fR     -       y       block display; center entire block
 154 _
 155 \fB\&.EF\fR \fIx\fR     -       n       even page footer \fIx\fR (3 part as for \fB\&.tl\fR)
 156 _
 157 \fB\&.EH\fR \fIx\fR     -       n       even page header \fIx\fR (3 part as for \fB\&.tl\fR)
 158 _
 159 \fB\&.EN\fR     -       y       end displayed equation produced by \fBeqn\fR
 160 _
 161 \fB\&.EQ\fR \fIx y\fR   -       y       T{
 162 break out equation; \fIx\fR=L,I,C; \fIy\fR=equation number
 163 T}
 164 _
 165 \fB\&.FE\fR     -       n       T{
 166 end footnote to be placed at bottom of page
 167 T}
 168 _
 169 \fB\&.FP\fR     -       n       T{
 170 numbered footnote paragraph; may be redefined
 171 T}
 172 _
 173 \fB\&.FS\fR \fIx\fR     -       n       T{
 174 start footnote; \fIx\fR is optional footnote label
 175 T}
 176 _
 177 \fB\&.HD\fR     undef   n       optional page header below header margin
 178 _
 179 \fB\&.I\fR \fIx\fR      -       n       italicize \fIx\fR; if no \fIx\fR, switch to italics
 180 _
 181 \fB\&.IP\fR \fIx y\fR   -       y,y     T{
 182 indented paragraph, with hanging tag \fIx\fR; \fIy\fR=indent
 183 T}
 184 _
 185 \fB\&.IX\fR \fIx y\fR   -       y       T{
 186 index words \fIx\fR \fIy\fR and so on (up to 5 levels)
 187 T}
 188 _
 189 \fB\&.KE\fR     -       n       end keep of any kind
 190 _
 191 \fB\&.KF\fR     -       n       T{
 192 begin floating keep; text fills remainder of page
 193 T}
 194 _
 195 \fB\&.KS\fR     -       y       T{
 196 begin keep; unit kept together on a single page
 197 T}
 198 _
 199 \fB\&.LG\fR     -       n       larger; increase point size by 2
 200 _
 201 \fB\&.LP\fR     -       y,y     left (block) paragraph.
 202 _
 203 \fB\&.MC\fR \fIx\fR     -       y,y     multiple columns; \fIx\fR=column width
 204 _
 205 \fB\&.ND\fR \fIx\fR     if t    n       T{
 206 no date in page footer; \fIx\fR is date on cover
 207 T}
 208 _
 209 \fB\&.NH\fR \fIx y\fR   -       y,y     T{
 210 numbered header; \fIx\fR=level, \fIx\fR=0 resets, \fIx\fR=S sets to \fIy\fR
 211 T}
 212 _
 213 \fB\&.NL\fR     10p     n       set point size back to normal
 214 _
 215 \fB\&.OF\fR \fIx\fR     -       n       odd page footer \fIx\fR (3 part as for \fB\&.tl\fR)
 216 _
 217 \fB\&.OH\fR \fIx\fR     -       n       odd page header \fIx\fR (3 part as for \fB\&.tl\fR)
 218 _
 219 \fB\&.P1\fR     if TM   n       print header on first page
 220 _
 221 \fB\&.PP\fR     -       y,y     paragraph with first line indented
 222 _
 223 \fB\&.PT\fR     - % -   n       page title, printed at head of page
 224 _
 225 \fB\&.PX\fR \fIx\fR     -       y       T{
 226 print index (table of contents); \fIx\fR=no suppresses title
 227 T}
 228 _
 229 \fB\&.QP\fR     -       y,y     quote paragraph (indented and shorter)
 230 _
 231 \fB\&.R\fR      on      n       return to Roman font
 232 _
 233 \fB\&.RE\fR     5n      y,y     T{
 234 retreat: end level of relative indentation
 235 T}
 236 _
 237 \fB\&.RP\fR \fIx\fR     -       n       T{
 238 released paper format; \fIx\fR=no stops title on first page
 239 T}
 240 _
 241 \fB\&.RS\fR     5n      y,y     T{
 242 right shift: start level of relative indentation
 243 T}
 244 _
 245 \fB\&.SH\fR     -       y,y     section header, in boldface
 246 _
 247 \fB\&.SM\fR     -       n       smaller; decrease point size by 2
 248 _
 249 \fB\&.TA\fR     8n,5n   n       T{
 250 set TAB characters to 8n 16n .\|.\|. (\fBnroff\fR)  or 5n 10n .\|.\|. (\fBtroff\fR)
 251 T}
 252 _
 253 \fB\&.TC\fR \fIx\fR     -       y       T{
 254 print table of contents at end; \fIx\fR=no suppresses title
 255 T}
 256 _
 257 _
 258 \fB\&.TH\fR - Y "multi-page end, header"
 259 _
 260 \fB\&.TL\fR     -       y       title in boldface and two points larger
 261 _
 262 \fB\&.TM\fR     off     n       UC Berkeley thesis mode
 263 _
 264 \fB\&.TE\fR     -       y       end of table processed by \fBtbl\fR
 265 \fB\&.TS\fR \fIx\fR     -       y,y     T{
 266 begin table; if \fIx\fR=H table has multi-page header
 267 T}
 268 _
 269 \fB\&.UL\fR \fIx\fR     -       n       underline \fIx\fR, even in \fBtroff\fR
 270 _
 271 \fB\&.UX\fR \fIx\fR     -       n       T{
 272 UNIX; trademark message first time; \fIx\fR appended
 273 T}
 274 _
 275 \fB\&.XA\fR \fIx y\fR   -       y       T{
 276 another index entry; \fIx\fR=page or no for none;  y=indent
 277 T}
 278 _
 279 \fB\&.XE\fR     -       y       T{
 280 end index entry (or series of \fB\&.IX\fR entries)
 281 T}
 282 _
 283 \fB\&.XP\fR     -       y,y     T{
 284 paragraph with first line indented, others indented
 285 T}
 286 _
 287 \fB\&.XS\fR \fIx y\fR   -       y       T{
 288 begin index entry; \fIx\fR=page or no for none; \fIy\fR=indent
 289 T}
 290 _
 291 \fB\&.1C\fR     on      y,y     one column format, on a new page
 292 _
 293 \fB\&.2C\fR     -       y,y     begin two column format
 294 _
 295 \fB\&.]\|-\fR   -       n       beginning of \fBrefer\fR reference
 296 _
 297 \fB\&.[\|0\fR   -       n       end of unclassifiable type of reference
 298 _
 299 \fB\&.[\|N\fR   -       n       T{
 300 N= 1:journal-article, 2:book, 3:book-article, 4:report
 301 T}
 302 .TE
 303
 304 .SH REGISTERS
 305 .sp
 306 .LP
 307 Formatting distances can be controlled in \fB-ms\fR by means of built-in number
 308 registers. For example, this sets the line length to 6.5 inches:
 309 .sp
 310 .in +2
 311 .nf
 312 \&.nr  LL  6.5i
 313 .fi
 314 .in -2
 315
 316 .sp
 317 .LP
 318 Here is a table of number registers and their default values:
 319 .sp
 320
 321 .sp
 322 .TS
 323 c | c | c | c
 324 l | l | l | l .
 325 Name    Register Controls       Takes Effect    Default
 326 _
 327 \fBPS\fR        point size              paragraph       10
 328 _
 329 \fBVS\fR        vertical spacing        paragraph       12
 330 _
 331 \fBLL\fR        line length             paragraph       6i
 332 _
 333 \fBLT\fR        title length            next page       same as \fBLL\fR
 334 _
 335 \fBFL\fR        footnote length         next \fB\&.FS\fR        5.5i
 336 _
 337 \fBPD\fR        paragraph distance      paragraph       1v (if n), .3v (if t)
 338 _
 339 \fBDD\fR        display distance        displays        1v (if n), .5v (if t)
 340 _
 341 \fBPI\fR        paragraph indent        paragraph       5n
 342 _
 343 \fBQI\fR        quote indent            next \fB\&.QP\fR        5n
 344 _
 345 \fBFI\fR        footnote indent         next \fB\&.FS\fR        2n
 346 _
 347 \fBPO\fR        page offset             next page       0 (if n), \(ap1i (if t)
 348 _
 349 \fBHM\fR        header margin           next page       1i
 350 _
 351 \fBFM\fR        footer margin           next page       1i
 352 _
 353 \fBFF\fR        footnote format         next \fB\&.FS\fR        0 (1, 2, 3 available)
 354 .TE
 355
 356 .sp
 357 .LP
 358 When resetting these values, make sure to specify the appropriate units.
 359 Setting the line length to 7, for example, will result in output with one
 360 character per line. Setting \fBFF\fR to 1 suppresses footnote superscripting;
 361 setting it to 2 also suppresses indentation of the first line; and setting it
 362 to 3 produces an \fB\&.IP\fR-like footnote paragraph.
 363 .sp
 364 .LP
 365 Here is a list of string registers available in \fB-ms\fR; they may be used
 366 anywhere in the text:
 367 .sp
 368
 369 .sp
 370 .TS
 371 c | c
 372 l | l .
 373 Name    String's Function
 374 _
 375 \fB\e*Q\fR      quote (\fB"\fR in \fBnroff,\fR\| \fB"\fR in \fBtroff\fR )
 376 _
 377 \fB\e*U\fR      unquote (\fB"\fR in \fBnroff,\fR\| \fB"\fR in \fBtroff\fR )
 378 _
 379 \fB\e*-\fR      dash (\fB--\fR in \fBnroff,\fR \fB\(em\fR in \fBtroff\fR )
 380 _
 381 \fB\e*(MO\fR    month (month of the year)
 382 _
 383 \fB\e*(DY\fR    day (current date)
 384 _
 385 \fB\e**\fR      automatically numbered footnote
 386 _
 387 \fB\e*'\fR      acute accent (before letter)
 388 _
 389 \fB\e*`\fR      grave accent (before letter)
 390 _
 391 \fB\e*^\fR      circumflex (before letter)
 392 _
 393 \fB\e*,\fR      cedilla (before letter)
 394 _
 395 \fB\e*:\fR      umlaut (before letter)
 396 _
 397 \fB\e*~\fR      tilde (before letter)
 398 .TE
 399
 400 .sp
 401 .LP
 402 When using the extended accent mark definitions available with \fB\&.AM\fR,
 403 these strings should come after, rather than before, the letter to be accented.
 404 .SH FILES
 405 .sp
 406 .ne 2
 407 .na
 408 \fB\fB/usr/share/lib/tmac/s\fR\fR
 409 .ad
 410 .RS 30n
 411
 412 .RE
 413
 414 .sp
 415 .ne 2
 416 .na
 417 \fB\fB/usr/share/lib/tmac/ms.???\fR\fR
 418 .ad
 419 .RS 30n
 420
 421 .RE
 422
 423 .SH SEE ALSO
 424 .sp
 425 .LP
 426 \fBcol\fR(1), \fBeqn\fR(1), \fBnroff\fR(1), \fBrefer\fR(1), \fBtbl\fR(1),
 427 \fBtroff\fR(1)
 428 .SH BUGS
 429 .sp
 430 .LP
 431 Floating keeps and regular keeps are diverted to the same space, so they cannot
 432 be mixed together with predictable results.