1 '\" te
2 .\" Copyright (c) 1995, Sun Microsystems, Inc.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH MAN 5 "Jan 30, 1995"
7 .SH NAME
8 man \- macros to format Reference Manual pages
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBnroff\fR \fB-man\fR \fIfilename\fR...
13 .fi
14
15 .LP
16 .nf
17 \fBtroff\fR \fB-man\fR \fIfilename\fR...
18 .fi
19
20 .SH DESCRIPTION
21 .sp
22 .LP
23 These macros are used to lay out the reference pages in this manual. Note: if
24 \fIfilename\fR contains format input for a preprocessor, the commands shown
25 above must be piped through the appropriate preprocessor. This is handled
26 automatically by the \fBman\fR(1) command. See the ``Conventions'' section.
27 .sp
28 .LP
29 Any text argument \fIt\fR may be zero to six words. Quotes may be used to
30 include SPACE characters in a "word". If \fItext\fR is empty, the special
31 treatment is applied to the next input line with text to be printed. In this
32 way \fB\&.I\fR may be used to italicize a whole line, or \fB\&.SB\fR may be
33 used to make small bold letters.
34 .sp
35 .LP
36 A prevailing indent distance is remembered between successive indented
37 paragraphs, and is reset to default value upon reaching a non-indented
38 paragraph. Default units for indents \fIi\fR are ens.
39 .sp
40 .LP
41 Type font and size are reset to default values before each paragraph, and after
42 processing font and size setting macros.
43 .sp
44 .LP
45 These strings are predefined by \fB-man\fR:
46 .sp
47 .ne 2
48 .na
49 \fB\fB\e*R\fR\fR
50 .ad
51 .RS 8n
52 `\(rg', `(Reg)' in \fBnroff\fR.
53 .RE
54
55 .sp
56 .ne 2
57 .na
58 \fB\fB\e*S\fR\fR
59 .ad
60 .RS 8n
61 Change to default type size.
62 .RE
63
64 .SS "Requests"
65 .sp
66 .LP
67 * n.t.l. = next text line; p.i. = prevailing indent
68 .sp
69
70 .sp
71 .TS
72 c c c c
73 c c c c .
74 \fIRequest\fR \fICause\fR \fIIf no\fR \fIExplanation\fR
75 \fIBreak\fR \fIArgument\fR
76 \fB\&.B \fR\fIt\fR no \fIt\fR=n.t.l.* Text is in bold font.
77 \fB\&.BI \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating bold and italic.
78 \fB\&.BR \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating bold and roman.
79 \fB\&.DT\fR no \&.5i 1i... Restore default tabs.
80 \fB\&.HP \fR\fIi\fR yes \fIi\fR=p.i.* T{
81 Begin paragraph with hanging indent. Set prevailing indent to \fIi\fR.
82 T}
83 \fB\&.I \fR\fIt\fR no \fIt\fR=n.t.l. Text is italic.
84 \fB\&.IB \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating italic and bold.
85 \fB\&.IP \fR\fIx i\fR yes \fIx\fR="" Same as \fB\&.TP\fR with tag \fIx\fR.
86 \fB\&.IR \fR\fIt\fR no \fIt\fR=n.t.l. T{
87 Join words, alternating italic and roman.
88 T}
89 \fB\&.IX \fR\fIt\fR no - Index macro, for SunSoft internal use.
90 \fB\&.LP\fR yes - T{
91 Begin left-aligned paragraph. Set prevailing indent to .5i.
92 T}
93 \fB\&.P\fR yes - Same as \fB\&.LP\fR.
94 \fB\&.PD \fR\fId\fR no \fId\fR=.4v T{
95 Set vertical distance between paragraphs.
96 T}
97 \fB\&.PP\fR yes - Same as \fB\&.LP\fR.
98 \fB\&.RE\fR yes - T{
99 End of relative indent. Restores prevailing indent.
100 T}
101 \fB\&.RB \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating roman and bold.
102 \fB\&.RI \fR\fIt\fR no \fIt\fR=n.t.l. T{
103 Join words, alternating roman and italic.
104 T}
105 \fB\&.RS \fR\fIi\fR yes \fIi\fR=p.i. T{
106 Start relative indent, increase indent by \fIi\fR. Sets prevailing indent to .5i for nested indents.
107 T}
108 \fB\&.SB \fR\fIt\fR no - T{
109 Reduce size of text by 1 point, make text bold.
110 T}
111 \fB\&.SH \fR\fIt\fR yes - Section Heading.
112 \fB\&.SM \fR\fIt\fR no \fIt\fR=n.t.l. Reduce size of text by 1 point.
113 \fB\&.SS \fR\fIt\fR yes \fIt\fR=n.t.l. Section Subheading.
114 \fB\&.TH \FR\FIN S "f d, m\fR"
115 \fB\&.TH \fR\fIn s d f m\fR yes - T{
116 Begin reference page \fIn\fR, of of section \fIs\fR; \fId\fR is the date of the most recent change. If present, \fIf\fR is the left page footer; \fIm\fR is the main page (center) header. Sets prevailing indent and tabs to .5i.
117 T}
118 \fB\&.TP \fR\fIi\fR yes \fIi\fR=p.i. T{
119 Begin indented paragraph, with the tag given on the next text line. Set prevailing indent to \fIi\fR.
120 T}
121 \fB\&.TX \fR\fIt \fR\fIp\fR no - T{
122 Resolve the title abbreviation \fIt\fR; join to punctuation mark (or text) \fIp\fR.
123 T}
124 .TE
125
126 .SS "Conventions"
127 .sp
128 .LP
129 When formatting a manual page, \fBman\fR examines the first line to determine
130 whether it requires special processing. For example a first line consisting of:
131 .sp
132 .LP
133 \fB\&'\e" t\fR
134 .sp
135 .LP
136 indicates that the manual page must be run through the \fBtbl\fR(1)
137 preprocessor.
138 .sp
139 .LP
140 A typical manual page for a command or function is laid out as follows:
141 .sp
142 .ne 2
143 .na
144 \fB\&.TH\fI TITLE \FR[1-9]\FR " , "
145 .ad
146 .RS 23n
147 The name of the command or function, which serves as the title of the manual
148 page. This is followed by the number of the section in which it appears.
149 .RE
150
151 .sp
152 .ne 2
153 .na
154 \fB\&.SH NAME\fR
155 .ad
156 .RS 23n
157 The name, or list of names, by which the command is called, followed by a dash
158 and then a one-line summary of the action performed. All in roman font, this
159 section contains no \fBtroff\fR(1) commands or escapes, and no macro requests.
160 It is used to generate the \fBwindex\fR database, which is used by the
161 \fBwhatis\fR(1) command.
162 .RE
163
164 .sp
165 .ne 2
166 .na
167 \fB\&.SH SYNOPSIS\fR
168 .ad
169 .RS 23n
170 .sp
171 .ne 2
172 .na
173 \fBCommands:\fR
174 .ad
175 .RS 13n
176 The syntax of the command and its arguments, as typed on the command line.
177 When in boldface, a word must be typed exactly as printed. When in italics, a
178 word can be replaced with an argument that you supply. References to bold or
179 italicized items are not capitalized in other sections, even when they begin a
180 sentence.
181 .sp
182 Syntactic symbols appear in roman face:
183 .sp
184 .ne 2
185 .na
186 \fB[ ]\fR
187 .ad
188 .RS 13n
189 An argument, when surrounded by brackets is optional.
190 .RE
191
192 .sp
193 .ne 2
194 .na
195 \fB|\fR
196 .ad
197 .RS 13n
198 Arguments separated by a vertical bar are exclusive. You can supply only one
199 item from such a list.
200 .RE
201
202 .sp
203 .ne 2
204 .na
205 \fB\&.\|.\|.\fR
206 .ad
207 .RS 13n
208 Arguments followed by an ellipsis can be repeated. When an ellipsis follows a
209 bracketed set, the expression within the brackets can be repeated.
210 .RE
211
212 .RE
213
214 .sp
215 .ne 2
216 .na
217 \fBFunctions:\fR
218 .ad
219 .RS 14n
220 If required, the data declaration, or \fB#include\fR directive, is shown first,
221 followed by the function declaration. Otherwise, the function declaration is
222 shown.
223 .RE
224
225 .RE
226
227 .sp
228 .ne 2
229 .na
230 \fB\&.SH DESCRIPTION\fR
231 .ad
232 .RS 23n
233 A narrative overview of the command or function's external behavior. This
234 includes how it interacts with files or data, and how it handles the standard
235 input, standard output and standard error. Internals and implementation details
236 are normally omitted. This section attempts to provide a succinct overview in
237 answer to the question, "what does it do?"
238 .sp
239 Literal text from the synopsis appears in constant width, as do literal
240 filenames and references to items that appear elsewhere in the reference
241 manuals. Arguments are italicized.
242 .sp
243 If a command interprets either subcommands or an input grammar, its command
244 interface or input grammar is normally described in a \fBUSAGE\fR section,
245 which follows the \fBOPTIONS\fR section. The \fBDESCRIPTION\fR section only
246 describes the behavior of the command itself, not that of subcommands.
247 .RE
248
249 .sp
250 .ne 2
251 .na
252 \fB\&.SH OPTIONS\fR
253 .ad
254 .RS 23n
255 The list of options along with a description of how each affects the command's
256 operation.
257 .RE
258
259 .sp
260 .ne 2
261 .na
262 \fB\&.SH RETURN VALUES\fR
263 .ad
264 .RS 23n
265 A list of the values the library routine will return to the calling program
266 and the conditions that cause these values to be returned.
267 .RE
268
269 .sp
270 .ne 2
271 .na
272 \fB\&.SH EXIT STATUS\fR
273 .ad
274 .RS 23n
275 A list of the values the utility will return to the calling program or shell,
276 and the conditions that cause these values to be returned.
277 .RE
278
279 .sp
280 .ne 2
281 .na
282 \fB\&.SH FILES\fR
283 .ad
284 .RS 23n
285 A list of files associated with the command or function.
286 .RE
287
288 .sp
289 .ne 2
290 .na
291 \fB\&.SH SEE ALSO\fR
292 .ad
293 .RS 23n
294 A comma-separated list of related manual pages, followed by references to other
295 published materials.
296 .RE
297
298 .sp
299 .ne 2
300 .na
301 \fB\&.SH DIAGNOSTICS\fR
302 .ad
303 .RS 23n
304 A list of diagnostic messages and an explanation of each.
305 .RE
306
307 .sp
308 .ne 2
309 .na
310 \fB\&.SH BUGS\fR
311 .ad
312 .RS 23n
313 A description of limitations, known defects, and possible problems associated
314 with the command or function.
315 .RE
316
317 .SH FILES
318 .sp
319 .ne 2
320 .na
321 \fB\fB/usr/share/lib/tmac/an\fR \fR
322 .ad
323 .RS 27n
324
325 .RE
326
327 .sp
328 .ne 2
329 .na
330 \fB\fB/usr/share/man/windex\fR\fR
331 .ad
332 .RS 27n
333
334 .RE
335
336 .SH SEE ALSO
337 .sp
338 .LP
339 \fBman\fR(1), \fBnroff\fR(1), \fBtroff\fR(1), \fBwhatis\fR(1)
340 .sp
341 .LP
342 Dale Dougherty and Tim O'Reilly, \fIUnix\fR \fIText\fR \fIProcessing\fR