Digital PDFs

AA-LY19B-TE

June 1990

65 pages

Original

2.5MB

Document:	ULTRIX Reference Pages Section 7: Macro Packages and Conventions
Order Number:	AA-LY19B-TE
Revision:	0
Pages:	65
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. All Rights Reserved.
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:

IJDmOama
CDA
DDIF
DDIS
DEC
DEC net
DEC station

DECUS
DEC windows
DTIF
MASSBUS
MicroVAX
Q-bus
ULTRIX
ULTRIX Mail Connection

ULTRIX Worksystem Software
UNIBUS
VAX
VAX station
VMS
VMS/ULTRIX Connection
VT
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 RISe 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 intro 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(1mh). 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, intro(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(l). This title is used throughout the
documentation set.
The headings in each reference page provide specific information. The standard
headings are:
Name

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

Syntax

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

Describes the command-line options.

Restrictions

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

Examples

Provides examples of how a command or routine is used.

iv About Reference Pages

Return Values

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

Diagnostics

Describes diagnostic and error messages that can appear.

Files

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

Lists related reference pages and documents in the ULTRIX
documentation set.

Conventions
The following documentation conventions are used in the reference pages.
%

The default user prompt is your system name followed by a right
angle bracket. In this manual, a percent sign ( % ) is used to
represent this prompt.

A number sign is the default superuser prompt.

user input

This bold typeface is used in interactive examples to indicate
typed user input.

system output This typeface is used in text to indicate the exact name of a
command, routine, partition, pathname, directory, or file. This
typeface is also used in interactive examples to indicate system
output and in code examples and other screen displays.
UPPERCASE
lowercase

The ULTRIX system differentiates between lowercase and
uppercase characters. Literal strings that appear in text,
examples, syntax descriptions, and function definitions must be
typed exactly as shown.

rlogin

This typeface is used for command names in the Syntax portion
of the reference page to indicate that the command is entered
exactly as shown. Options for commands are shown in bold
wherever they appear.

filename

In examples, syntax descriptions, and routine definitions, italics
are used to indicate variable values. In text, italics are used to
give references to other documents.

[ ]

In syntax descriptions and routine definitions, brackets indicate
items that are optional.

{I}

In syntax descriptions and routine definitions, braces enclose lists
from which one item must be chosen. Vertical bars are used to
separate items.

About Reference Pages v

In syntax descriptions and routine definitions, a horizontal ellipsis
indicates that the preceding item can be repeated one or more
times.

A vertical ellipsis indicates that a portion of an example that
would normally be present is not shown.
cat(l)

Cross-references to the ULTRIX Reference Pages include the
appropriate section number in parentheses. For example, a
reference to cat(1) indicates that you can find the material on the
cat command in Section 1 of the reference pages.

Online Reference Pages
The ULTRIX reference pages are available online if installed by your system
administrator. The man command is used to display the reference pages as follows:
To display the ls(l) reference page:
% man Is

To display the pas swd(l) reference page:
% man passwd

To display the passwd(5) reference page:
% man 5 passwd

To display the Name lines of all reference pages that contain the word "passwd":
% man -k passwd

To display the introductory reference page for the family of 3xti reference pages:
% man 3xti intro

Users on ULTRIX workstations can display the reference pages using the
unsupported xman utility if installed. See the xman(lX) reference page for details.

Reference Pages for Unsupported Software
The reference pages for the optionally installed, unsupported ULTRIX software are in
the document Reference Pages for Unsupported Software.

vi About Reference Pages

intro (7)
Name
intro - miscellaneous useful information pages

Description
This section contains miscellaneous documentation, mostly in the area of text
processing macro packages for nroff and other *roff formatters.

Macro Packages and Conventions 7-1

ascii (7)
Name
ascii - map of ASCII character set

Syntax
cat /usr/pub/ascii

Description
The as c i i file is a map of the ASCII character set, to be printed as needed. It
contains:
000 nul 001 soh 002 stx 003 etx 004 eot 005 enq 006 ack 007 bel
010 bs 011 ht 012 nl 013 vt 014 np 015 cr 016 so 017 si
020 dIe 021 dc1 022 dc2 023 dc3 024 dc4 025 nak 026 syn 027 etb
030 can 031 em 032 sub 033 esc 034 fs 035 gs 036 rs 037 us
040 sp 041 ! 042 " 043 # 044 $ 045 % 046 & 047
050 ( 051 ) 052 * 053 + 054 , 055 - 056
057 /
060 0 061 1 062 2 063 3 064 4 065 5 066 6 067 7
070 8 071 9 072
073 , 074 < 075 = 076 > 077 ?
100 @ 101 A 102 B 103 C 104 D 105 E 106 F 107 G
110 H 111 I 112 J 113 K 114 L 115 M 116 N 117 0
120 P 121 Q 122 R 123 S 124 T 125 U 126 V 127 W
130 X, 131 Y 132 Z 133 [ 134 \ 135 ] 136
137
140
141 a 1142 b 143 c 144 d 145 e 146 "f 147 g
150 h 151 i 1152 j 153 k 154 I 155 m 156 n 157 0
160 P 161 q 1162 r 163 s 164 t 165 u 166 v 167 w
170 x 171 y 1172 z 173 { 174 1 175 } 176 ,... 177 del
00 nul
08 bs
10 dIe
18 can
20 sp
28 (
30 0
38 8
40 @
48 H
50 P
58 X,
60
68 h
70 P
78 x

01 soh
09 ht
11 dc1
19 em
21 !
29 )
31 1
39 9
41 A
49 I
51 Q
59 y
61 a
69
71 q
79 y

Files
/usr/pub/ascii

7 -2 Macro Packages and Conventions

02 stxl 03 etxl 04 eot
Oa ni 1 Ob vt 1 Oc np
12 dc21 13 dc31 14 dc4
1a subl Ib escl Ie fs
22 " 1 23 # 1 24 $
2a * 1 2b + 1 2c ,
32 2 1 33 3 1 34 4
3a
1 3b , 1 3c <
42 B 1 43 C 1 44 D
4a J 1 4b KI 4c L
52 R 1 53 S 1 54 T
5a Z 1 5b [ 1 5c \
62 b 1 63 c 1 64 d
6a j 1 6b k 1 6c I
72 r 1 73 s 1 74 t
1 7c 1
7a z 1 7b

05 enq
Od cr
15 nak
Id gs
25 %
2d 35 5
3d =
45 E
4d M
55 U
5d ]
65 e
6d m
75 u
7d }

06 ackl 07 bel
Oe so 1 Of si
16 synl 17 etb
Ie rs 1 If us
26 &1 27
2e
1 2f /
36 6 1 37 7
3e > 1 3f ?
46 F 1 47 G
4e N 1 4f 0
56 V 1 57 W
5e " 1 5f
66 f 1 67 g
6e n 1 6f 0
76 v 1 77 w
7e ,... 1 7f del

environ (7)
Name
environ - user environment

Syntax
extern char **eoviroo;

Description
An array of strings, called the environment, is made available by execve when a
process begins. By convention, these strings have the form "name=value". The
following names are used by various commands:
PATH

The sequence of directory prefixes that sh, time, and nice apply in
searching for a file known by an incomplete path name. The prefixes are
separated by a colon (:). The login(1) command sets
PATH=:/usr/ucb:/bin:/usr/bin.

HOME

A user's login directory, set by login from the password file passwd.

TERM

The kind of terminal for which output is to be prepared. This
information is used by commands, such as nroff or plot, which may
exploit special terminal capabilities. See / etc/termcap in
termcap(5) for a list of terminal types.

SHELL

The file name of the user's login shell.

TERMCAP The string describing the terminal in TERM or the name of the termcap
file. For further information, see termcap(5) and termcap(3x).
EXINIT

A startup list of commands read by ex, edit, and vi.

USER

The login name of the user.

PRINTER The name of the default printer to be used by lpr, lpq, and lprm.
Further names may be placed in the environment by the export command and
"name=value" arguments in sh, or by the setenv command if you use csh.
Arguments can also be placed in the environment at the point of an execve. It is
unwise to conflict with certain s h variables that are frequently exported by
.profile files: MAIL, PS1, PS2, and IFS.

See Also
csh(1), ex(1), 10gin(1), sh(1), execve(2), system(3), termcap(3x), passwd(5),
termcap(5)

Macro Packages and Conventions 7-3

Rise

hier (7)

Name
hier - file system hierarchy

Description
The following is a brief description of the root file system. The major directory
hierarchy and representative files are listed.
Symbolic links can be included in the files to provide backward compatibility. To
display the links, type:
% Is -1

See the Guide to Disk Maintenance for more detailed information.

Directory for root file system. This file system is separated into non sharable
data, (root (I)) and sharable data, (/usr). These two file systems are
each divided into the following types: static data, variable data, and
executable data.

Ibin

Directory for the single user executable data files.

Ibin/init Parent of all processes, ini t(8).
Ibin/mount
Mount program, rnount(8).

Idev

Directory for devices.
MAKEDEV
Shell script to create special files
MAKEDEV.local
Site-specific part of MAKEDEV
console Main console, t t y(4)
SCSI disks, rz(4)
rz
Raw SCSI disks, rz(4)
rrz*
Tapes
rmt*
mrmt* Tapes
Terminals, t t y( 4)
tty *

letc

Directory for the machine-specific static data files and shell scripts for
booting.
crontab
System clock daemon table, crontab(5)
disktab
Disk characteristics and partition tables, disktab(5)
fstab
File system configuration table, f stab(5)
group
Group file, group(5)
hosts
Host name-to-network address mapping file, host s(5)
motd
Message-of-the-day file, login(1)
networks Network name-to-network number mapping file,
networks(5)
passwd
Password file, passwd(5)
protocols Name-to-number mapping file, protocols(5)
rc
Shell script to bring the system to multiuser mode

7 -4 Macro Packages and Conventions

hier(7)
rc.local
remote
services
termcap
ttys

llib

Site-dependent portion of rc
Names and description of remote hosts for tip(lc) and
remote(5)
Network services definition file, services(5)
Description of tenninal capabilities, termcap(5)
Properties of tenninals, tty s (5)

Symbolic link to /usr / lib.

Ilost+found
Directory for connecting detached files for f sck(8).

Isys
Itmp

Symbolic link, nonnally to /usr / sys.
Directory for temporary files (see also / us r / tmp ).
e*
Used by ed(1)
ctm* Used by cc(1)

lusr

General purpose directory, on which the /usr file system is nonnally
mounted (see description that follows).

Ivar

Directory for variable length files, such as spool, administrative, and
temporary files. These files can also be located in / u s r / va r . See the
Guide to Disk Maintenance.

Ivmunix Kernel image
The / u s r directory contains the sharable data. The following is a brief description of
the /usr file system. The major directory hierarchy and representative files are
listed.

lusr
lusr/adm

Root directory for / u s r file system.
Directory for administrative infonnation, which is now a symbolic link
to /var / adm.
crash
Directory for crash dumps
vmcore.? ,vmunix.?
Crash dump files
Ipacct Line printer accounting, 1 p r( 1)
tracct
Phototypesetter accounting, troff(l)
wtmp
Login history, utmp(5)

Macro Packages and Conventions 7-5

Rise

hier (7)
lusr/bin

Directory for the shared executable data files, including utility programs
and Shell scripts.
as
assembler
cc
C compiler executive (see also /usr / lib/ ccom and
/usr / lib/ cpp)
csh C shell

lusr/dict

Directory for word lists.
spellhist History file, spell(l)
words
Word list, look(1)

lusr/doc

Directories containing files for the Vol.2 documentation.
as
Assembler manual
c
C manual

lusr/etc
Directory for utility programs and shell scripts.
lusrletdcron
Clock daemon, cron(8).

lusr/etcldump
Dump program, dump ( 8) .

lusr/examples
A directory where components of the base system and Digital's
separately licensed products can locate code examples, scripts, and
demos for customers to use. A typical use is to complement printed
documentation.

lusr/games Directory for games.
hangman
lib

Hangman game
Library directory for games

lusr/etclgetty
Part of login, getty(8).

7 -6 Macro Packages and Conventions

hier (7)
/usr/include
Directory for standard #include files.
a.out.h
Object file layout, a . out(5)
math.h rnatherr(3m)
stdio.h
Standard I/O, intro(3s)
sys
Symbolic link to / sys /h (system generation #include
files)

/usrlIib

Directory for the shared static data files, such as object libraries.
atrun
System scheduler, at(1)
cpp
C preprocessor
Iibc.a
System calls and standard I/O (2,3,3S)
font
Directory for *roff(1) fonts
lint
Directory for utility files for lintel)
tmac
Directory for * r 0 f f (l) macros
units
Data file of conversion tables for uni ts(1)
uuep
Directory for uucp(1c) programs and data

/usr/man

Directory for unformatted and preformatted reference (manual) pages.
catl
Section 1 (preformatted)
cat2
Section 2 (preformatted)
cat3
Section 3 (preformatted)

manl
man2
man3

Section 1 (unformatted)
Section 2 (unformatted)
Section 3 (unformatted)

/usr/mdec Directory for ULTRIX boot files.
/usr/msgs Directory for messages, msgs(1).
/usr/new

Directory for binaries of new versions of programs.

/usr/preserve
Directory for editor t ernp files preserved after crashes or hangups.

/usr/skel

Directory for sample user startup files .
.cshrc
Startup file for c s h(1)
.login
Login startup file for c s h( l)
.mailre Startup file for rna i 1 (l)
.profile Startup file for sh(1)
.project Lists information used by finger(1)

Macro Packages and Conventions 7-7

Rise

hier (7)
lusrlspool Directory for delayed execution files, which is now a symbolic link to
/var/spool.
at
Directory used by at(1)
Jpd Directory used by Ipr(l)
lock Present when line printer is active
cf* Copy of file to be printed, if necessary
df* Daemon control file, Ipd(8)
tf* Transient control file (exists while 1 p r is working)
mail Mailboxes for rna i 1 (1)
name
Mail file for user name
Lock file (exists while name is receiving
name.lock
mail)
uucp Work files and staging area for u u cp( 1c)
LOGFILE
Summary log

lusrlsrc

Generic sources.
usr.bin User sources
troW nroff and troff sources
term Directory of description files for new printers

lusrlsys

Directory for system files.
b.mips
BINARY for MIPS
b.vax
BINARY for VAX
fs
Filesystem SRC
net
Netword SRC
mips
MIPS-specific SRC
vax
VAX-specific SRC
data
System data files
conf/{mips,vax}
Configuration files
h
#include files
SAS
Standalone system
sys
Machine independent SRC

lusr/tmp

Symbolic link to /var /tmp.

See Also
apropos ( 1), find( 1), finger( 1), grep( 1), ls( 1), whatis( 1), whereis( 1), which( 1),
ncheck(8)
Guide to Disk Maintenance

7-8 Macro Packages and Conventions

hier(7)

Name
hier - file system hierarchy

See the Guide to Disk Maintenance for more detailed information.

Directory for root file system. This file system is separated into non sharable
data (root (/)) and sharable data (/usr). These two file systems are each
divided into the following types: static data, variable data, and executable
data.

Ibin

Directory for the single user executable data files.

Ibin/init Parent of all processes, ini t(8).
Ibin/mount
Mount program, mount(8).
Idev

Directory for devices.
MAKEDEV
Shell script to create special files
MAKEDEV.local
Site-specific part of MAKEDEV
console Main console, t t y(4)
disks, hp(4)
hp*
Raw disks, hp(4)
rhp*
UNIBUS disks, r a( 4)
ra*
Terminals, t t y(4)
tty*

letc

Directory for the machine-specific static data files and shell scripts for
booting.
crontab
System clock daemon table, crontab(5)
disktab
Disk characteristics and partition tables, di s ktab(5)
fstab
File system configuration table, fstab(5)
group
Group file, group(5)
hosts
Host name-to-network address mapping file, hosts(5)
motd
Message-of-the-day file, login(l)
networks Network name-to-network number mapping file,
networks(5)
passwd
Password file, pas swd(5)
protocols Name-to-number mapping file, protocols(5)
rc
Shell script to bring the system to multiuser mode
rc.local
Site-dependent portion of rc

Macro Packages and Conventions 7-9

VAX

hier(7)
Names and description of remote hosts for tip(1c) and
remote(5)
Network services definition file, services(5)
Description of terminal capabilities, termcap(5)
Properties of terminals, ttys(5)

remote
services
termcap
ttys

llib

Symbolic link to /usr / lib.

Ilost+found
Directory for connecting detached files for fsck(8).

Isys

Symbolic link, normally to /usr / sys.

Itmp

Directory for temporary files (see also /usr /tmp).
e*
Used by ed(1)
ctm* Used by cc(l)

lusr

General purpose directory, on which the /usr file system is normally
mounted (see description that follows).

Ivar

Directory for variable length files, such as spool, administrative, and
temporary files. These files can also be located in /usr /var. See the
Guide to Disk Maintenance.

Ivmunix Kernel image
The /usr directory contains the sharable data. The following is a brief description of
the /usr file system. The major directory hierarchy and representative files are
listed.

lusr

Root directory for /usr file system.

lusr/adm

Directory for administrative information, which is now a symbolic link
to /var / adm.
crash
Directory for crash dumps
vmcore.?,vmunix.?
Crash dump files
Ipacct Line printer accounting, Ipr(1)
tracct
Phototypesetter accounting, troff(l)
vaacct, vpacct
Varian and Versatec accounting for vpr(1), vtroff(l),
pac(8)
wtmp
Login history, utmp(5)

/nsr/bin

Directory for the shared executable data files, including utility programs
and Shell scripts.
as
assembler
cc
C compiler executive (see also / lib/ ccom, / lib/ cpp, and
/lib/c2)

7-10 Macro Packages and Conventions

hier(7)
csh

C shell

/usr/dict

Directory for word lists.
spellhist History file, spell(1)
words
Word list, look(l)

/usr/doc

Directories containing files for the Vo1.2 documentation.
as
Assembler manual
c
C manual

/usr/etc

Directory for utility programs and shell scripts.

/usr/etc/cron
Clock daemon, cron(8).
/usr/etc/dump
Dump program, dump ( 8 ) .
/usr/examples
A directory where components of the base system and Digital's
separately licensed products can locate code examples, scripts, and
demos for customers to use. A typical use is to complement printed
documentation.
/usr/games Directory for games.
hangman Hangman game
lib
Library directory for games

/usr/etc/getty
Part of login, getty(8).
/usr/include
Directory for standard #include files.
a.out.h
Object file layout, a. out(5)
math.h matherr(3m)
stdio.h
Standard I/O, intro(3s)
sys
Symbolic link to / sys/h (system generation #include
files)

/usr/lib

Directory for the shared static data files, such as object libraries.
atrun
System scheduler, at(l)
ccom
C compiler proper

Macro Packages and Conventions 7-11

VAX

hier(7)
cpp
c2
libc.a
font
lint
tmac
units
uucp

lusr/man

C preprocessor
C code improver
System calls and standard I/O (2,3,3S)
Directory for *roff(l) fonts
Directory for utility files for 1 in t (1)
Directory for nroff(l) and * roff(1) macros
Data file of conversion tables for units(l)
Directory for uucp(lc) programs and data

Directory for unformatted and preformatted reference (manual) pages.
catl
Section 1 (preformatted)
cat2
Section 2 (preformatted)
cat3
Section 3 (preformatted)

manl
man2
man3

Section 1 (unformatted)
Section 2 (unformatted)
Section 3 (unformatted)

lusr/mdec Directory for ULTRIX boot files.
lusr/msgs Directory for messages, rnsgs(1).
lusr/new

Directory for binaries of new versions of programs.

lusr/preserve
Directory for editor temp files preserved after crashes or hangups.

lusrlskel

Directory for sample user startup files
.cshrc
Startup file for csh(l)
.Iogin
Login startup file for c s h( 1)
.mailrc Startup file for rnail(1)
.profile Startup file for sh(l)
.project Lists information used by finger(1)

lusrlspool Directory for delayed execution files, which is now a symbolic link to
/var / spool.
at
Directory used by at ( 1)
Ipd Directory used by Ipr(l)
lock Present when line printer is active
cf* Copy of file to be printed, if necessary
df* Daemon control file, Ipd(8)
tf* Transient control file (exists while 1 p r is working)
mail Mailboxes for rna i 1 (l )
name
Mail file for user name
name. lock
Lock file (exists while name is receiving
mail)
uucp Work files and staging area for uucp(lc)
LOGFILE
Summary log

7 -12 Macro Packages and Conventions

hier (7)
lusrlsrc

Generic sources.
usr.bin User sources
troft' nroff and troff sources
term Directory of description files for new printers

lusrlsys

Directory for system files.
BINARY System object files, make(l)
Files for boot cassette
cassette
Configuration files, conf ig(8)
conf
Drive partition tables
data
floppy
Files for floppy disk
h
# incl ude files
Headers for 11/750 boot blocks
mdec
General network files
net
netimp
IMP network files
DARPA internet network files
netinet
netpup
PUP network files
Standalone boot binaries
stand
Machine-dependent system files
sys
VAX-specific system files
vax
Network interface drivers for the VAX
vaxif
Drivers for devices on the MASSBUS
vaxmba
Drivers for devices on the UNIBUS
vaxuba

lusr/tmp

Symbolic link to /var /tmp.

See Also
apropos(1), find( 1), finger( 1), grep(1), Is(1), whatis(1), whereis(l), which(l),
crontab(5), ncheck(8)
Guide to Disk Maintenance

Macro Packages and Conventions 7-13

VAX

mailaddr (7)
Name
mailaddr - mail addressing description

Description
Mail addresses are based on the ARPANET protocol listed in the SEE ALSO section
of this reference page. In addition, the DEC net address format can be used, if
DECnet is installed on your system.
To send mail to DEC net users, use the following address format:
nodename::username

In this case, nodename is the name of the DECnet system, or host, on which the
target user resides.
Addresses based on the ARPANET protocol use the following general format:
user@domain

A domain is a hierarchical dot-separated list of subdomains. For example, the
following address is interpreted from right to left:
eric@monet.Berkeley.ARPA

In the previous example, the message is directed to the ARPA name tables (which do
not correspond exactly to the physical ARPANET). The message then proceeds to
the Berkeley gateway, after which it is directed to the local host monet. When the
message reaches monet, it is delivered to the user eric.

Unlike some other forms of addressing, this does not imply any routing. Thus, an
address that is specified as an ARPA address can travel by an alternate route if that
route is more convenient or efficient. For example, from Berkeley, the message
could go directly to monet over the Ethernet, rather than using the Berkeley
ARPANET gateway.

Abbreviations. In some instances, you do not have to type an entire domain name.
Generally, any information that follows the first dot may be omitted if the sending
and receiving domains are the same. For example, a user on calder.Berkeley.ARPA
can eliminate the .Berkeley.ARPA when sending to eric@monet, because the sending
and receiving hosts are the same.
Other abbreviations are permitted when conflicts do not exist. For example, Berkeley
ARPANET hosts can be accessed without adding the .ARPA, if their names do not
conflict with a local host name.

Compatible Addresses. To provide compatibility with the previous mail system,
some old address formats are converted to the new format. In particular, host::user is
converted to user@host providing consistency with the rcp(lc) command.
The syntax host!user is converted to user@host.UUCP. Before being sent on,
user@host.UUCP is normally converted back to the host!user form. This conversion
is done for compatibility with older UUCP hosts.
The current implementation cannot automatically route messages through the UUCP
network. Thus, you must explicitly tell the mail system all the hosts your messages
must be sent through to arrive at its final destination.

7 -14 Macro Packages and Conventions

mailaddr (7)
Case Distinctions. Domain names (that is, anything following the at sign (@)) c~n
be a combination of upper- and lowercase characters with the exception of UUCP
hostnames. Most hosts accept both upper- and lowercase in user names, with the
exception of MULTICS sites.
Differences with ARPA Protocols. Although the UNIX addressing scheme is based
on the ARPA mail addressing protocols, there are some significant differences.
Currently, the only top level domain defined by ARPA is the .ARPA domain itself.
This is further restricted to having only one level of host specifier. That is, the
addresses that ARPA accepts must be in the format user@host.ARPA (where 'host'
is one word). For example, the following address is not legal under the ARPA
protocols:
eric@monet.Berkeley.ARPA

Thus, the previous address would be converted to a different format on output to the
ARPANET. For example:
eric%monet@Berkeley.ARPA

Route-addrs. In some instances, a message must be routed through several hosts to
reach its final destination. Usually, this action is invisible to the sender; however, it
is sometimes desirable to route a message manually. Addresses that are moved
manually are called route-addrs. The syntax is as follows:
<@hosta,@hostb:user@hostc>

The previous example directs the message to hosta, to hostb, and finally to hoste.
This route is used regardless of a more efficient path to hostc.
Route-addrs occur frequently on return addresses, because they are generally
augmented by the software at each host. It is possible to ignore all but the user@host
part of the address to determine the actual sender.

Postmaster. Every site must have a user or user alias designated as postmaster to
which problems with the mail system can be addressed.
CSNET. To send messages to CSNET, use the following syntax:
user.host@UDel-Relay

See Also
mail(l), 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

Syntax
tbl file ... I nroff [ -oN ] [ -rll ] -man I col I ...
tbl file ... I *troff [ -oN ] [ -rll ] -man I ...

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(l) 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.
II

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 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 . 8M 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 [ text ... ]

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

.BI word1 word2 [ words ... ]
Sets word1 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 word1 word2 [ words ... ]
Sets word1 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, . eTA prints as < CTRL / A> .
.CW

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

•De

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

•Ds

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.

.DT

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

.5i, Ii, ....
.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 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 fonnatter is of type nroff, the next 999 input lines are fonnatted
in underline mode (nroff italic mode), or all the lines up to a font
change are fonnatted in underline mode, depending on which limit is
encountered first. If the text formatter is of type troff, 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.

.1 [ text... ]

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

•11 word

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

.12 word

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

.IB word1 word2 [ words ... ]
Sets word1 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 (" ") .
.IP x 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. Tag x appears in
bold typeface.

Macro Packages and Conventions 7-17

man(7)
.IR word] 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 referenceyage section_subsection [punctuation]
Sets referenceyage 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 [ header1 ] [ 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 .

•PN x [ y ]

Sets x in 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 .

•Po x y [ z]

Sets x in 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 nroff
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 word1 word2 [ words ... ]
Sets word1 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=O 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 word] word2 [ words ... ]
Sets word1 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 (" ") .

•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 fonnatters. Nested. RS calls
increment the relative indent by i ens, or by .25 inch for nroff, or by
2 picas for *troff text fonnatters .

•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.

•TB [ words ... ]
Same as the . HB macro. This macro is is obsolete, but is provided for
backwards compatibility.
•THnc[s][a][f][x]

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 fonnatted reference page. The n argument is the reference
page name. The c 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 fonnatted with n r 0 f f, but appears as a bleed tab when
fonnatted with *troff text fonnatters. Thefargument 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

man(7)
.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:
De
LP
TP

Ds
PP

EE
RE

EX
SH

HP
SS

IP
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
IB
SM

BI
IR

BR
RI

G
RB

GL
SH

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 balded by three units
whenever the current font is '3'.
The default page size is 80 columns by 66 lines for nroff output and 8.5" x II" 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 I v for nroff and .5v for *troff text
formatters.

•

The basic text indent is .5 inches for nroff 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.

•

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
-oN

Numbers the first generated page as N.

-rll

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:
PO

Page offset and page margin

IN
LL
PL

Left margin indent relative to the section headers
Line length including IN
Page length

The register '1' is predefined when you specify the *roff -rl option. Its default
value is O. 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:
Al

PF
In addition, registers beginning with the characters ')', ']" and'}' are also reserved
for internal use.
Registers predefined by the nroff(1), tbl(l), commands, and the *eqn 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

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:
DE

Al
DS

BD
HH
UF

BK
ID
ya

CD
LD

D
NO
yl

ys
In addition, names begining with the characters ')', ']', and'}' are also reserved for
internal use.
Names predefined by the nroff(1), tbl(1), commands, and the *eqn 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', '1', '0', or 'p'. Other values might not
be recognized by the man(l) or catman(8) commands.
Sections 6, 7, 'n', '1', '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 tbl(I) 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 ... J \- 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 * ro f f 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
G
LP
R

CW De
Ds
GL
HB
HP
MS
NE
NT
RNTBUF

EE
11
PN

EX
12
Pn

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 tbl(1) and *eqn commands should be avoided, because the version of
the man(I) command in some other implementations might not preprocess reference
pages through the tbl(1) command. The * eqn 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(l), man(l), nroff(l), tbl(l), 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
tbI file ... I nroff [ -oN ] [ -rpS ] [ -rIl ] -man.nopage I col I ...
tbI file ... I *troff [ -oN ] [ -rpS ] [ -rIl ] -man.nopage I ...

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 nroff(1) command and is 8.5
inches when formatted with *troff text formatters. The output is unpaginated
when formatted by the nroff command, hence the name 'nopage'. The output is
paginated when formatted by *troff 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 * t ro f f 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.

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

.BI word] word2 [ words ... ]
Sets word] 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 word] word2 [ words ... ]
Sets word] 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> .

.cw

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

•De

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

.Ds

Starts an unfilled display block. Text between . D sand . 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.

.DT

Restores default tabs. Default tabs are set to .5 inches, starting with
.5i, li, ....

•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 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 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 ro f f, 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 .

.I [ text ... ]

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

•11 word

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

.12 word

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

Macro Packages and Conventions 7-25

man.nopage (7)
.IP x i

•IR word] 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 referenceyage section_subsection [ punctuation]
Sets reference yage 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 [ header1 ] [ 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 .

•PN x [ y ]

Sets x in an italic or constant width typeface (depending on the
* raff 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 .

•Po x y [ z]

Sets x in the current typeface, sets y in an italic or constant width
typeface (depending on the *raff 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 nraff
and four picas for *traff text formatters .

•R

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

.RB word1 word2 [ words ... ]
Sets word] 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=l. 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 word1 word2 [ words ... ]
Sets word1 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 (" ") .
.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 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 . . .

•TB [ words ... ]
Same as the . HB macro. This macro is is obsolete, but is provided for
backwards compatibility.

•TH n c[s] [ a ] [f] [ x ]
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 c 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 nroff, but appears as a bleed tab when
formatted with * tro f f text fonnatters. 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 .

.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:
De
LP
TP

Ds
PP

EE
RE

EX
SH

HP
SS

IP
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
IB
SM

BI
IR

BR
RI

G
RB

GL
SH

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 nroff output and 8.5 inches 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 default page length is unlimited (unpaginated) for neroff output, but is 11
inches for output generated by *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 Iv for nroff and .5v for *troff text
formatters.

•

The basic text indent is .5 inches for nroff 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.

•

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 0 for *troff output. There are no page footers for nroff output.

Options
-nN

Numbers the first generated page as N.

-rll

Turns on line double-spacing mode.

-rpS

Sets the section number fo S. Section numbers appear in output page
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

IN
LL
PL

Left margin indent relative to the section headers
Line length including IN
Page length

The register '1' is predefined when you specify the * r 0 f f - r 1 option. Its default
value is O. The mane 1) command does not use this option.
The register 'p' is predefined when you specify the *roff -rp option. Its default
value is O. 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:
Al

PF
In addition, registers beginning with the characters ')" ']', and'}' are also reserved
for internal use.
Registers predefined by the nroff(1), tbl(1), commands, and the *eqn 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:
Iq

" 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
ys

Al
DS

BD
HH

BK
ID
ya

CD
LD
yn

D
NO
yl

In addition, names begining with the characters ')', ']" and '}' are also reserved for
internal use.
Names predefined by the nroff(1), tbl(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', '1', '0', or 'p'. Other values might not
be recognized by the man(l) or catman(8) commands.
Sections 6, 7, 'n', '1', '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 tbl(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 fonnat:
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.

CW
De
Ds
GL
HB
HP
MS
NE
NT
RNTBUF

7-30 Macro Packages and Conventions

EE
11
PN

EX
12
Pn

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 tbl(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 tbl(l) command. The *eqn 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(l), 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 ... I nroff [ -oN ] [ -rpS ] [ -rll ] -man.repro I coil ...
tbl file ... I *troff [ -oN ] [ -rpS ] [ -rll ] -man.repro I ...

Description
The man. repro macro package is used to format reference manual pages for
printing or typsetting. This reference page was formatted by a *troff text
formatter, using the man. repro macro package. nroff(1) command, using the
man. repro macro package, or was formatted by the man(l) and the catman(8)
commands, using the ma.n 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.
II

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 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 . 3M 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 [ text ... ]

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

.BR word1 word2 [ words ... ]
Sets word1 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-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> .
•CW

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

•De

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

.Ds

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 .

•DT

Restores default tabs. Default tabs are set to .5 inches, starting with
.5i, li, ....

•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 fonnatter (nroff or troff). If the
text formatter is of type n r 0 f f, 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 fonnatter is of type t r 0 f f, 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 .

.I [ text ... ]

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

•11 word

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

.12 word

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

man.repro (7)
.IR word1 word2 [ words ... ]
Sets word1 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 yage section_subsection [ punctuation ]
Sets referenceyage 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 ] [ 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 .

•PN x [ y ]

Sets x in an italic or constant width typeface (depending on the
* ro f f 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 .

•Po x y [z]

•PP

Starts a block paragraph. Sets the prevailing indent to .5i 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.

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 word1 word2 [ words ... ]
Sets word1 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 (" ") .
.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 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.

.TB [ words ... ]
Same as the . HB macro. This macro is is obsolete, but is provided for
backwards compatibility .

.TH n c[s] [ a ] [j] [ x ]
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 c 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 j 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 nroff, but appears as a bleed tab when
formatted with *troff text formatters. Thejargument 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

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 textfooter.
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:
De
LP
TP

Ds
PP

EE
RE

EX
SH

HP
SS

IP
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
IB
SM

BI
IR

BR
RI

G
RB

GL
SH

I
SS

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 nroff output and 8.5" x 11" for
output generated by *troff text fonnatters. 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 fonnatters.
The. TH macro sets up the following defaults:
•

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

•

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

•

The basic text indent is .5 inches for nroff and four picas for *troff text
fonnatters, from the left margin.

•

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

•

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
-oN

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 S 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 0, 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:

Page offset and page margin

Left margin indent relative to the section headers

LL
PL

Line length including IN
Page length

The register '1' is predefined when you specify the * r 0 f f - r 1 option. Its default
value is O. 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 O. The man(l) 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 '1', 'n', '0', or 'p'.

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

In addition, registers beginning with the characters ')', ']', and '}' are also reserved
for internal use.
Registers predefined by the nroff(1), tbl(1), commands, and the *eqn 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

Macro Packages and Conventions 7-37

man.repro (7)

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:
##
DE
NX

Al
DS
P

BD
HH
ya

BK
ID
yn

CD
LD
yl

D
NO
ys

In addition, names begining with the characters ')', ']', and '}' are also reserved for
internal use.
Names predefined by the nroff(l), tbl(l), 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', '1', '0', or 'p'. Other values might not
be recognized by the man(1) or catman(8) commands.
Sections 6, 7, 'n', '1', '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 tbl(1) commands must not be preprocessed before being
installed on the system.

The Name Section
The ca trnan(8) command assumes the Name section of a reference page has the
following format:
name[, name, name ... J \- 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 * raff commands in the
explanatory text. The explanatory text should be brief. The ca trnan(8) command
combines information in the Name section with parameters of the. TH macro to
create an entry in a database searched by the aprapas(1), rnan(l), and whatis(l)
commands.

CW
De
Ds
GL
HB
HP
MS
NE
NT
RNTBUF

7-38 Macro Packages and Conventions

EE
11
PN

EX
12
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 *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 tbl(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 tbl(1) command. The *eqn commands also might not be
installed.

Examples
The following example processes this manual page for a character-cell device:
% cd /usr/man/man7
% tbl man.repro.7 Inroff -rp7 -n39 -man.repro I col I lpr -Plp

In this example, the -rp7 option for nroff initializes number register p to specify
that this page is from Section 7 of the Reference Pages. The -n3 9 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(l), man(l), nroff(l), tbl(l), 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 ] file ...
*roff -me [ options ] file ...

Description
This package of nraff and *raff macro definitions provides a formatting facility
for technical papers in various formats. When producing 2-column output on a
terminal, filter the output through cal(l).
Many nraff and * raff requests are unsafe in conjunction with this package;
however, these requests can be used with impunity after the first .pp:
.bp
Begin new page
.br
Break output line here
.sp n Insert n spacing lines
.Is n Line spacing: n=l single, n=2 double space
.na
No alignment of right margin
.ce n Center next n lines
.ul n Underline next n lines
.sz +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, .lp, .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
.(b
.(c
.(d
.(f
.(1
.(q
.(x x
.(z
.)b
.)c
.)d
.)f
.)1
.)q
.)x
.)z

Initial Cause Explanation
Value Break
yes
yes
no
no
yes
yes
no
no
yes
yes
yes
yes
yes
yes
yes
yes

Begin block.
Begin centered block.
Begin delayed text.
Begin footnote .
Begin list.
Begin major quote .
Begin indexed item in index. x
Begin floating keep.
End block.
End centered block .
End delayed text.
End footnote .
End list.
End major quote .
End index item .
End floating keep .

7-40 Macro Packages and Conventions

me(7)
.++ mH

.+c T
. Ic
.2c
.EN

.EQxy

yes
yes
yes
yes
yes

.TE
.TH
.TS x
.acA N

yes
yes
yes
no

I
I

.b x
.ba +n

no
0

no
yes

.bc
.bi x
.bx x
.ef 'x'y'z'
.eh 'x'y'z'
.fo 'x'y'z'
.hx
.he 'x'y'z'
.hl
j x
jp x y

no
no
no

yes
no
no
no
no
no
no
no
yes
no
yes

.lp
.10

no
no
yes

yes
no

I
.np
.of 'x'y'z'
.oh 'x'y'z'
.pd
.pp
no
.r
yes

yes
no
no
yes
yes
no
no
no

Je
.sc

.sh n x

yes

.sk
.sz +n
.th

no
lOp
no

no
no
no

.tp

yes

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
one).
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 eqn or neqn .
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 .
End table.
End heading section of table .
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 n. This indent is used to set the indent on
regular text (like paragraphs).
Begin new column .
Print x in bold italics (nofill only) .
Print x in a box (nofill only) .
Set even footer to x y z.
Set even header to x y z .
Set footer to x y z .
Suppress headers and footers on next page .
Set header to x y z.
Draw a horizontal line .
Italicize x; if x missing, italic text follows.
Start indented paragraph, with hanging tag x. Indentation is yens
(default 5) .
Start left-blocked paragraph.
Read in a file of local macros of the form. *x. Must be given before
initialization.
Start numbered paragraph .
Set odd footer to x y z.
Set odd header to 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.
Section head follows, font automatically bold. n is level of section, x
is title of section .
Leave the next page blank. Only one page is remembered ahead .
Augment the point size by n points.
Produce the paper in thesis format. Must be given before
initialization.
Begin title page .

Macro Packages and Conventions 7-41

me(7)
no
yes
no

.ux

.uh
.xpx

Underline argument (even in *roff). (Nofill only) .
Like .sh, but unnumbered .
Print index x .

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

See Also
refer(1), tbI(1), nroff(l)
-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
Break output line
.br
.sp n
Insert n spacing lines
.ce n
Center next n lines
.Is n
Line spacing: n=1 sirigle, n=2 double space
.na
No 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, *eqri, and refer(l) preprocessors for equations,
tables, and references is acceptable as input.

Requests
Macro
Name
.ABx
.AE
.AI
.AM
.AU
.Bx
.Bl
.B2
.BT
.BXx
.CM
.CT
.DAx
.DE
.DSxy
.ID y
.LD
.CD
.BD
.EFx

Initial
Value

date
if t
if n
I
8n,.5i

Break? Explanation
Reset?
y
Begin abstract; if x =no, do not label abstract.
End abstract .
y
Author's institution.
y
Better accent mark definitions.
n
Author's name.
y
Embolden x; if no x, switch to boldface .
n
Begin te~t to be enclosed in a box .
y
End boxed text and print it .
y
Bottom title, printed at foot of page .
n
Print word x in a box .
n
Cut mark between pages.
n
y,y
Chapter title: page number moved to CF (TM only) .
Force date x at bottom of page; today if no x.
n
End display (unfilled text) of any kind .
y
Begin display with keep; x=I,L,C,B; y=indent .
y
Indented display with no keep; y =indent.
y
Left display with no keep .
y
Centered display with no keep .
y
Block display; center entire block.
y
Even
page footer x (3 part, as for .t1) .
n

Macro Packages and Conventions 7-43

ms(7)
.EHx
.EN
.EQxy
.FE
.FP
.FSx
.HD
.Ix
.IP x Y
.IXxy
.KE
.KF
.KS
.LG
.LP
.MCx
.NOx
.NHxy
.NL
.OFx
.OHx
.P1
.PP
.PT
.PXx
.QP
.R
.RE
.RPx
.RS
.SH
.SM
.TA
.TCx
.TE
.TH
.TL
.TM
.TSx
.ULx
.UXx
.XAxy

undef

Y,Y

if t

lOp
ifTM
- %-

on
5n
5n
8n,5n

.]-

.[0
.[N

y
n
n
y
n
y,y
y,y
n
y,y
n
n
n
n
y,y
n
y
y,y
n
y,y
n
y,y
y,y
n
n

off

.XE
.XP
.XSxy
. IC
.2C

n
y
y
n
n
n
n
n

y
y
y
n
y,y
n
n
y
y
y,y
y

Y,Y
y,y
n
n
n

7-44 Macro Packages and Conventions

Even page header x (3 part, as for .tl).
End displayed equation produced by *eqn.
Break out equation; x=L,I,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=O 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 ... (nrotI) 5n IOn ... (*rotI).
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
Fonnatting distances can be controlled in -IDS by means of built-in number registers.
For example, this sets the line length to 6.S inches:
.nr LL 6.Si
Here is a table of number registers and their default values:

Name Register Controls Takes EffectDefault
PS
Point size
paragraph 10
Vertical spacing paragraph 12
VS
Line length
LL
paragraph 6i
LT
Title length
same as LL
next page
FL
Footnote length
next .FS
S.Si
Iv (if n), .3v (if t)
PD
Paragraph distance paragraph
1
v (if n), .Sv (if t)
DD
Display distance displays
PI
Paragraph indent paragraph Sn
QI
Quote indent
next .QP
Sn
FI
Footnote indent
next .FS
2n
PO
Page offset
next page o (if n), -Ii (if t)
HM Header margin
Ii
next page
PM Footer margin
next page
Ii
o (1, 2, 3 available)
FF
Footnote fonnat next .FS
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 -IDS; they can be used anywhere in the
text:

Name
\*Q

String's Function

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)
\*A
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.
\*U
\*\*(MO
\*(DY
\**
\*'
\*'

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
lusr/lib/tmac/tmac.s
lusr/lib/ms/s.???