man(5) man(5)NAME man - macros for formatting entries in this manual SYNOPSIS nroff -man files troff -man [-rs1] files DESCRIPTION These nroff(1)/ troff(1) macros are used to lay out the for- mat of the entries of this manual. The default page size is 8.5"x11", with a 6.5"x10" text area; the -rs1 flag option reduces these dimensions to 6"x9" and 4.75"x8.375", respec- tively; this option (which is not effective in nroff(1)) also reduces the default type size from 10-point to 9-point, and the vertical line spacing from 12-point to 10-point. The -rV2 flag option may be used to set certain parameters to values appropriate for certain Versatec printers: it sets the line length to 82 characters, the page length to 84 lines, and it inhibits underlining. Any text argument below may be one to six ``words''. Double quotes ("") may be used to include blanks in a ``word''. If text is empty, the special treatment is applied to the next line that contains text to be printed. For example, .I may be used to italicize a whole line, or .SM followed by .B to make small bold text. By default, hyphenation is turned off for nroff(1), but remains on for troff(1). Type font and size are reset to default values before each paragraph and after processing font- and size-setting mac- ros, e.g., .I, .RB, .SM. Tab stops are neither used nor set by any macro except .DT and .TH. Default units for indents in are ens. When in is omitted, the previous indent is used. This remembered indent is set to its default value (7.2 ens in troff(1), 5 ens in nroff- this corresponds to 0.5" in the default page size) by .TH, .P, and .RS, and restored by .RE. .TH t s c n Set the title and entry heading; t is the title, s is the section number, c is extra commentary, e.g., ``local,'' n is new manual name. Invokes .DT (see below). .SH text Place subhead text, e.g., SYNOPSIS, here. .SS text Place sub-subhead text, e.g., ``Options'', here. .B text Make text bold. .I text Make text italic. .SM text Make text 1 point smaller than default point size. .RI a b Concatenate roman a with italic b, and alternate these two fonts for up to six arguments. Simi- April, 1990 1
man(5) man(5)lar macros alternate between any two of roman, italic, and bold: .IR .RB .BR .IB .BI .P Begin a paragraph with normal font, point size, and indent. .PP is a synonym for .P. .HP in Begin paragraph with hanging indent. .TP in Begin indented paragraph with hanging tag. The next line that contains text to be printed is taken as the tag. If the tag does not fit, it is printed on a separate line. .IP t in Same as .TP in with tag t; often used to get an indented paragraph without a tag. .RS in Increase relative indent (initially zero). In- dent all output an extra in units from the current left margin. .RE k Return to the kth relative indent level (ini- tially, k=1; k=0 is equivalent to k=1); if k is omitted, return to the most recent lower indent level. .PM m Produces proprietary markings; see mm(1). .DT Restore default tab settings (every 7.2 ens in troff(1), 5 ens in nroff(1)). .PD v Set the interparagraph distance to v vertical spaces. If v is omitted, set the interparagraph distance to the default value (0.4v in troff(1), 1v in nroff(1)). The following strings are defined: \*R ``(Reg.)'' in nroff(1), ``Registered'' symbol in troff(1). \*S Change to default type size. \*(Tm Trademark indicator. The following number registers are given default values by .TH: IN Left margin indent relative to subheads (default is 7.2 ens in troff(1), 5 ens in nroff(1)). LL Line length including IN. PD Current interparagraph distance. EXAMPLES The man macros are provided to process manual pages already on-line at a given location and to enable users to make their own manual pages. The preceding section demonstrated the usage of the macros themselves; the following section provides examples of command lines typically used to process the completed files. man macros are designed to run with either nroff or troff. The first command line will process a file using only macros 2 April, 1990
man(5) man(5)and nroff requests: nroff -Tlp -man file | lp The file is piped to the local line printer, lp. The next command line will process a file containing tables as well as macros and nroff requests: tbl | nroff -Tlp -man file | col | lp Notice that before it is sent to the line printer, the out- put is first filtered through col, to process the reverse line feeds used by tbl. The final example is a command line that processes an unusu- al manual page, one using pic. If the manual pages created with man are intended for an on-line facility, components requiring troff, such as pic (or grap) should be avoided since the average installation of terminals will not be able to process typeset documents. pic file | tbl | troff -Taps -man | typesetter grap precedes pic because it is a preprocessor to pic; the reverse order, of course, will not format correctly. The file contains one or more tables, requiring tbl, but col is no longer necessary because typeset documents do not use re- verse line feeds with which to make tables. The -T flag op- tion for specifying the output device (terminal type) takes the argument aps here, readying the document for processing on the APS-5 phototypesetter. CAVEATS Special macros, strings, and number registers exist, inter- nal to man, in addition to those mentioned above. Except for names predefined by troff(1) and number registers d, m, and y, all such internal names are of the form XA, where X is one of ), ], and }, and A stands for any alphanumeric character. The programs that prepare the table of contents and the per- muted index for this manual assume the NAME section of each entry consists of a single line of input that has the fol- lowing format: name[,name,name...] \- explanatory text The macro package increases the interword spaces (to elim- inate ambiguity) in the SYNOPSIS section of each entry. April, 1990 3
man(5) man(5)The macro package itself uses only the roman font (so that one can replace, for example, the bold font by the constant-width font (CW). Of course, if the input text of an entry contains requests for other fonts (e.g., .I, .RB, \fI), the corresponding fonts must be mounted. FILES /usr/lib/tmac/tmac.an /usr/lib/macros/cmp.n.[dt].an /usr/lib/macros/ucmp.n.an SEE ALSO eqn(1), man(1), tbl(1), tc(1), troff(1). ``Other Text Processing Tools'' in A/UX Text Processing Tools. BUGS If the argument to .TH contains any blanks and is not en- closed by double quotes (""), there will be strange irregu- lar dots on the output. 4 April, 1990