| blob | 317e38c321f8619148ac37c36e8146d34644fd07 |
1 '\" te
2 .\" Copyright (c) 2017 Peter Tribble.
3 .\" Copyright (c) 1992, Sun Microsystems, Inc.
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH MANSUN 5 "Apr 2, 2017"
8 .SH NAME
9 mansun \- macros to format Reference Manual pages
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBnroff\fR \fB-mansun\fR \fIfilename\fR...
14 .fi
16 .LP
17 .nf
18 \fBtroff\fR \fB-mansun\fR \fIfilename\fR...
19 .fi
21 .SH DESCRIPTION
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 \fBman\fR(1). 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-mansun\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
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
64 .SS "Requests"
65 .LP
66 * n.t.l. = next text line; p.i. = prevailing indent
67 .sp
69 .sp
70 .TS
71 c c c c
72 c c c c .
73 \fIRequest\fR \fICause\fR \fIIf no\fR \fIExplanation\fR
74 \fIBreak\fR \fIArgument\fR
75 \fB\&.B \fR\fIt\fR no \fIt\fR=n.t.l.* Text is in bold font.
76 \fB\&.BI \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating bold and italic.
77 \fB\&.BR \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating bold and Roman.
78 \fB\&.DT\fR no \&.5i 1i... Restore default tabs.
79 \fB\&.HP \fR\fIi\fR yes \fIi\fR=p.i.* T{
80 Begin paragraph with hanging indent. Set prevailing indent to \fIi\fR.
81 T}
82 \fB\&.I \fR\fIt\fR no \fIt\fR=n.t.l. Text is italic.
83 \fB\&.IB \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating italic and bold.
84 \fB\&.IP \fR\fIx i\fR yes \fIx\fR="" Same as \fB\&.TP\fR with tag \fIx\fR.
85 \fB\&.IR \fR\fIt\fR no \fIt\fR=n.t.l. T{
86 Join words, alternating italic and Roman.
87 T}
88 \fB\&.IX \fR\fIt\fR no - Index macro, for SunSoft internal use.
89 \fB\&.LP\fR yes - T{
90 Begin left-aligned paragraph. Set prevailing indent to .5i.
91 T}
92 \fB\&.P\fR yes - Same as \fB\&.LP\fR.
93 \fB\&.PD \fR\fId\fR no \fId\fR=.4v T{
94 Set vertical distance between paragraphs.
95 T}
96 \fB\&.PP\fR yes - Same as \fB\&.LP\fR.
97 \fB\&.RE\fR yes - T{
98 End of relative indent. Restores prevailing indent.
99 T}
100 \fB\&.RB \fR\fIt\fR no \fIt\fR=n.t.l. Join words, alternating Roman and bold.
101 \fB\&.RI \fR\fIt\fR no \fIt\fR=n.t.l. T{
102 Join words, alternating Roman and italic.
103 T}
104 \fB\&.RS \fR\fIi\fR yes \fIi\fR=p.i. T{
105 Start relative indent, increase indent by \fIi\fR. Sets prevailing indent to .5i for nested indents.
106 T}
107 \fB\&.SB \fR\fIt\fR no - T{
108 Reduce size of text by 1 point, make text bold.
109 T}
110 \fB\&.SH \fR\fIt\fR yes - Section Heading.
111 \fB\&.SM \fR\fIt\fR no \fIt\fR=n.t.l. Reduce size of text by 1 point.
112 \fB\&.SS \fR\fIt\fR yes \fIt\fR=n.t.l. Section Subheading.
113 \fB\&.TH \FR\FIN S "f d, m\fR"
114 \fB\&.TH \fR\fIn s d f m\fR yes - T{
115 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.
116 T}
117 \fB\&.TP \fR\fIi\fR yes \fIi\fR=p.i. T{
118 Begin indented paragraph, with the tag given on the next text line. Set prevailing indent to \fIi\fR.
119 T}
120 \fB\&.TX \fR\fIt \fR\fIp\fR no - T{
121 Resolve the title abbreviation \fIt\fR; join to punctuation mark (or text) \fIp\fR.
122 T}
123 .TE
125 .SS "Conventions"
126 .LP
127 When formatting a manual page, \fBmansun\fR examines the first line to
128 determine whether it requires special processing. For example a first line
129 consisting of:
130 .sp
131 .LP
132 \fB\&'\e" t\fR
133 .sp
134 .LP
135 indicates that the manual page must be run through the \fBtbl\fR(1)
136 preprocessor.
137 .sp
138 .LP
139 A typical manual page for a command or function is laid out as follows:
140 .sp
141 .ne 2
142 .na
143 \fB\&.TH\fI TITLE \FR[1-8]\FR " , "
144 .ad
145 .RS 21n
146 The name of the command or function, which serves as the title of the manual
147 page. This is followed by the number of the section in which it appears.
148 .RE
150 .sp
151 .ne 2
152 .na
153 \fB\&.SH NAME\fR
154 .ad
155 .RS 21n
156 The name, or list of names, by which the command is called, followed by a dash
157 and then a one-line summary of the action performed. All in Roman font, this
158 section contains no \fBtroff\fR(1) commands or escapes, and no macro requests.
159 It is used to generate the \fBwhatis\fR database, which is used by the
160 \fBwhatis\fR(1) and \fBapropos\fR(1) commands.
161 .RE
163 .sp
164 .ne 2
165 .na
166 \fB\&.SH SYNOPSIS\fR
167 .ad
168 .RS 21n
169 .sp
170 .ne 2
171 .na
172 \fBCommands:\fR
173 .ad
174 .RS 13n
175 The syntax of the command and its arguments, as typed on the command line.
176 When in boldface, a word must be typed exactly as printed. When in italics, a
177 word can be replaced with an argument that you supply. References to bold or
178 italicized items are not capitalized in other sections, even when they begin a
179 sentence.
180 .sp
181 Syntactic symbols appear in Roman face:
182 .sp
183 .ne 2
184 .na
185 \fB[ ]\fR
186 .ad
187 .RS 13n
188 An argument, when surrounded by brackets is optional.
189 .RE
191 .sp
192 .ne 2
193 .na
194 \fB|\fR
195 .ad
196 .RS 13n
197 Arguments separated by a vertical bar are exclusive. You can supply only one
198 item from such a list.
199 .RE
201 .sp
202 .ne 2
203 .na
204 \fB\&.\|.\|.\fR
205 .ad
206 .RS 13n
207 Arguments followed by an ellipsis can be repeated. When an ellipsis follows a
208 bracketed set, the expression within the brackets can be repeated.
209 .RE
211 .RE
213 .sp
214 .ne 2
215 .na
216 \fBFunctions:\fR
217 .ad
218 .RS 14n
219 If required, the data declaration, or \fB#include\fR directive, is shown first,
220 followed by the function declaration. Otherwise, the function declaration is
221 shown.
222 .RE
224 .RE
226 .sp
227 .ne 2
228 .na
229 \fB\&.SH DESCRIPTION\fR
230 .ad
231 .RS 21n
232 A narrative overview of the command or function's external behavior. This
233 includes how it interacts with files or data, and how it handles the standard
234 input, standard output and standard error. Internals and implementation details
235 are normally omitted. This section attempts to provide a succinct overview in
236 answer to the question, "what does it do?"
237 .sp
238 Literal text from the synopsis appears in constant width, as do literal
239 filenames and references to items that appear elsewhere in the reference
240 manuals. Arguments are italicized.
241 .sp
242 If a command interprets either subcommands or an input grammar, its command
243 interface or input grammar is normally described in a \fBUSAGE\fR section,
244 which follows the \fBOPTIONS\fR section. The \fBDESCRIPTION\fR section only
245 describes the behavior of the command itself, not that of subcommands.
246 .RE
248 .sp
249 .ne 2
250 .na
251 \fB\&.SH OPTIONS\fR
252 .ad
253 .RS 21n
254 The list of options along with a description of how each affects the command's
255 operation.
256 .RE
258 .sp
259 .ne 2
260 .na
261 \fB\&.SH FILES\fR
262 .ad
263 .RS 21n
264 A list of files associated with the command or function.
265 .RE
267 .sp
268 .ne 2
269 .na
270 \fB\&.SH SEE ALSO\fR
271 .ad
272 .RS 21n
273 A comma-separated list of related manual pages, followed by references to other
274 published materials.
275 .RE
277 .sp
278 .ne 2
279 .na
280 \fB\&.SH DIAGNOSTICS\fR
281 .ad
282 .RS 21n
283 A list of diagnostic messages and an explanation of each.
284 .RE
286 .sp
287 .ne 2
288 .na
289 \fB\&.SH BUGS\fR
290 .ad
291 .RS 21n
292 A description of limitations, known defects, and possible problems associated
293 with the command or function.
294 .RE
296 .SH FILES
297 .ne 2
298 .na
299 \fB\fB/usr/share/lib/tmac/ansun\fR\fR
300 .ad
301 .RS 29n
303 .RE
305 .SH SEE ALSO
306 .LP
307 \fBman\fR(1), \fBnroff\fR(1), \fBtroff\fR(1)
308 .sp
309 .LP
310 Dale Dougherty and Tim O'Reilly, \fIUnix\fR \fIText\fR \fIProcessing\fR
312 .SH NOTES
313 .LP
314 New manual pages should be coded in the \fBmdoc\fR(5) format.