1mansun(5) Standards, Environments, and Macros mansun(5)
2
6 mansun - macros to format Reference Manual pages
7
9 nroff -mansun filename...
10 troff -mansun filename...
13
16 These macros are used to lay out the reference pages in this manual.
17 Note: if filename contains format input for a preprocessor, the com‐
18 mands shown above must be piped through the appropriate preprocessor.
19 This is handled automatically by man(1). See the ``Conventions'' sec‐
20 tion.
21 Any text argument t may be zero to six words. Quotes may be used to
24 include SPACE characters in a "word". If text is empty, the special
25 treatment is applied to the next input line with text to be printed. In
26 this way .I may be used to italicize a whole line, or .SB may be used
27 to make small bold letters.
28 A prevailing indent distance is remembered between successive indented
31 paragraphs, and is reset to default value upon reaching a non-indented
32 paragraph. Default units for indents i are ens.
33 Type font and size are reset to default values before each paragraph,
36 and after processing font and size setting macros.
37 These strings are predefined by -mansun:
40 \*R `®', `(Reg)' in nroff.
42 \*S Change to default type size.
45 Requests
48 * n.t.l. = next text line; p.i. = prevailing indent
49 Request Cause If no Explanation
54 Break Argument
55 .B t no t=n.t.l.* Text is in bold font.
56 .BI t no t=n.t.l. Join words, alternating bold and italic.
57 .BR t no t=n.t.l. Join words, alternating bold and Roman.
58 .DT no .5i 1i... Restore default tabs.
59 .HP i yes i=p.i.* Begin paragraph with hanging indent. Set
60 prevailing indent to i.
61 .I t no t=n.t.l. Text is italic.
62 .IB t no t=n.t.l. Join words, alternating italic and bold.
63 .IP x i yes x="" Same as .TP with tag x.
64 .IR t no t=n.t.l. Join words, alternating italic and
65 Roman.
66 .IX t no - Index macro, for SunSoft internal use.
68 .LP yes - Begin left-aligned paragraph. Set pre‐
69 vailing indent to .5i.
70 .P yes - Same as .LP.
71 .PD d no d=.4v Set vertical distance between para‐
72 graphs.
73 .PP yes - Same as .LP.
74 .RE yes - End of relative indent. Restores pre‐
75 vailing indent.
76 .RB t no t=n.t.l. Join words, alternating Roman and bold.
77 .RI t no t=n.t.l. Join words, alternating Roman and
78 italic.
79 .RS i yes i=p.i. Start relative indent, increase indent
80 by i. Sets prevailing indent to .5i for
81 nested indents.
82 .SB t no - Reduce size of text by 1 point, make
83 text bold.
84 .SH t yes - Section Heading.
85 .SM t no t=n.t.l. Reduce size of text by 1 point.
86 .SS t yes t=n.t.l. Section Subheading.
87 .TH n s d f m yes - Begin reference page n, of of section s;
88 d is the date of the most recent change.
89 If present, f is the left page footer; m
90 is the main page (center) header. Sets
91 prevailing indent and tabs to .5i.
92 .TP i yes i=p.i. Begin indented paragraph, with the tag
93 given on the next text line. Set pre‐
94 vailing indent to i.
95 .TX t p no - Resolve the title abbreviation t; join
96 to punctuation mark (or text) p.
97 Conventions
100 When formatting a manual page, mansun examines the first line to deter‐
101 mine whether it requires special processing. For example a first line
102 consisting of:
103 '\" t
106 indicates that the manual page must be run through the tbl(1) pre‐
109 processor.
110 A typical manual page for a command or function is laid out as follows:
113 .TH title [1-8] The name of the command or function, which serves
115 as the title of the manual page. This is followed
116 by the number of the section in which it appears.
117 .SH NAME The name, or list of names, by which the command
120 is called, followed by a dash and then a one-line
121 summary of the action performed. All in Roman
122 font, this section contains no troff(1) commands
123 or escapes, and no macro requests. It is used to
124 generate the windex database, which is used by the
125 whatis(1) command.
126 .SH SYNOPSIS
129 Commands: The syntax of the command and its
130 arguments, as typed on the command
131 line. When in boldface, a word must
132 be typed exactly as printed. When in
133 italics, a word can be replaced with
134 an argument that you supply. Refer‐
135 ences to bold or italicized items are
136 not capitalized in other sections,
137 even when they begin a sentence.
138 Syntactic symbols appear in Roman
140 face:
141 [ ] An argument, when sur‐
143 rounded by brackets is
144 optional.
145 | Arguments separated by a
148 vertical bar are exclu‐
149 sive. You can supply
150 only one item from such
151 a list.
152 ... Arguments followed by an
155 ellipsis can be
156 repeated. When an ellip‐
157 sis follows a bracketed
158 set, the expression
159 within the brackets can
160 be repeated.
161 Functions: If required, the data declaration,
165 or #include directive, is shown
166 first, followed by the function
167 declaration. Otherwise, the function
168 declaration is shown.
169 .SH DESCRIPTION A narrative overview of the command or function's
173 external behavior. This includes how it interacts
174 with files or data, and how it handles the stan‐
175 dard input, standard output and standard error.
176 Internals and implementation details are normally
177 omitted. This section attempts to provide a suc‐
178 cinct overview in answer to the question, "what
179 does it do?"
180 Literal text from the synopsis appears in constant
182 width, as do literal filenames and references to
183 items that appear elsewhere in the reference man‐
184 uals. Arguments are italicized.
185 If a command interprets either subcommands or an
187 input grammar, its command interface or input
188 grammar is normally described in a USAGE section,
189 which follows the OPTIONS section. The DESCRIP‐
190 TION section only describes the behavior of the
191 command itself, not that of subcommands.
192 .SH OPTIONS The list of options along with a description of
195 how each affects the command's operation.
196 .SH FILES A list of files associated with the command or
199 function.
200 .SH SEE ALSO A comma-separated list of related manual pages,
203 followed by references to other published materi‐
204 als.
205 .SH DIAGNOSTICS A list of diagnostic messages and an explanation
208 of each.
209 .SH BUGS A description of limitations, known defects, and
212 possible problems associated with the command or
213 function.
214
217 /usr/share/lib/tmac/ansun
218 /usr/share/man/windex
221
224 man(1), nroff(1), troff(1), whatis(1)
225 Dale Dougherty and Tim O'Reilly, Unix Text Processing
228SunOS 5.11 11 Jun 1992 mansun(5)