Digital PDFs

AA-LY19B-TE

June 1990

64 pages

Original

2.8MB

view download

OCR Version

2.5MB

view download

Document:	ULTRIX Reference Pages Section 7: Macro Packages and Conventions
Order Number:	AA-LY19B-TE
Revision:	0
Pages:	64
Original Filename:

OCR Text

ULTRIX

Reference Pages Section 7:
Macro Packages and Conventions

Order Number: AA-LY19B-TE
June 1990

Product Version:

ULTRIX Version 4.0 or higher

This manual contains miscellaneous information, including ASCII character codes, mail
addressing formats, text formatting macros, and a description of the root file system for both
RISC and VAX platforms.

digital equipment corporation

maynard, massachusetts

Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in
subparagraph (c) (1) (ii) of the Rights in Technical Data and Computer Software clause of DFARS 252.227-7013.

Portions of the information herein are derived from copyrighted material as permitted under license agreements with
AT&T and the Regents of the University of California. © AT&T 1979, 1984.

Portions of the information herein are derived from copyrighted material as permitted under a license agreement with
Sun MicroSystems, Inc. © Sun MicroSystems, Inc, 1985. All Rights Reserved.
Portions of this document © Massachusetts Institute of Technology, Cambridge, Massachusetts, 1984, 1985, 1986,

1988.
The information in this document is subject to change without notice and should not be construed as a commitment
by Digital Equipment Corporation. Digital Equipment Corporation assumes no responsibility for any errors that may

appear in this document.

The software described in this document is furnished under a license and may be used or copied only in accordance
with the terms of such license.

No responsibility is assumed for the use or reliability of software on equipment that is not supplied by Digital or its
affiliated companies.

The following are trademarks of Digital Equipment Corporation:

mn@nan

DECUS

ULTRIX Worksystem Software

DECwindows

UNIBUS

CDA

DTIF

VAX

DDIF

MASSBUS

VAXstation

DDIS

MicroVAX

VMS

DEC

Q-bus

VMS/ULTRIX Connection

ULTRIX

DECnet

DECstation

ULTRIX Mail Connection

XUI

POSIX is a registered trademark of the Institute of Electrical and Electronics Engineers.

System V is a registered trademark of AT&T.
UNIX is a registered trademark of AT&T in the USA and other countries.

About Reference Pages

The ULTRIX Reference Pages describe commands, system calls, routines, file
formats, and special files for RISC and VAX platforms.

Sections
The reference pages are divided into eight sections according to topic. Within each
section, the reference pages are organized alphabetically by title, except Section 3,
which is divided into subsections. Each section and most subsections have an
introductory reference page called int ro that describes the organization and
anything unique to that section.

Some reference pages carry a one- to three-letter suffix after the section number, for
example, scan(lmh). The suffix indicates that there is a ‘‘family’’ of reference
pages for that utility or feature. The Section 3 subsections all use suffixes and other
sections may also have suffixes.

Following are the sections that make up the ULTRIX Reference Pages.

Section

1: Commands
This section describes commands that are available to all ULTRIX users. Section 1 is
split between two binders. The first binder contains reference pages for titles that fall
between A and L. The second binder contains reference pages for titles that fall
between M and Z.

Section 2: System Calls
This section defines system calls (entries into the ULTRIX kernel) that are used by
all programmers. The introduction to Section 2, int ro(2), lists error numbers with
brief descriptions of their meanings. The introduction also defines many of the terms
used in this section.

Section 3: Routines
This section describes the routines available in ULTRIX libraries. Routines are
sometimes referred to as subroutines or functions.

Section 4: Special Files
This section describes special files, related device driver functions, databases, and
network support.

Section 5: File Formats
This section describes the format of system files and how the files are used. The files
described include assembler and link editor output, system accounting, and file
system formats.

Section 6: Games
The reference pages in this section describe the games that are available in the
unsupported software subset. The reference pages for games are in the document
Reference Pages for Unsupported Software.

Section 7: Macro Packages and Conventions
This section contains miscellaneous information, including ASCII character codes,

mail addressing formats, text formatting macros, and a description of the root file
system.

Section 8: Maintenance
This section describes commands for system operation and maintenance.

Platform Labels
The ULTRIX Reference Pages contain entries for both RISC and VAX platforms.
Pages that have no platform label beside the title apply to both platforms. Reference

pages that apply only to RISC platforms have a ‘‘RISC’’ label beside the title and the
VAX-only reference pages that apply only to VAX platforms are likewise labeled
with ““VAX.” If each platform has the same command, system call, routine, file
format, or special file, but functions differently on the different platforms, both
reference pages are included, with the RISC page first.

Reference Page Format
Each reference page follows the same general format. Common to all reference pages
is a title consisting of the name of a command or a descriptive title, followed by a

section number; for example, date(1). This title is used throughout the
documentation set.
The headings in each reference page provide specific information. The standard
headings are:
Name

Syntax

Provides the name of the entry and gives a short description.

Describes the command syntax or the routine definition. Section 5
reference pages do not use the Syntax heading.

Description

Provides a detailed description of the entry’s features, usage, and
syntax variations.

Options
Restrictions

Describes the command-line options.
Describes limitations or restrictions on the use of a command or
routine.

Examples

iv About Reference Pages

Provides examples of how a command or routine is used.

Return Values

Describes the values returned by a system call or routine. Used in
Sections 2 and 3 only.

Diagnostics
Files

Describes diagnostic and error messages that can appear.

Lists related files that are either a part of the command or used
during execution.

Environment

Describes the operation of the system call or routine when
compiled in the POSIX and SYSTEM V environments. If the
environment has no effect on the operation, this heading is not
used. Used in Sections 2 and 3 only.

See Also
mail(1), sendmail(8)

Crocker, D. H., Standard for the Format of Arpa Internet Text Messages, RFC822

Macro Packages and Conventions 7-15

man(7)

Name
man — the man macro package for online reference pages

Description
The man macro package is used to format reference manual pages for online viewing

or printing. The installed reference pages are formatted by the man(1) and the
catman(8) commands, using the man macro package.

The page size is 80 columns by 66 lines for nrof £ output and is 8.5" x 11" when
formatted with *t rof £ text formatters. Page numbers appear at the bottom of each

output page with odd page numbers appearing on the right side and even page
numbers appearing on the left side.

The format of the ULTRIX online reference pages is determined by the

man. repro(7) macro package.

The man macros are a compatible subset of the

man.repro macros.

Macros
The following describes the macros in the man macro package.
Any fext argument can range from zero to six words. Quotation marks (" ") can be
used to include blanks in words. If fext is not specified, special treatment is applied
to the next input line that has text to be printed. In this way, . I can be used to

italicize a whole line or . SM followed by . B to make small bold letters.

A prevailing indent distance is remembered between successive indented paragraphs,
and is reset to a default value upon reaching a nonindented paragraph. Default units
for indents 7 are ens (an en is 1 nroff character or 1/2 em space in current point
size).
Typeface and size are reset to default values before each paragraph, and after
processing font and size setting macros.
B [text...]

Sets text text in boldface. If no text is specified, the next text line is
set in boldface.

BI wordl word2 [ words... ]
Sets wordl in boldface, word?2 in an italic typeface, and then alternates
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

BR wordl word2 [ words... ]
Sets wordl in boldface, word2 in a roman typeface, and then alternates
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

7-16 Macro Packages and Conventions

man(7)
CT character

Prints the keyboard control character indicator <CTRL/character> . For
example, .CT A prints as <CTRL/A> .

Sets text in constant width font until another font change is found.

Ends an unfilled display block (started by .Ds). Also ends automatic
centering, if it was in effect.

Starts an unfilled display block. Text between .Ds and .De is
printed in a roman typeface, with ‘no fill’ mode (no wrapping and
blank lines allowed) in effect. The display block is set flush left.

Restores default tabs. Default tabs are set to .5 inches, starting with
Si, 14, ...

.EE

Ends an example and restores basic text defaults and indents.

EX[i]

Starts an example. Text between .EX and .EE is printed in a
constant width font with ‘no fill’ mode (no wrapping and blank lines
allowed) in effect. The example is set flush left unless an indent i is
specified. Units of i are ens.

G [ text... ]

Sets text in a sans-serif typeface. If no text is specified, the next text
line is set in a sans-serif typeface.

GL [ text... ] Sets fext in a sans-serif italic typeface. If no text is specified, the next

text line is set in a sans-serif italic typeface.

HB [ words... ]

Sets the text in underline mode or in a sans-serif bold typeface,
depending on the type of text formatter (nroff or troff). If the
text formatter is of type nroff, the next 999 input lines are formatted
in underline mode (nroff italic mode), or all the lines up to a font
change are formatted in underline mode, depending on which limit is
encountered first. If the text formatter is of type t rof £, text is set in
a sans-serif bold typeface until a font change is encountered. Up to
nine words can also be specified as arguments.

HP i

Jdf text... ]

Begins a paragraph with a hanging indent of i ens.

Sets text in an italic typeface. If no text is specified, the next text line
is set in an italic typeface.

J1 word

Sets a temporary indent to the length of the specified word.

J2 word

Reverses one line and then sets a temporary indent to the length of the
specified word.

JIB wordl word2 [ words... ]

Sets wordl in an italic typeface, word2 in boldface, and then alternates
between these two fonts for the remaining words, up to six words.

Blanks between words are stripped unless the string is enclosed in

quotation marks (" ").
xi
JP

Sets the prevailing indent to i. Then begins the indented paragraph
with a hanging tag given by the next text line. If the tag does not fit,
the macro places the next text on a separate line. Tag x appears in
bold typeface.

Macro Packages and Conventions 7—-17

man(7)
JR wordl word2 [ words... ]

Séts wordl in an italic typeface, word2 in a roman typeface, and then
alternates between these two fonts for the remaining words, up to six
words. Blanks between words are stripped unless the string is
enclosed in quotation marks (" ").

Same as the . PP macro. This macro is obsolete, but is provided for
backwards compatibility.

-MS reference_page section_subsection [ punctuation ]

Sets reference_page immediately followed by section_subsection in
parentheses followed by optional punctuation, using fonts that

distinguish this reference page reference from ordinary text. For
example, manua l(section).

.NE

Ends a note. Also cancels automatic centering if it was in effect.

NT [ headerl 1[ C ]
NT [ C ][ header2 ]

o
Starts a note. If no arguments are specified, the default header for the

note is ‘NOTE’. If the first argument is the letter ‘C’, all text in the
note is centered, for the next 99 text lines or until the .NE macro is

called, whichever comes first. If the first argument is not ‘C’, it
becomes the header of the note, even if header2 is also specified. The

header2 argument becomes the header of the note if the first argument

is ‘C’.

PD[v]

Sets the interparagraph distance to v vertical spaces. Resets the

distance to the default value if v is omitted.

PNx[y]

Setsxin an italic or constant width typeface (depending on the
*roff formatter type) and then reverts to the previous typeface. The
optional argument y is appended to x with no space, but printed in the

previous typeface. The x argument is usually a path name; y is usually
punctuation.

Pnxy[z]

Setsxin the current typeface, sets y in an italic or constant width
typeface (depending on the *rof
£ formatter type) and appends it to x,
and finally reverts to the previous typeface. The optional argument z is
appended to y, but printed in the previous typeface. Spaces are
removed between x, y, and z, unless quotation marks (" ") are used to

enclose strings with spaces. The x argument is usually a fixed path
name; y is usually a variable path name; and z is usually punctuation.
PP

Starts a block paragraph. Sets the prevailing indent to .5i for nroff
and four picas for *troff text formatters.

Sets the text in a roman typeface until another font change is
encountered. Also ends nrof £ uiinderline mode if it was in effect.

RB wordl word2 [ words... ]
Sets wordl in a roman typeface, word2 in boldface, and then alternates
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

RE [ k]

Returns to the kth relative right shift indent level. (Restores the left
margin to the position prior to the kth . RS call). Specifying k=0 is

7-18 Macro Packages and Conventions

man(7)
equivalent to specifying k=1. If k is omitted, .RE restores the left
margin to the most recent previous position. When k=1 or 0, the
default .RS indent increment is restored.

RI wordl word?2 [vwords... ]

Sets wordl in a roman typeface, word2 in an italic typeface, and then
alternates between these two fonts for the remaining words, up to six
words. Blanks between words are stripped unless the string is
enclosed in quotation marks (" ").

Prints the return character indicator, <RETURN> .

RS[i]

Shifts the left margin to the right (relatively) the amount of i ens. The
. RS macro calls can be nested up to nine levels. If i is not specified
for the first . RS call, the relative right shift increases .5 inch for
nroff, and four picas for *t rof £ text formatters. Nested .RS calls
increment the relative indent by i ens, or by .25 inch for nroff, or by
2 picas for *troff text formatters.

SH text

Creates a section header.

SM [ text ]

Sets text to be two points smaller than the current point size. If no
text is specified, the next text line is set in the smaller point size.

SS text

Creates a subsection header.

JTIB [ words... ]
Same as the . HB macro. This macro is is obsolete, but is provided for
backwards compatibility.
TJTHncls][ a 10f10x]
Begins a new reference page and sets the page title. Also sets up

headers and footers for output pages, sets up all defaults and traps, and
calls the .DT and . PD macros. The title appears as a header on all
pages of the formatted reference page. The n argument is the reference

page name. The ¢ argument is the primary section number or letter.
The s argument is the subsection, if any. The a argument is for an

optional machine architecture specific label; for example ““VAX’.

The f argument optionally alters a portion of the page footer. The x
argument is for optional extra commentary; for example
‘““Unsupported’’.

Fields n, c, and s appear together at the top of each output page (see
the top of this page for an example). These fields alternate between
the right top and left top of a page header, corresponding to odd and
even page numbers. Field a appears opposing the page name in the
header when formatted with nrof £, but appears as a bleed tab when
formatted with *troff text formatters. The f argument appears in
the page footer on the inside edge of the page (left for odd page
numbers, right for even). The x argument appears underneath the page
name in the header.

The last three fields are optional. To skip a field, specify a pair of
quotation marks ("") in the field to be skipped.
TP i

Sets the prevailing indent to i. Then begins the indented paragraph
with a hanging tag given by the next text line. If the tag does not fit,
the macro places the next text on a separate line.

Macro Packages and Conventions 7-19

man(7)
.YE

End a vertical margin bar.

VS[4]

Starts a vertical margin bar, if ‘4’ is specified; otherwise, the macro
does nothing.

Macros That Cause Line Breaks
The following macros cause line breaks:

ILP

EX
SH

HP
SS

1IP
TH

Macros That Need Text Lines
The following macros affect the following line of text if they are specified in the
input without arguments:
B

SM
Automatic hyphenation is turned on. However, last lines (ones that will cause a trap)
are not hyphenated and the last and first two characters of a word are not split off.

Characters printed from the Special Font are artificially bolded by three units
whenever the current font is ‘3’.
The default page size is 80 columns by 66 lines for nrof
£ output and 8.5" x 11" for
output generated by *troff text formatters. The text area is horizontally placed on
the page so that the effective page margin is .5 inches for nroff and 7.5 picas for

*troff text formatters.
The . TH macro sets up the following defaults:
e

Text is set in ‘‘noadjust’’ mode; the right margin is ragged.

The default interparagraph distance is 1v for nroff and .5v for *troff text

formatters.
*

The basic text indent is .5 inches for nroff and four picas for *trof f text

formatters, from the left margin.
®

The maximum text line length is 7 inches for nrof
f and 36 picas for *troff

text formatters.
e

Sets tab stops every .5 inches.

The basic text point size is 11 points, with line spacing set to 12 points.

The basic text font is ‘‘R’’ (a roman typeface).

Reference page headers, section headers, and subsection headers are set in a
sans-serif bold typeface.

Options
-nN

Numbers the first generated page as N.

-ril

Turns on line double-spacing mode.

7-20 Macro Packages and Conventions

man(7)
Restrictions
Predefined Registers
The following registers are predefined by the man macro package and should not be
changed:

Page offset and page margin

Left margin indent relative to the section headers

Line length including IN

Page length

The register ‘I’ is predefined when you specify the *roff —r1 option. Its default
value is 0. The man(1) command does not use this option.

Reserved Registers
The following registers are reserved for internal use by the man, man.nopage, and
man.repro macro packages:
DX

In addition, registers beginning with the characters ‘)’, ‘]’, and ‘}’ are also reserved
for internal use.

Registers predefined by the nrof£(1), tb1(1), commands, and the *egn and
*trof f text preprocessors and formatters should not be redefined.
Predefined Strings
The following strings are predefined by the man macro package and should not be
changed:

"if nroff, ‘“if *troff

"if nroff, ”’ if *troff

Command string to change type size to 10 points.

Reserved Strings and Macros
The following string and macro names are reserved for internal use by the man,
man .nopage, and man . repro macro packages:
#H#
DE
NX

Al
DS
P

BD
HH
UF

BK
1ID
vya

CD
LD
yn

D
NO
yl

In addition, names begining with the characters ‘)’, ‘]’, and ‘}’ are also reserved for
internal use.

Names predefined by the nrof£(1), tb1(1), commands, and the *egn and *troff
text preprocessors and formatters should not be redefined.

Macro Packages and Conventions 7—-21

man(7)
.TH Macro Restrictions
The section number should only be 1-8, ‘n’, ‘I’, ‘0’, or ‘p’. Other values might not
be recognized by the man(1) or catman(8) commands.
Sections 6, 7, ‘n’, ‘I’, ‘0’, and ‘p’ do not currently have subsections, so subsections
should not be specified.
The architecture field (a) should not exceed four characters. A value longer than four
characters might print outside the right page margin.
Reference pages containing *eqn commands should be preprocessed by an *negn
text preprocessor before being installed on the system.

Reference pages containing tb1(1) commands must not be preprocessed before being
installed on the system.

The Name Section
The catman(8) command assumes the Name section of a reference page has the

following format:
name[,

name,

name

...]

explanatory

text

There should be at least one space after any comma and only one space following the

“‘backslash hyphen’’ (\-). There should not be any *roff commands in the
explanatory text. The explanatory text should be brief. The catman(8) command

combines information in the Name section with parameters of the . TH macro to
create an entry in a database searched by the apropos(1), man(1), and whatis(1)
commands.

Portability Considerations
The ULTRIX man macro packages contain extensions and enhancements borrowed
from other macro packages. If you have a need to write portable reference pages,

you should not use the following macros:
CT

I
PN

I2
Pn

HB
NE

HP
NT

The LP and TB macros are obsolete.
The ULTRIX man . TH macro differs from other implemenations of the . TH macro.
The primary differences are in the placement of the page title, and third and fifth

fields in the *rof f output. The page title (the page name and section number) is
commonly placed on both sides of the page header in other implementations. The
more common placement of the third field is in the center of the page footer. The
more common placement of the fifth field is in the center of the page header.

Use of the tb1(1) and *eqgn commands should be avoided, because the version of
the man(1) command in some other implementations might not preprocess reference
pages through the tb1(1) command. The *egn commands also might not be
installed.

7-22 Macro Packages and Conventions

man(7)

Files
/usr/lib/tmac/tmac.an

The man macro package file

See Also
col(1), man(1), nroff(1), tbl(1), man.nopage(7), man.repro(7), catman(8)

Macro Packages and Conventions 7—-23

man.nopage(7)

Name
man.nopage — the man.nopage macro package for printing reference pages

Syntax
tbl file... | nroff [ -nN ][ —=rpS ] [ -rl1 ] -man.nopage | col | ...

tbl file... | *troff [ -nN ][ —rpS ][ -rl1 ] —-man.nopage| ...

Description
The man.nopage macro package is used to format reference manual pages for
unpaginated viewing or for printing on line printers. The installed reference pages
are formatted by the man(1) and the catman(8) commands, using the man macro
package.
The page width is 80 columns when formatted by the nrof £(1) command and is 8.5
inches when formatted with *troff text formatters. The output is unpaginated
when formatted by the nrof f command, hence the name ‘nopage’. The output is
paginated when formatted by *t roff text formatters, with page numbers appearing
at the bottom of each output page with odd page numbers appearing on the right side

and even page numbers appearing on the left side. The *troff output is similar to
the output generated with the man . repro(7) macro package.

The format of the ULTRIX online reference pages is determined by the
man . repro(7) macro package. The man.nopage macros are a compatible subset

of the man . repro macros.

Macros
The following describes the macros in the man macro package.

Any text argument can range from zero to six words. Quotation marks ("
") can be
used to include blanks in words. If text is not specified, special treatment is applied
to the next input line that has text to be printed. In this way, . I can be used to
italicize a whole line or . SM followed by . B to make small bold letters.
"non

A prevailing indent distance is remembered between successive indented paragraphs,
and is reset to a default value upon reaching a nonindented paragraph. Default units

for indents i are ens (an en is 1 nrof
f character or 1/2 em space in current point
size).
Typeface and size are reset to default values before each paragraph, and after
processing font and size setting macros.
B [ text... ]

Sets text text in boldface. If no text is specified, the next text line is
set in boldface.

Bl wordl word2 [ words... ]
Sets wordl in boldface, word2 in an italic typeface, and then alternates

between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

BR wordl word2 [ words... ]
Sets wordl in boldface, word2 in a roman typeface, and then alternates

7-24 Macro Packages and Conventions

man.nopage (7)
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

.CT character
Prints the keyboard control character indicator < CTRL/character> . For
example, .CT A prints as <CTRL/A> .

Sets text in a constant width font until another font change is
encountered.

Ends an unfilled display block (started by .Ds). Also ends automatic
centering, if it was in effect.

Starts an unfilled display block. Text between .Ds and .De is

printed in a roman typeface, with ‘no fill’ mode (no wrapping and
blank lines allowed) in effect. The display block is set flush left.
Restores default tabs. Default tabs are set to .5 inches, starting with
Si, 14, ... .

.EE

Ends an example and restores basic text defaults and indents.

EX[i]

.G [ text...]

Sets text in a sans-serif typeface. If no text is specified, the next text
line is set in a sans-serif typeface.

.GL [ text... ] Sets text in a sans-serif italic typeface. If no text is specified, the next
text line is set in a sans-serif italic typeface.

HB [ words... ]
Sets the text in underline mode or in a sans-serif bold typeface,
depending on the type of text formatter (nroff or troff). If the

text formatter is of type nrof £, the next 999 input lines are formatted
in underline mode (nrof £ italic mode), or all the lines up to a font
change are formatted in underline mode, depending on which limit is
encountered first. If the text formatter is of type t rof £, text is set in
a sans-serif bold typeface until a font change is encountered. Up to
nine words can also be specified as arguments.
HP i

Begins a paragraph with a hanging indent of i ens.

J[text...]

Sets text in an italic typeface. If no text is specified, the next text line
is set in an italic typeface.

J1 word

Sets a temporary indent to the length of the specified word.

J2 word

Reverses one line and then sets a temporary indent to the length of the
specified word.

B wordl word2 [ words... ]

Sets wordl in an italic typeface, word2 in boldface, and then alternates
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

Macro Packages and Conventions 7—-25

man.nopage (7)
JIP xi

bold typeface.

JR wordl word2 [ words... ]
Sets word! in an italic typeface, word2 in a roman typeface, and then
alternates between these two fonts for the remaining words, up to six

words. Blanks between words are stripped unless the string is
enclosed in quotation marks (" ").
.LP

Same as the .PP macro. This macro is obsolete, but is provided for
backwards compatibility.

MS reference_page section_subsection [ punctuation ]
Sets reference_page immediately followed by section_subsection in
parentheses followed by optional punctuation, using fonts that
distinguish this reference page reference from ordinary text. For
example, manual(section).
NE

Ends a note. Also cancels automatic centering if it was in effect.

NT [ headerl

1[ C ]
NT [ C ][ header2 ]
Starts a note. If no arguments are specified, the default header for the

note is ‘NOTE’. If the first argument is the letter ‘C’, all text in the
note is centered, for the next 99 text lines or until the . NE macro is
called, whichever comes first. If the first argument is not ‘C’, it
becomes the header of the note, even if header? is also specified. The
header?2 argument becomes the header of the note if the first argument

is ‘C’.
PDv]

Sets the interparagraph distance to v vertical spaces. Resets the

distance to the default value if v is omitted.
PNx[y]

Setsxin an italic or constant width typeface (depending on the

*roff formatter type) and then reverts
to the previous typeface. The
optional argument y is appended to x with no space, but printed in the
previous typeface. The x argument is usually a path name; y is usually

punctuation.
Pnxy[z]

Setsxin the current typeface, sets y in an italic or constant width
typeface (depending on the *roff formatter type) and appends it to x,
and finally reverts to the previous typeface. The optional argument z is
appended to y, but printed in the previous typeface.

Spaces are

removed between x, y, and z, unless quotation marks (" ") are used to

enclose strings with spaces. The x argument is usually a fixed path
name; y is usually a variable path name; and z is usually punctuation.
PP

Starts a block paragraph. Sets the prevailing indent to .5i for nrof
£
and four picas for *troff text formatters.

Sets the text in a roman typeface until another font change is
encountered. Also ends nroff underline mode if it was in effect.

RB wordl word2 [ words... ]
,
Sets wordl in a roman typeface, word2 in boldface, and then alternates
between these two fonts for the remaining words, up to six words.

7-26 Macro Packages and Conventions

man.nopage (7)
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

RE[ k]

Returns to the kth relative right shift indent level. (Restores the left
margin to the position prior to the kth . RS call). Specifying k=0 is

equivalent to specifying k=1. If k is omitted, . RE restores the left
margin to the most recent previous position. When k=1 or 0, the

default . RS indent increment is restored.
RI wordl word?2 | words... ]

enclosed in quotation marks (" ").
RN

Prints the return character indicator, <RETURN> .

RS[i]

Shifts the left margin to the right (relatively) the amount of i ens. The
.RS macro calls can be nested up to nine levels. If i is not specified
for the first . RS call, the relative right shift increases .5 inch for
nroff and four picas for *troff text formatters. Nested . RS calls
increment the relative indent by i ens, or by .25 inch for nrof £, or by
2 picas for *troff text formatters.

SH text

Creates a section header.

SM [ text]

Sets text to be two points smaller than the current point size. If no
text is specified, the next text line is set in the smaller point size.

SS text

Creates a subsection header..

JIB [ words... ]

Same as the . HB macro. This macro is is obsolete, but is provided for
backwards compatibility.

THnclsl[allf1lx]

Begins a new reference page and sets the page title. Also sets up
headers and footers for output pages, sets up all defaults and traps, and
calls the .DT and .PD macros. The title appears as a header on all

pages of the formatted reference page. The n argument is the reference
page name. The ¢ argument is the primary section number or letter.
The s argument is the subsection, if any. The a argument is for an
optional machine architecture specific label; for example ““VAX”’.
The f argument optionally alters a portion of the page footer. The x
argument is for optional extra commentary; for example
‘““Unsupported’’.

Fields n, ¢, and s appear together at the top of each output page (see

header when formatted with nrof £, but appears as a bleed tab when
formatted with *trof f text formatters. The f argument appears in
the page footer on the inside edge of the page (left for odd page

numbers, right for even). The x argument appears underneath the page

name in the header.

Macro Packages and Conventions 7-27

man.nopage (7)
The last three fields are optional. To skip a field, specify a pair of
quotation marks ("") in the field to be skipped.

TP i

Sets the prevailing indent to i. Then begins the indented paragraph
with a hanging tag given by the next text line. If the tag does not fit,

the macro places the next text on a separate line.

.YE

End a vertical margin bar.

VS[4]

Starts a vertical margin bar, if ‘4’ is specified; otherwise, the macro

does nothing,.

Macros That Cause Line Breaks
The following macros cause line breaks:

1IP

ILP

Macros That Need Text Lines
The following macros affect the following line of text if they are specified in the
input without arguments:
B

I
SS

Automatic hyphenation is turned on. However, last lines (ones that will cause a trap)
are not hyphenated and the last and first two characters of a word are not split off.

Characters printed from the Special Font are artificially bolded by three units
whenever the current font is ‘3°.
The default page width is 80 columns nrof £ output and 8.5 inches for output
generated by *trof f text formatters. The text area is horizontally placed on the
page so that the effective page margin is .5 inches for nroff and 7.5 picas for
*troff text formatters.

The default page length is unlimited (unpaginated) for nerof £ output, but is 11
inches for output generated by *t rof £ text formatters.
The . TH macro sets up the following defaults:
®

Text is set in ‘‘noadjust’” mode; the right margin is ragged.

The default interparagraph distance is 1v for nroff and .5v for *troff text

formatters.
®

The basic text indent is .5 inches for nrof
£ and four picas for *troff text

formatters, from the left margin.
¢

The maximum text line length is 7 inches for nroff and 36 picas for *troff

text formatters.
e

Sets tab stops every .5 inches.

The basic text point size is 11 points, with line spacing set to 12 points.

The basic text font is ‘‘R’’ (a roman typeface).

Reference page headers, section headers, and subsection headers are set in a

sans-serif bold typeface.
7-28 Macro Packages and Conventions

man.nopage (7)

The default section number, which apepras like a ‘‘chapter’’ number in page footers

is O for *trof £ output. There are no page footers for nrof £ output.

Options
-nN

Numbers the first generated page as N.

-ril

Turns on line double-spacing mode.

Sets the section number fo S. Section numbers appear in output page

-rpS

footers as S—N (chapter—page-number).

Restrictions
Predefined Registers
The following registers are predefined by the man macro package and should not be
changed:

Page offset and page margin

Left margin indent relative to the section headers

Line length including IN

Page length

The register ‘I’ is predefined when you specify the *roff —r1 option. Its default
value is 0. The man(1) command does not use this option.

The register ‘p’ is predefined when you specify the *roff —rp option. Its default
value is 0. The man(1) command does not use this option.

Reserved Registers
The following registers are reserved for internal use by the man, man.nopage, and
man.repro macro packages:

In addition, registers beginning with the characters ‘)’, ‘I’, and ‘}’ are also reserved
for internal use.

Registers predefined by the nrof£(1), tb1(1), commands, and the *egn and
*trof f text preprocessors and formatters should not be redefined.

Predefined Strings

The following strings are predefined by the man macro package and should not be
changed:

"if nroff, ‘“if *troff

"if nroff, ” if *troff

Command string to change type size to 10 points.

Macro Packages and Conventions 7—-29

man.nopage(7)

Reserved Strings and Macros
The following string and macro names are reserved for internal use by the man,

man.nopage, and man . repro macro packages:

DE
NX

In addition, names begining with the characters ‘)’, ], and ‘}” are also reserved for
internal use.

Names predefined by the nrof£(1), tb1(1), commands, and the *eqgn and *troff

text preprocessors and formatters should not be redefined.

.TH Macro Restrictions
The section number should only be 1-8, ‘n’, ‘I’, ‘0’, or ‘p’. Other values might not
be recognized by the man(1) or catman(8) commands.

Sections 6, 7, ‘n’, ‘I, ‘0’, and ‘p’ do not currently have subsections, so subsections
should not be specified.

The architecture field (a) should not exceed four characters. A value longer than four
characters might print outside the right page margin.
Reference pages containing *eqn commands should be preprocessed by an *neqgn
text preprocessor before being installed on the system.

Reference pages containing tb1(1) commands must not be preprocessed before being
installed on the system.

The Name Section
The catman(8) command assumes the Name section of a reference page has the

following format:
name[,

name,

name

...]

explanatory

text

There should be at least one space after any comma and only one space following the
“‘backslash hyphen’’ (\-). There should not be any *roff commands in the
explanatory text. The explanatory text should be brief. The catman(8) command

combines information in the Name section with parameters of the . TH macro to
create an entry in a database searched by the apropos(1), man(1), and whatis(l)
commands.

Portability Considerations
The ULTRIX man macro packages contain extensions and enhancements borrowed
from other macro packages. If you have a need to write portable reference pages,
you should not use the following macros:

G
LP
R

CW
GL

De
HB

Ds
HP

EE
I

EX
12

7-30 Macro Packages and Conventions

man.nopage(7)
The LP and TB macros are obsolete.

The ULTRIX man . TH macro differs from other implemenations of the . TH macro.
The primary differences are in the placement of the page title, and third and fifth
fields in the *roff output. The page title (the page name and section number) is
commonly placed on both sides of the page header in other implementations. The
more common placement of the third field is in the center of the page footer. The
more common placement of the fifth field is in the center of the page header.

Use of the tb1(1) and *eqn commands should be avoided, because the version of
the man(1) command in some other implementations might not preprocess reference
pages through the tb1(1) command. The *eqgn commands also might not be
installed.

Files
/usr/lib/tmac/tmac.an.nopage
The man . nopage macro package file

See Also
col(1), man(1), nroff(1), tbl(1), man(7), man.repro(7), catman(8)

Macro Packages and Conventions 7-31

man.repro(7)

Name
man.repro — the man.repro macro package for typesetting reference pages

Syntax
tbl file... | nroff [ -nN ][ —rpS 1[ -rl1 ] -man.repro | col | ...

tbl file... | *troff [ -nN ] [ =rpS ][ -rl1 ] -man.repro | ...

Description
The man . repro macro package is used to format reference manual pages for

printing or typsetting.

This reference page was formatted by a *trof f text
formatter, using the man . repro macro package. nroff(1) command, using the

man.repro macro package, or was formatted by the man(1) and the catman(8)

commands, using the man macro package.

The page size is 80 columns by 66 lines for nroff output and is 8.5" x 11" when
formatted with *troff text formatters. Page numbers appear at the bottom of each

output page with odd page numbers appearing on the right side and even page
numbers appearing on the left side. Page footers can optionally include the name of

the reference page section.

The format of the ULTRIX online reference pages is determined by the man . repro

macro package.

Macros
The following describes the macros in the man . repro macro package.
Any text argument can range from zero to six words.

Quotation marks (" ") can be

used to include blanks in words. If fext is not specified, special treatment is applied
to the next input line that has text to be printed. In this way, . I can be used to

italicize a whole line or . SM followed by .B to make small bold letters.
A prevailing indent distance is remembered between successive indented paragraphs,
and is reset to a default value upon reaching a nonindented paragraph. Default units
for indents i are ens (an en is 1 nroff character or 1/2 em space in current point

size).

Typeface and size are reset to default values before each paragraph, and after
processing font and size setting macros.

B [rext...]

Sets text text in boldface. If no text is specified, the next text line is
set in boldface.

BI wordl word2 [ words... ]

Sets wordl in boldface, word? in an italic typeface, and then alternates
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in

quotation marks (" ").

BR wordl word2 [ words... ]

Sets wordl in boldface, word?2 in a roman typeface, and then alternates
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").

7-32 Macro Packages and Conventions

man.repro(7)
.CT character
Prints the keyboard control character indicator < CTRL/character> . For
example, .CT A prints as <CTRL/A> .

Sets text in a constant width font until another font change is
encountered.

Ends an unfilled display block (started by .Ds). Also ends automatic
centering, if it was in effect.

.Ds

Restores default tabs. Default tabs are set to .5 inches, starting with
Si, 14, ... .

.EE

Ends an example and restores basic text defaults and indents.

EXT[i]

Starts an example. Text between . EX and .EE is printed in a
constant width font with ‘no fill’ mode (no wrapping and blank lines
allowed) in effect. The example is set flush left unless an indent i is
specified. Units of i are ens.

rext..]

Sets text in a sans-serif typeface. If no text is specified, the next text
line is set in a sans-serif typeface.

.GL [ text... ] Sets text in a sans-serif italic typeface. If no text is specified, the next
text line is set in a sans-serif italic typeface.
HB [ words... ]
Sets the text in underline mode or in a sans-serif bold typeface,
depending on the type of text formatter (nroff or troff). If the

text formatter is of type nrof £, the next 999 input lines are formatted
in underline mode (nroff italic mode), or all the lines up to a font
change are formatted in underline mode, depending on which limit is
encountered first. If the text formatter is of type t rof £, text is set in
a sans-serif bold typeface until a font change is encountered. Up to
nine words can also be specified as arguments.

HP |

Begins a paragraph with a hanging indent of i ens.

J[text..]

Sets text in an italic typeface. If no text is specified, the next text line
is set in an italic typeface.

J1 word

Sets a temporary indent to the length of the specified word.

J2 word

Reverses one line and then sets a temporary indent to the length of the
specified word.

JIB wordl word2 [ words... ]

Sets wordl in an italic typeface, word2 in boldface, and then alternates

between these two fonts for the remaining words, up to six words.

Blanks between words are stripped unless the string is enclosed in

quotation marks (" ").

JP xi

Macro Packages and Conventions 7-33

man.repro(7)
AR wordl word2 [ words... ]

Sets wordl in an italic typeface, word2 in a roman typeface, and then
alternates between these two fonts for the remaining words, up to six
words. Blanks between words are stripped unless the string is
enclosed in quotation marks (" ").
|

Same as the . PP macro. This macro is obsolete, but is provided for
backwards compatibility.

-MS reference_page section_subsection [ punctuation |

Sets reference_page immediately followed by section_subsection in
parentheses followed by optional punctuation, using fonts that
distinguish this reference page reference from ordinary text. For
example, manual(section).

.NE

Ends a note. Also cancels automatic centering if it was in effect.

NT [ header! ][ C ]
NT [ C ][ header2 ]

Starts a note. If no arguments are specified, the default header for the
note is ‘NOTE’. If the first argument is the letter ‘C’, all text in the
note is centered, for the next 99 text lines or until the . NE macro is
called, whichever comes first. If the first argument is not ‘C’, it
becomes the header of the note, even if header2 is also specified. The
header2 argument becomes the header of the note if the first argument
is ‘C’.
PD[v]

Sets the interparagraph distance to v vertical spaces. Resets the
distance to the default value if v is omitted.

PNx[y]

Setsxin an italic or constant width typeface (depending on the
*rof £ formatter type) and then reverts to the previous typeface. The
optional argument y is appended to x with no space, but printed in the

previous typeface. The x argument is usually a path name; y is usually
punctuation.

Pnxy[z]

Setsxinthe current typeface, sets y in an italic or constant width
typeface (depending on the *rof f formatter type) and appends it to x,
and finally reverts to the previous typeface. The optional argument z is
appended to y, but printed in the previous typeface. Spaces are
removed between x, y, and z, unless quotation marks (" ") are used to

enclose strings with spaces. The x argument is usually a fixed path
name; y is usually a variable path name; and z is usually punctuation.

Starts a block paragraph. Sets the prevailing indent to .51 for nroff

and four picas for *troff text formatters.
R

Sets the text in a roman typeface until another font change is
encountered. Also ends nroff underline mode if it was in effect.

RE[ k]

Returns to the kth relative right shift indent level. (Restores the left
margin to the position prior to the kth .RS call). Specifying k=0 is

7-34 Macro Packages and Conventions

man.repro(7)
equivalent to specifying k=1. If k is omitted, . RE restores the left
margin to the most recent previous position. When k=1 or 0, the
default . RS indent increment is restored.
RI wordl word2 [ words... ]
Sets wordl in a roman typeface, word2 in an italic typeface, and then
alternates between these two fonts for the remaining words, up to six
words. Blanks between words are stripped unless the string is
enclosed in quotation marks (" ").

Prints the return character indicator, <RETURN
> .

RS[i]

Shifts the left margin to the right (relatively) the amount of i ens. The
. RS macro calls can be nested up to nine levels. If i is not specified
for the first . RS call, the relative right shift increases .5 inch for
nroff and four picas for *troff text formatters. Nested .RS calls
increment the relative indent by i ens, or by .25 inch for nrof £, or by
2 picas for *troff text formatters.

SH text

Creates a section header.

SM [ text ]

Sets text to be two points smaller than the current point size. If no
text is specified, the next text line is set in the smaller point size.

SS rext

Creates a subsection header.

TB [ words... ]

Same as the . HB macro. This macro is is obsolete, but is provided for

backwards compatibility.
JTHncls][a 10f10x]
Begins a new reference page and sets the page title. Also sets up
headers and footers for output pages, sets up all defaults and traps, and
calls the .DT and .PD macros. The title appears as a header on all
pages of the formatted reference page. The n argument is the reference
page name. The ¢ argument is the primary section number or letter.
The s argument is the subsection, if any. The a argument is for an
optional machine architecture specific label; for example ““VAX"’.
The f argument optionally alters a portion of the page footer. The x
argument is for optional extra commentary; for example
‘““Unsupported’’.
Fields n, ¢, and s appear together at the top of each output page (see

the top of this page for an example). These fields alternate between
the right top and left top of a page header, corresponding to odd and
even page numbers. Field a appears opposing the page name in the
header when formatted with nrof
£, but appears as a bleed tab when
formatted with *troff text formatters. The f argument appears in
the page footer on the inside edge of the page (left for odd page
numbers, right for even). The x argument appears underneath the page
name in the header.

The last three fields are optional. To skip a field, specify a pair of
quotation marks ("") in the field to be skipped.
TP i

Sets the prevailing indent to i. Then begins the indented paragraph
with a hanging tag given by the next text line. If the tag does not fit,
the macro places the next text on a separate line.

Macro Packages and Conventions 7—-35

man.repro(7)
UF footer ~ Replaces the section name (adjacent to the ‘chapter-page_number’ pair
in the page footer), defined by the —rpS option, with the text footer.
This macro must not be called before the . TH macro.

.VE

End a vertical margin bar.

VS[4]

Starts a vertical margin bar, if ‘4’ is specified; otherwise, the macro
does nothing.

Macros That Cause Line Breaks
The following macros cause line breaks:

1IP

ILP

Macros That Need Text Lines
The following macros affect the following line of text if they are specified in the

input without arguments:
B

. RI

Automatic hyphenation is turned off.

Characters printed from the Special Font are artificially bolded by three units
whenever the current font is ‘3’.
The default page size is 80 columns by 66 lines for nrof f output and 8.5" x 11" for

output generated by *troff text formatters. The text area is horizontally placed on
the page so that the effective page margin is .5 inches for nroff and 7.5 picas for

*troff text formatters.
The . TH macro sets up the following defaults:
*
*

Text is set in ‘‘noadjust’’ mode; the right margin is ragged.
The default interparagraph distance is 1v for nroff and .5v for *troff text

formatters.
*

The basic text indent is .5 inches for nrof £ and four picas for *t rof £ text

formatters, from the left margin.
®

The maximum text line length is 7 inches for nroff and 36 picas for *troff

text formatters.

Sets tab stops every .5 inches.

The basic text point size is 11 points, with line spacing set to 12 points.

The basic text font is ‘‘R’’ (a roman typeface).

Reference page headers, section headers, and subsection headers are set in a
sans-serif bold typeface.

7-36 Macro Packages and Conventions

man.repro(7)

Options
-nN

Numbers the first generated page as N.

-rll

Turns on line double-spacing mode.

-rpS

Sets the section number to S. The section number determines if the
name of a section will appear in the page footer. If the value of S is 0,
no name appears in the page footer. When § is specified, that number
determines the name that will appear in the footer. The section
number appears in output page footers as S—N (chapter—page-number).
If S is not O, the name of the section appears on the inside of the page
footer, adjacent to the chapter—page-number sequence.

Restrictions
Predefined Registers
The following registers are predefined by the man macro package and should not be
changed:
PO

Page offset and page margin

Left margin indent relative to the section headers

Line length including IN

Page length

The register ‘1’ is predefined when you specify the *roff ~r1 option. Its default
value is 0. The man(1) command does not use this option.
The register ‘p’ is predefined when you specify the *roff —rp option. Its default
value is 0. The man(1) command does not use this option.
The register ‘p’ should be set to a range 1-8 or 11-18 for unsupported reference
pages. It cannot be set to values ‘I’, ‘n’, ‘0’, or ‘p’.
b

Reserved Registers
The following registers are reserved for internal use by the man, man.nopage, and
man .repro macro packages:
Al

In addition, registers beginning with the characters ‘)’, ‘]’, and °}’ are also reserved
for internal use.

Registers predefined by the nrof £(1), tb1(1), commands, and the *egn and
*troff text preprocessors and formatters should not be redefined.

Predefined Strings
The following strings are predefined by the man macro package and should not be
changed:

"if nroff, ‘“if *troff

"if nroff, 7’ if *troff

Macro Packages and Conventions 7-37

man.repro(7)
S

Command string to change type size to 10 points.

Reserved Strings and Macros
The following string and macro names are reserved for internal use by the man,

man.nopage, and man. repro macro packages:

In addition, names begining with the characters *)’, ‘]’, and *}’

internal use.

are also reserved for

Names predefined by the nrof£(1), tb1(1), commands, and the *eqn and *troff
text preprocessors and formatters should not be redefined.

.TH Macro Restrictions
The section number should only be 1-8, ‘n’, ‘I’, ‘0, or ‘p’. Other values might not
be recognized by the man(1) or catman(8) commands.

Sections 6, 7, ‘n’, ‘I, ‘0’, and ‘p’ do not currently have subsections, so subsections
should not be specified.
The architecture field (a) should not exceed four characters. A value longer than four
characters might print outside the right page margin.

Reference pages containing *eqn commands should be preprocessed by an *neqn
text preprocessor before being installed on the system.

Reference pages containing tb1(1) commands must not be preprocessed before being
installed on the system.

The Name Section
The catman(8) command assumes the Name section of a reference page has the
following format:
name[,

name,

name

...]

explanatory

text

There should be at least one space after any comma and only one space following the

‘‘backslash hyphen’’ (\-). There should not be any *roff commands in the
explanatory text. The explanatory text should be brief. The catman(8) command
combines information in the Name section with parameters of the . TH macro to

create an entry in a database searched by the apropos(1), man(l), and what is(1)
commands.

Portability Considerations
The ULTRIX man macro packages contain extensions and enhancements borrowed

from other macro packages. If you have a need to write portable reference pages,

you should not use the following macros:

CT
G
LP
R

CW
GL
MS

De
HB
NE

Ds
HP
NT

7-38 Macro Packages and Conventions

EE
I
PN

EX
I2
Pn

man.repro(7)
The LP and TB macros are obsolete.

The ULTRIX man . TH macro differs from other implemenations of the . TH macro.
The primary differences are in the placement of the page title, and third and fifth
fields in the *rof £ output. The page title (the page name and section number) is
commonly placed on both sides of the page header in other implementations. The
more common placement of the third field is in the center of the page footer. The
more common placement of the fifth field is in the center of the page header.

Use of the tb1(1) and *eqn commands should be avoided, because the version of

the man(1) command in some other implementations might not preprocess reference
pages through the tb1(1) command. The *eqgn commands also might not be
installed.

Examples
The following example processes this manual page for a character-cell device:
$ cd /usr/man/man?
% tbl man.repro.7 |

nroff -rp7

-n39 -man.repro

col

lpr -Plp

In this example, the —rp7 option for nrof £ initializes number register p to specify
that this page is from Section 7 of the Reference Pages. The —n39 option specifies a
starting page number of 39. The first page printed is numbered ‘7-39’.

Files

/usr/lib/tmac/tmac.an.repro The man.repro macro package file

See Also
col(1), man(1), nroff(1), tbl(1), man(7), man.nopage(7), catman(8)

Macro Packages and Conventions 7~39

me(7)

Name
me — macros for formatting papers

Syntax
nroff —me [ options 1 file ...

*roff —-me [ options ] file ...

Description
This package of nroff and *roff macro definitions provides a formatting facility
for technical papers in various formats. When producing 2-column output on a
terminal, filter the output through co1(1).
Many nroff and *roff requests are unsafe in conjunction with this package;
however, these requests can be used with impunity after the first .pp:

.bp

Begin new page

Break output line here

Spn

Insert n spacing lines

Isn

Line spacing: n=1 single, n=2 double space

.na

No alignment of right margin

.cen

Center next n lines
Underline next n lines

aln

.8z +n Add n to point size

Output of the eqn, neqn, refer, and tbl preprocessors for equations and tables is
acceptable as input.

Requests
In the following list, ‘‘initialization’’ refers to the first .pp, .Ip, .ip, .np, .sh, or .uh
macro. This list is incomplete; see the —me Reference Manual, ULTRIX

Supplementary Documents Vol. I. General User, for further details.
Request

Initial Cause Explanation

Value Break
yes
Begin block.

yes

Begin centered block.

Begin delayed text.

Begin footnote.

yes

Begin list.

q
(X x

yes
no

Begin major quote.
Begin indexed item in index. x

Begin floating keep.

yes

End block.

.J)c

yes

End centered block.

yes

End delayed text.

yes

End footnote.

yes

End list.

yes

End major quote.

X
JZ

yes
yes

End index item.
End floating keep.

7-40 Macro Packages and Conventions

me(7)
++mH

Define paper section. m defines the part of the paper, and can be C

(chapter), A (appendix), P (preliminary; for example, an abstract, table

of contents, and so on), B (bibliography), RC (chapters renumbered

from page one each chapter), or RA (appendix renumbered from page

Jdc
2C
.EN

| Iy
S
|

one).
A4c T

yes

yes
yes
yes

Begin chapter (or appendix, etc., as set by .++). T is the chapter title.
One-column format on a new page.
Two-column format.
Space after equation produced by egn or negn.

Precede equation; break out and add space. Equation number is y.
The optional argument x may be I to indent equation (default), L to
left-adjust the equation, or C to center the equation.

EQxy

yes

.TE
.TH

yes

End table.

yes

End heading section of table.

TS x
aAcAN

yes
no

.ba +n

yes

Begin table; if x is H, table has repeated heading.
Set up for ACM style output. A is the Author’s name(s), N is the total
number of pages. Must be given before the first initialization.
Print x in boldface; if there is no argument, switch to boldface.
Augments the base indent by ». This indent is used to set the indent on
regular text (like paragraphs).

.bc
.bi
x

yes

bx x
ef xy7z°
h xy7z’
o xyz’
Jhx
he xyz”
hl
Ax

Apxy

LR
L L4

rrrs

no
no
no
no

no
yes
no

yes

Start indented paragraph, with hanging tag x. Indentation is y ens

yes

yes
rr7
S

.oh x%y7z’

rrrs

-PP

yes

no
no
yes

.SC

no
no

shnx

Suppress headers and footers on next page.
Set headertox y z.
Draw a horizontal line.
Italicize x; if x missing, italic text follows.
(default 5).
Start left-blocked paragraph.

of xyz’

yes

.np

Begin new column.

Print x in bold italics (nofill only).
Print x in a box (nofill only).
Set even footerto x y z.
Set even headerto x y z.
Set footerto x y z.

Read in a file of local macros of the form .*x. Must be given before
initialization.
Start numbered paragraph.
Set odd footerto x y z,
Set odd headerto x y z.
Print delayed text.
Begin paragraph. First line indented.
Roman text follows.
Reset tabs to default values.
Read in a file of special characters and diacritical marks. Must be
given before initialization.

yes

Section head follows, font automatically bold. 7 is level of section, x

.sk

.SZ +n

10p

is title of section.
Leave the next page blank. Only one page is remembered ahead.
Augment the point size by » points.

.th

Produce the paper in thesis format. Must be given before

yes

initialization.
Begin title page.

Macro Packages and Conventions 7—-41

me(7)
ux

.th

Underline argument (even in *roff).

yes

Like .sh, but unnumbered.

Xp X

Print index x.

(Nofill only).

Files
/usr/lib/tmac/tmac.e
/usr/lib/me/*

See Also
refer(1), tbl(1), nroff(1)
—me Reference Manual, ULTRIX Supplementary Documents, Vol. I: General User

Writing Papers with Nroff Using —me ULTRIX Supplementary Documents Vol. I:
General User

7-42 Macro Packages and Conventions

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(1). 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:
.bp

Begin new page

Jbr

Break output line

.Spn

Insert n spacing lines

.cen

Center next n lines
Line spacing: n=1 single, n=2 double space
No alignment of right margin

dsn
.na

Font and point size changes with \f and \s are also allowed; for example, \fIword\fR
italicize word. Output of the tbl, *eqn, and re fer(1) preprocessors for equations,

tables, and references is acceptable as input.

Requests
Initial

Break?

Value

Reset?

AE
Al

AU
Bx
.B1

.B2
BT

BX x

.CM

.CT
DA x
.DE
DSxy
Dy
LD

.CD

.BD

.EF x

Begin abstract; if x=no, do not label abstract.
End abstract.

AB x

Explanation

PN <W<Y<K<K<YW iYW
PPPBO<WKY O B

Macro
Name

Author’s institution.

Better accent mark definitions.
Author’s name.
Embolden x; if no x, switch to boldface.
Begin text to be enclosed in a box.
End boxed text and print it.

Bottom title, printed at foot of page.
Print word x in a box.
Cut mark between pages.

Chapter title: page number moved to CF (TM only).
Force date x at bottom of page; today if no x.
End display (unfilled text) of any kind.
Begin display with keep; x=LL,C,B; y =indent .
Indented display with no keep; y =indent.
Left display with no keep.
Centered display with no keep.
Block display; center entire block.

Even page footer x (3 part, as for .tl).

Macro Packages and Conventions 7-43

.EH x

.EN
EQxy

FS x

HD
Ix
JPxy
IXxy

KE
KF
KS

LG
.LP
MC x
ND x
.NH x y
.OF x
.OH x
.P1

iBdW B0 oYWiLK<WiDYiDiowWK
oo poowkw o
&
<
<
<
&

ms (7)

.RE

.QP

< ST

PX x

RP x

2C
[0

e
e
-

XP
XSxy

B 00K BEBBBYoYW<Y<x
B

RS
.SH
SM
.TA
TC x
.TE
.TH
.TL
TTMM
TS x
UL x
UX x
XAxy

7-44 Macro Packages and Conventions

Even page header x (3 part, as for .tl).

End displayed equation produced by *egn.
Break out equation; x=L,1,C; y=equation number.
End footnote to be placed at bottom of page.
Numbered footnote paragraph; may be redefined.

Start footnote; x is optional footnote label.
Optional page header below header margin.
Italicize x; if no x, switch to italics.
Indented paragraph, with hanging tag x; y =indent.

Index words x, y and so on (up to five levels).
End keep of any kind.
Begin floating keep; text fills remainder of page.
Begin keep; unit kept together on a single page.
Larger; increase point size by 2.

Left (block) paragraph..
Multiple columns; x=column width.
No date in page footer; x is date on cover.

Numbered header; x =level, x=0 resets, x=S sets to y.

Set point size back to normal.
Odd page footer x (3 part, as for .tl).
Odd page header x (3 part, as for .tl).
Print header on first page.
Paragraph with first line indented.
Page title, printed at head of page.
Print index (table of contents); x =no, suppresses title.
Quote paragraph (indented and shorter).
Return to Roman font.
Retreat: end level of relative indentation.
Released paper format; x =no, stops title on first page.
Right shift: start level of relative indentation.

Section header, in boldface.
Smaller; decrease point size by two.
Set tabs to 8n 16n ... (nroff) 5n 10n ... (*roff).
Print table of contents at end; x=no, suppresses title.
End of table processed by tbl.
End multipage header of table.
Title in boldface and two points larger.
UC Berkeley thesis mode.
Begin table; if x=H, table has multipage header.
Underline x, even in *roff.
UNIX; trademark message first time; x appended.
Another index entry; x =page or no for none; y=indent.
End index entry (or series of .IX entries).
Paragraph with first line exdented, others indented.
Begin index entry; x =page or no for none; y =indent.
One-column format, on a new page.
Begin two-column format.
Beginning of refer reference.
End of unclassifiable type of reference.
N= 1:journal-article, 2:book, 3:book-article, 4:report.

ms(7)

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:
ar LL 6.5

Here is a table of number registers and their default values:
Name Register Controls Takes EffectDefault
PS

Point size

paragraph

VS
LL

Vertical spacing
Line length

paragraph
paragraph

10
12
61

Title length

same as LL

FL
PD

5.51
1v (if n), .3v (if t)

Footnote length
next .FS
Paragraph distance paragraph
Display distance
displays

Paragraph indent

paragraph

Quote indent
Footnote indent

next .QP
next .FS
next page

5n
5n
2n

FI
PO
HM
M
FF

Page offset
Header margin

Footer margin
Footnote format

1v (if n), .5v (if t)

0 (if n), ~1i (if t)
1i

next page
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 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:

Name

String’s Function

¢
Q

Quote (" in nroff, ‘‘ in *roff )
Unquote (" in nroff, *’ in *roff )
Dash (-- in nroff, — in *roff' )
Month (month of the year)
Day (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)

\*U
\*_

\*(MO
\¥(DY
\* %k

\*~

\*¥*
\*
\*¥,
\*:
¥

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.

Macro Packages and Conventions 7-45

ms(7)
Files
/usr/lib/tmac/tmac.s
/usr/lib/ms/s.??2?