Standards, Environments, and Macros ms(5)
NAME
ms - text formatting macros
SYNOPSIS
nroff -ms [options] filename...
troff -ms [options] filename...
DESCRIPTION
This package of nroff(1) and troff(1) macro definitions pro-
vides a formatting facility for various styles of articles,theses, and books. When producing 2-column output on a ter-
minal or lineprinter, or when reverse line motions areneeded, filter the output through col(1). All external -ms
macros are defined below.Note: this -ms macro package is an extended version written
at Berkeley and is a superset of the standard -ms macro
packages as supplied by Bell Labs. Some of the Bell Labs macros have been removed; for instance, it is assumed that the user has little interest in producing headers stating that the memo was generated at Whippany Labs. Many nroff and troff requests are unsafe in conjunction with this package. However, the first four requests below may be used with impunity after initialization, and the last two may be used even before initialization: .bp begin new page .br break output line .sp n insert n spacing lines .ce n center next n lines .ls n line spacing: n=1 single, n=2 double space .na no alignment of right marginSunOS 5.11 Last change: 25 Feb 1992 1
Standards, Environments, and Macros ms(5)
Font and point size changes with \f and \s are also allowed; for example, \fIword\fR will italicize word. Output of the tbl(1), eqn(1) and refer(1) preprocessors for equations, tables, and references is acceptable as input. REQUESTS Macro Name Initial Value Break? Reset? Explanation_____________________________________________________________________________________
.AB x - y begin abstract; if x=no do not label
abstract_____________________________________________________________________________________
.AE - y end abstract
_____________________________________________________________________________________
.AI - y author's institution
_____________________________________________________________________________________
.AM - n better accent mark definitions
_____________________________________________________________________________________
.AU - y author's name
_____________________________________________________________________________________
.B x - n embolden x; if no x, switch to boldface
_____________________________________________________________________________________
.B1 - y begin text to be enclosed in a box
_____________________________________________________________________________________
.B2 - y end boxed text and print it
_____________________________________________________________________________________
.BT date n bottom title, printed at foot of page_____________________________________________________________________________________
.BX x - n print word x in a box
_____________________________________________________________________________________
.CM if t n cut mark between pages_____________________________________________________________________________________
.CT - y,y chapter title: page number moved to CF
(TM only)_____________________________________________________________________________________
.DA x if n n force date x at bottom of page; today if no x_____________________________________________________________________________________
.DE - y end display (unfilled text) of any kind
_____________________________________________________________________________________
.DS x y I y begin display with keep; x=I,L,C,B; y=indent_____________________________________________________________________________________
.ID y 8n,.5i y indented display with no keep; y=indent_____________________________________________________________________________________
.LD - y left display with no keep
_____________________________________________________________________________________
.CD - y centered display with no keep
_____________________________________________________________________________________
.BD - y block display; center entire block
_____________________________________________________________________________________
.EF x - n even page footer x (3 part as for .tl)
_____________________________________________________________________________________
SunOS 5.11 Last change: 25 Feb 1992 2
Standards, Environments, and Macros ms(5)
.EH x - n even page header x (3 part as for .tl)
_____________________________________________________________________________________
.EN - y end displayed equation produced by eqn
_____________________________________________________________________________________
.EQ x y - y break out equation; x=L,I,C; y=equation
number_____________________________________________________________________________________
.FE - n end footnote to be placed at bottom of
page_____________________________________________________________________________________
.FP - n numbered footnote paragraph; may be
redefined_____________________________________________________________________________________
.FS x - n start footnote; x is optional footnote
label_____________________________________________________________________________________
.HD undef n optional page header below header margin_____________________________________________________________________________________
.I x - n italicize x; if no x, switch to italics
_____________________________________________________________________________________
.IP x y - y,y indented paragraph, with hanging tag x;
y=indent_____________________________________________________________________________________
.IX x y - y index words x y and so on (up to 5 lev-
els)_____________________________________________________________________________________
.KE - n end keep of any kind
_____________________________________________________________________________________
.KF - n begin floating keep; text fills
remainder of page_____________________________________________________________________________________
.KS - y begin keep; unit kept together on a sin-
gle page_____________________________________________________________________________________
.LG - n larger; increase point size by 2
_____________________________________________________________________________________
.LP - y,y left (block) paragraph.
_____________________________________________________________________________________
.MC x - y,y multiple columns; x=column width
_____________________________________________________________________________________
.ND x if t n no date in page footer; x is date on cover_____________________________________________________________________________________
.NH x y - y,y numbered header; x=level, x=0 resets,
x=S sets to y_____________________________________________________________________________________
.NL 10p n set point size back to normal_____________________________________________________________________________________
.OF x - n odd page footer x (3 part as for .tl)
_____________________________________________________________________________________
.OH x - n odd page header x (3 part as for .tl)
_____________________________________________________________________________________
SunOS 5.11 Last change: 25 Feb 1992 3
Standards, Environments, and Macros ms(5)
.P1 if TM n print header on first page_____________________________________________________________________________________
.PP - y,y paragraph with first line indented
_____________________________________________________________________________________
.PT - % - n page title, printed at head of page
_____________________________________________________________________________________
.PX x - y print index (table of contents); x=no
suppresses title_____________________________________________________________________________________
.QP - y,y quote paragraph (indented and shorter)
_____________________________________________________________________________________
.R on n return to Roman font_____________________________________________________________________________________
.RE 5n y,y retreat: end level of relative indenta-
tion_____________________________________________________________________________________
.RP x - n released paper format; x=no stops title
on first page_____________________________________________________________________________________
.RS 5n y,y right shift: start level of relative indentation_____________________________________________________________________________________
.SH - y,y section header, in boldface
_____________________________________________________________________________________
.SM - n smaller; decrease point size by 2
_____________________________________________________________________________________
.TA 8n,5n n set TAB characters to 8n 16n ... (nroff) or 5n 10n ... (troff)_____________________________________________________________________________________
.TC x - y print table of contents at end; x=no
suppresses title_____________________________________________________________________________________
.TE - y end of table processed by tbl
_____________________________________________________________________________________
.TH - y end multi-page header of table
_____________________________________________________________________________________
.TL - y title in boldface and two points larger
_____________________________________________________________________________________
.TM off n UC Berkeley thesis mode_____________________________________________________________________________________
.TS x - y,y begin table; if x=H table has multi-page
header_____________________________________________________________________________________
.UL x - n underline x, even in troff
_____________________________________________________________________________________
.UX x - n UNIX; trademark message first time; x
appended_____________________________________________________________________________________
.XA x y - y another index entry; x=page or no for
none; y=indent_____________________________________________________________________________________
SunOS 5.11 Last change: 25 Feb 1992 4
Standards, Environments, and Macros ms(5)
.XE - y end index entry (or series of .IX
entries)_____________________________________________________________________________________
.XP - y,y paragraph with first line indented, oth-
ers indented_____________________________________________________________________________________
.XS x y | - | y | begin index entry; x=page or no for
| | | none; y=indent__________|_______________|_______________|__________________________________________
.1C | on | y,y | one column format, on a new page__________|_______________|_______________|__________________________________________
.2C | - | y,y | begin two column format
__________|_______________|_______________|__________________________________________
.]- | - | n | beginning of refer reference
__________|_______________|_______________|__________________________________________
.[0 | - | n | end of unclassifiable type of reference
__________|_______________|_______________|__________________________________________
.[N | - | n | N= 1:journal-article, 2:book, 3:book-
| | | article, 4:report REGISTERSFormatting distances can be controlled in -ms by means of
built-in number registers. For example, this sets the line
length to 6.5 inches: .nr LL 6.5i Here is a table of number registers and their default values: Name Register Controls Takes Effect Default________________________________________________________________________
PS point size paragraph 10________________________________________________________________________
VS vertical spacing paragraph 12________________________________________________________________________
LL line length paragraph 6i________________________________________________________________________
LT title length next page same as LL________________________________________________________________________
FL footnote length next .FS 5.5i________________________________________________________________________
PD paragraph distance paragraph 1v (if n), .3v (if t)________________________________________________________________________
DD display distance displays 1v (if n), .5v (if t)________________________________________________________________________
PI paragraph indent paragraph 5nSunOS 5.11 Last change: 25 Feb 1992 5
Standards, Environments, and Macros ms(5)
________________________________________________________________________
QI quote indent next .QP 5n________________________________________________________________________
FI footnote indent next .FS 2n________________________________________________________________________
PO page offset next page 0 (if n), ~1i (if t)________________________________________________________________________
HM header margin next page 1i________________________________________________________________________
FM footer margin next page 1i________________________________________________________________________
FF footnote format next .FS 0 (1, 2, 3 available) | | | | | | | | | When res|etting these values|, make sure to |specify theappropri|ate units. Setting |the line length to |7, for exam-
ple, wil|l result in output wi|th one character pe|r line. Set-
ting FF|to 1 suppresses foot|note superscripting|; setting itto 2 als|o suppresses indentat|ion of the first li|ne; and set-
ting it |to 3 produces an .IP-|like footnote parag|raph.
| | | | | |Here is |a list of string regi|sters available in| -ms; they
may be u|sed anywhere in the t|ext: | | | | | | | | | | Nam|e |String's Function |________|_____________________|___________________|__________
\*Q | quote (" in |nroff, " in troff )|________|_____________________|___________________|__________
\*U | unquote (" i|n nroff, " in troff|)________|_____________________|___________________|__________
\*- | dash (-- in |nroff, - in troff )|
__________________________________________________________
\*(MO month (month of the year)__________________________________________________________
\*(DY day (current date)__________________________________________________________
\** automatically numbered footnote__________________________________________________________
\*' acute accent (before letter)__________________________________________________________
\*` grave accent (before letter)__________________________________________________________
\*^ circumflex (before letter)__________________________________________________________
\*, cedilla (before letter)__________________________________________________________
\*: umlaut (before letter)__________________________________________________________
SunOS 5.11 Last change: 25 Feb 1992 6
Standards, Environments, and Macros ms(5)
\*~ tilde (before letter) | | | When using the|extended accent mark definitions available with .AM, th|ese strings should come after, rather than before, the le|tter to be accented. | FILES | /usr/share/lib|/tmac/s | |/usr/share/lib|/tmac/ms.???
| |SEE ALSO |
col(1), eqn(1)|, nroff(1), refer(1), tbl(1), troff(1) |BUGS |
Floating keeps|and regular keeps are diverted to the same space, so th|ey cannot be mixed together with predictable results. | | | | | | |SunOS 5.11 Last change: 25 Feb 1992 7