Manual Page Result
0
Command: ms | Section: 5 | Source: Digital UNIX | File: ms.5.gz
ms(5) File Formats Manual ms(5)
NAME
ms - Text formatting macros
SYNOPSIS
nroff -ms [options] file...
DESCRIPTION
This package of nroff macro definitions provides a formatting facility
for various styles of articles, theses, and books. When producing
2-column output on a terminal or lineprinter, or when reverse line mo-
tions are needed, filter the output through col(1). All external -ms
macros are defined in the following section. Many nroff requests are
unsafe in conjunction with this package. However, the first four re-
quests in the list that follows can be used with impunity after ini-
tialization, and the last two may be used even before initialization:
Begin new page Break output line Insert n spacing lines Center next n
lines Line spacing: n=1 single, n=2 double space No alignment of right
margin
Font and point size changes with \f and \s are also allowed; for exam-
ple, \fIword\fR italicize word. Output of the tbl and neqn preproces-
sors for equations and tables ris acceptable as input.
REQUESTS
l lw(0.9i) l lw(2.6i). _ Macro Name T{ Initial Value
T} Break/Reset Explanation _ .AB x - y T{ Begin ab-
stract; if x =no, do not label abstract. T} .AE - y End ab-
stract. .AI - y Author's institution. .AM - n T{ Better
accent mark definitions. T} .AU - y Author's name. .B
x - n T{ Embolden x; if no x, switch to boldface. T}
.B1 - y T{ Begin text to be enclosed in a box. T}
.B2 - y T{ End boxed text and print it. T} .BT date n T{
Bottom title, printed at foot of page. T} .BX x - n T{ Print
word x in a box. T} .CM if t n Cut mark between pages.
.CT - y/y T{ Chapter title: page number moved to CF (TM only). T}
.DA x if n n T{ Force date x at bottom of page; today if no x. T}
.DE - y T{ End display (unfilled text) of any kind. T} .DS x
y I y T{ Begin display with keep; x =I,L,C,B; y =indent. T}
.ID y 8n,.5i y T{ Indented display with no keep; y =indent. T}
.LD - y Left display with no keep. .CD - y T{ Centered
display with no keep. T} .BD - y T{ Block display; center en-
tire block. T} .EF x - n T{ Even page footer x (3 part, as
for .tl). T} .EH x - n T{ Even page header x (3 part, as for
.tl). T} .EN - y T{ End displayed equation produced by *neqn.
T} .EQ x y - y T{ Break out equation; x =L,I,C; y =equation
number. T} .FE - n T{ End footnote to be placed at bottom of
page. T} .FP - n T{ Numbered footnote paragraph; may be rede-
fined. T} .FS x - n T{ Start footnote; x is optional foot-
note label. T} .HD undef n T{ Optional page header below
header margin. T} .I x - n T{ Italicize x; if no x, switch to
italics. T} .IP x y - y/y T{ Indented paragraph, with hanging
tag x; y= indent. T} .IX x y - y T{ Index words x, y and so on
(up to five levels). T} .KE - n End keep of any kind.
.KF - n T{ Begin floating keep; text fills remainder of page.
T} .KS - y T{ Begin keep; unit kept together on a single page.
T} .LG - n T{ Larger; increase point size by 2. T}
.LP - y/y Left (block) paragraph. .MC x - y/y T{ Mul-
tiple columns; x =column width. T} .ND x if t n T{ No date in
page footer; x is date on cover. T} .NH x y - y/y T{ Numbered
header; x =level, x =0 resets, x =S sets to y. T} .NL 10p n T{
Set point size back to normal. T} .OF x - n T{ Odd page
footer x (3 part, as for .tl). T} .OH x - n T{ Odd page
header x (3 part, as for .tl). T} .P1 if TM n T{ Print header
on first page. T} .PP - y/y T{ Paragraph with first line in-
dented. T} .PT - % - n T{ Page title, printed at head of page.
T} .PX x - y T{ Print index (table of contents); x =no, sup-
presses title. T} .QP - y/y T{ Quote paragraph (indented and
shorter). T} .R on n Return to Roman font. .RE 5n y/y T{
Retreat: end level of relative indentation. T} .RP x - n T{
Released paper format; x =no, stops title on first page. T}
.RS 5n y/y T{ Right shift: start level of relative indentation. T}
.SH - y/y T{ Section header, in bold-face. T} .SM - n T{
Smaller; decrease point size by 2. T} .TA 8n,5n n T{ Set tabs
to 8n 16n ... (nroff) 5n 10n ... (*roff). T} .TC x - y T{
Print table of contents at end; x =no, suppresses title. T}
.TE - y T{ End of table processed by tbl. T} .TH - y T{
End multipage header of table. T} .TL - y T{ Title in boldface
and two points larger. T} .TM off n UC Berkeley thesis mode. .TS
x - y/y T{ Begin table; if x =H, table has multipage header.
T} .UL x - n T{ Underline x, even in *roff. T} .UX
x - n T{ UNIX; trademark message first time; x appended. T}
.XA x y - y T{ Another index entry; x =page or no for none; y
=indent. T} .XE - y T{ End index entry (or series of .IX en-
tries). T} .XP - y/y T{ Paragraph with first line exdented, oth-
ers indented. T} .XS x y - y T{ Begin index entry; x =page or
no for none; y =indent. T} .1C on y/y T{ One-column format, on a
new page. T} .2C - y/y Begin two-column format.
.]- - n T{ Beginning of refer reference. T} .[0 - n T{
End of unclassifiable type of reference. T} .[N - n T{ N=
1:journal-article, 2:book, 3:book-article, 4:report. T} _
REGISTERS
Formatting distances can be controlled in -ms by means of built-in num-
ber 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:
l l l l. _ Register Name Controls Effects 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 para-
graph 1v (if n), .3v (if t) DD Display distance displays 1v (if
n), .5v (if t) PI Paragraph indent paragraph 5n QI Quote in-
dent 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 resetting these values, make sure to specify the appropriate
units. Setting the line length to 7, for example, results in output
with one character per line. Setting FF to 1 suppresses footnote super-
scripting; setting it to 2 also suppresses indentation of the first
line; and setting it to 3 produces an .IP-like footnote paragraph.
Here is a list of string registers available in -ms; they can be used
anywhere in the text:
l lw(6.3i). _ Name String's Function _ \*Q T{ Quote (" in nroff, " in
*roff ) T} \*U T{ Unquote (" in nroff, " in *roff ) T} \*- T{ Dash
(-- in nroff, -- in *roff ) T} \*(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) \*: Um-
laut (before letter) \*~ Tilde (before letter) _
When using the extended accent mark definitions available with .AM,
these strings should come after, rather than before, the letter to be
accented.
RESTRICTIONS
Floating keeps and regular keeps are diverted to the same space, so
they cannot be mixed together with predictable results.
FILES
The -ms macro package source file Files that are hardlinked to ???.s
files Supplemental -ms macros
SEE ALSO
col(1), neqn(1), nroff(1), tbl(1)
ms(5)