ms(7)
Name
ms − text formatting macros
Syntax
nroff −ms [options] file ...
*roff −ms [options] file ...
Description
This package of nroff and *roff 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 motions are needed, filter the output through col(.). All external −ms macros are defined in the following section. Many nroff and *roff requests are unsafe in conjunction with this package. However, the first four requests in the list that follows can be used with impunity after initialization, and the last two may be used even before initialization:
.bpBegin new page
.brBreak output line
.sp nInsert n spacing lines
.ce nCenter next n lines
.ls nLine spacing: n=1 single, n=2 double space
.naNo alignment of right margin
Font and point size changes with \f and \s are also allowed; for example, \fIword\fR italicize word. Output of the tbl, *eqn, and refer() preprocessors for equations, tables, and references is acceptable as input.
Requests
MacroInitialBreak? Explanation
NameValueReset?
.AB x−yBegin abstract; if x=no, do not label abstract.
.AE−yEnd abstract.
.AI−yAuthor’s institution.
.AM−nBetter accent mark definitions.
.AU−yAuthor’s name.
.B x−nEmbolden x; if no x, switch to boldface.
.B1−yBegin text to be enclosed in a box.
.B2−yEnd boxed text and print it.
.BTdatenBottom title, printed at foot of page.
.BX x−nPrint word x in a box.
.CMif tnCut mark between pages.
.CT−y,yChapter title: page number moved to CF (TM only).
.DA xif nnForce date x at bottom of page; today if no x.
.DE−yEnd display (unfilled text) of any kind.
.DS x yIyBegin display with keep; x=I,L,C,B; y=indent .
.ID y8n,.5iyIndented display with no keep; y=indent.
.LD−yLeft display with no keep.
.CD−yCentered display with no keep.
.BD−yBlock display; center entire block.
.EF x−nEven page footer x (3 part, as for .tl).
.EH x−nEven page header x (3 part, as for .tl).
.EN−yEnd displayed equation produced by *eqn.
.EQ x y−yBreak out equation; x=L,I,C; y=equation number.
.FE−nEnd footnote to be placed at bottom of page.
.FP−nNumbered footnote paragraph; may be redefined.
.FS x−nStart footnote; x is optional footnote label.
.HDundefnOptional page header below header margin.
.I x−nItalicize x; if no x, switch to italics.
.IP x y−y,yIndented paragraph, with hanging tag x; y=indent.
.IX x y−yIndex words x, y and so on (up to five levels).
.KE−nEnd keep of any kind.
.KF−nBegin floating keep; text fills remainder of page.
.KS−yBegin keep; unit kept together on a single page.
.LG−nLarger; increase point size by 2.
.LP−y,yLeft (block) paragraph..
.MC x−y,yMultiple columns; x=column width.
.ND xif tnNo date in page footer; x is date on cover.
.NH x y−y,yNumbered header; x=level, x=0 resets, x=S sets to y.
.NL10pnSet point size back to normal.
.OF x−nOdd page footer x (3 part, as for .tl).
.OH x−nOdd page header x (3 part, as for .tl).
.P1if TMnPrint header on first page.
.PP−y,yParagraph with first line indented.
.PT- % -nPage title, printed at head of page.
.PX x−yPrint index (table of contents); x=no, suppresses title.
.QP−y,yQuote paragraph (indented and shorter).
.RonnReturn to Roman font.
.RE5ny,yRetreat: end level of relative indentation.
.RP x−nReleased paper format; x=no, stops title on first page.
.RS5ny,yRight shift: start level of relative indentation.
.SH−y,ySection header, in boldface.
.SM−nSmaller; decrease point size by two.
.TA8n,5nnSet tabs to 8n 16n ... (nroff) 5n 10n ... (*roff).
.TC x−yPrint table of contents at end; x=no, suppresses title.
.TE−yEnd of table processed by tbl.
.TH−yEnd multipage header of table.
.TL−yTitle in boldface and two points larger.
.TMoffnUC Berkeley thesis mode.
.TS x−y,yBegin table; if x=H, table has multipage header.
.UL x−nUnderline x, even in *roff.
.UX x−nUNIX; trademark message first time; x appended.
.XA x y−yAnother index entry; x=page or no for none; y=indent.
.XE−yEnd index entry (or series of .IX entries).
.XP−y,yParagraph with first line exdented, others indented.
.XS x y−yBegin index entry; x=page or no for none; y=indent.
.1Cony,yOne-column format, on a new page.
.2C−y,yBegin two-column format.
.]-−nBeginning of refer reference.
.[0−nEnd of unclassifiable type of reference.
.[N−nN= 1:journal-article, 2:book, 3:book-article, 4:report.
Registers
Formatting 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:
NameRegister ControlsTakes Effect Default
PSPoint size paragraph10
VSVertical spacingparagraph12
LLLine length paragraph6i
LTTitle length next pagesame as LL
FLFootnote length next .FS5.5i
PDParagraph distanceparagraph 1v (if n), .3v (if t)
DDDisplay distancedisplays1v (if n), .5v (if t)
PIParagraph indentparagraph5n
QIQuote indent next .QP5n
FIFootnote indent next .FS2n
POPage offset next page0 (if n), ∼1i (if t)
HMHeader margin next page1i
FMFooter margin next page1i
FFFootnote format next .FS0 (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 superscripting; 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:
NameString’s Function
\*QQuote (" in nroff, “ in *roff )
\*U Unquote (" in nroff, ” in *roff )
\*−Dash (-- in nroff, — in *roff )
\*(MOMonth (month of the year)
\*(DYDay (current date)
\**Automatically numbered footnote
\*´Acute accent (before letter)
\*`Grave accent (before letter)
\*^Circumflex (before letter)
\*,Cedilla (before letter)
\*:Umlaut (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
/usr/lib/tmac/tmac.s
/usr/lib/ms/s.???