1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\" must display the following acknowledgement:
15 .\" This product includes software developed by the University of
16 .\" California, Berkeley and its contributors.
17 .\" 4. Neither the name of the University nor the names of its contributors
18 .\" may be used to endorse or promote products derived from this software
19 .\" without specific prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" @(#)mdoc.7 8.2 (Berkeley) 12/30/93
35 .\" $Id: mdoc.7,v 1.8 1998/12/04 00:51:17 jkoshy Exp $
37 .\" The December 30, 1993 version
38 .\" Modified by David A. Wheeler (dwheeler@ida.org) on 1999-07-11
39 .\" to conform to Linux.
47 .Nd quick reference guide for the
57 package is a set of content-based and domain-based macros
61 The macro names and their meanings are
62 listed below for quick reference; for
63 a detailed explanation on using the package,
64 see the tutorial sampler
67 Note that this is not the usual macro package for Linux documentation,
68 although it is used for documentation of several widely used programs;
72 The macros are described in two groups, the first
73 includes the structural and physical page layout macros.
74 The second contains the manual and general text domain
75 macros which differentiate the
80 .Sh PAGE STRUCTURE DOMAIN
82 To create a valid manual page, these three macros, in this order,
84 .Bl -tag -width "xxxx.Os OPERATINGxSYSTEM [version/release]" -compact
85 .It Li "\&.Dd " Ar "Month day, year"
87 .It Li "\&.Dt " Ar "DOCUMENT_TITLE [section] [volume]"
89 .It Li "\&.Os " Ar "OPERATING_SYSTEM [version/release]"
93 .Ss Page Layout Macros
94 Section headers, paragraph breaks, lists and displays.
95 .Bl -tag -width flag -compact
98 Valid headers, in the order of presentation:
99 .Bl -tag -width "RETURN VALUE" -compact
101 Name section, should include the
111 General description, should include
112 options and parameters.
114 Sections two and three function calls.
116 Describe environment variables.
118 Files associated with the subject.
120 Examples and suggestions.
122 Normally used for section four device interface diagnostics.
124 Sections two and three error and signal
127 Cross references and citations.
129 Conformance to standards if applicable.
131 If a standard is not applicable, the history
132 of the subject should be given.
136 Customized headers may be added at
137 the authors discretion.
143 Vertical space (one line).
146 Indent and display one text line.
148 (D-ell) Display-one literal.
149 Indent and display one line of literal text.
153 .Bl -tag -width "xoffset string " -compact
155 Unjustified (ragged edges).
159 Literal text or code.
164 .It Fl offset Ar string
169 .Bl -tag -width indent-two -compact
171 Align block on left (default).
173 Approximate center margin.
175 Six constant width spaces (a tab).
179 Left aligns block 2 inches from
191 is a callable macro name.
199 End-display (matches \&.Bd).
202 Create lists or columns.
204 .Bl -tag -width flag -compact
206 .Bl -column ".Fl bullet" -compact
207 .It Fl bullet Ta "Bullet Item List"
208 .It Fl item Ta "Unlabeled List"
209 .It Fl enum Ta "Enumerated List"
210 .It Fl tag Ta "Tag Labeled List"
211 .It Fl diag Ta "Diagnostic List"
212 .It Fl hang Ta "Hanging Labeled List"
213 .It Fl ohang Ta "Overhanging Labeled List"
214 .It Fl inset Ta "Inset or Run-on Labeled List"
217 .Bl -tag -width "xcompact " -compact
231 Suppresses blank lines.
239 .Sh MANUAL AND GENERAL TEXT DOMAIN MACROS
240 The manual and general text domain macros are special in that
241 most of them are parsed for callable macros
243 .Bl -tag -width ".Op Fl s Ar filex" -offset indent
244 .It Li "\&.Op Fl s Ar file"
249 In this example, the option enclosure macro
251 is parsed, and calls the callable content macro
253 which operates on the argument
255 and then calls the callable content macro
257 which operates on the argument
259 Some macros may be callable, but are not parsed and vice versa.
260 These macros are indicated in the
266 Unless stated, manual domain macros share a common syntax:
268 .Dl \&.Va argument [\ .\ ,\ ;\ :\ (\ )\ [\ ]\ argument \...\ ]
272 punctuation characters are recognized as such only if they are presented
276 is not recognized as punctuation and will be output with a leading white
277 space and in what ever font the calling macro uses.
281 is recognized as three sequential closing punctuation characters
282 and a leading white space is not output between the characters
283 and the previous argument (if any).
284 The special meaning of a punctuation character may be escaped
287 For example the following string,
288 .Bl -tag -width "&.Ar file1\ , file2\ , file3\ )\ ." -offset indent
289 .It Li "\&.Ar file1\ , file2\ , file3\ )\ ."
291 .Ar file1 , file2 , file3 ) .
294 .Ss Manual Domain Macros
295 .Bl -column "Name" "Parsed" Callable" -compact
296 .It Em "Name Parsed Callable Description"
297 .It Li \&Ad Ta Yes Ta Yes Ta "Address. (This macro may be deprecated.)"
298 .It Li \&An Ta Yes Ta Yes Ta "Author name."
299 .It Li \&Ar Ta Yes Ta Yes Ta "Command-line argument."
300 .It Li \&Cd Ta \&No Ta \&No Ta "Configuration declaration (section four only)."
301 .It Li \&Cm Ta Yes Ta Yes Ta "Command-line argument modifier."
302 .It Li \&Dv Ta Yes Ta Yes Ta "Defined variable (source code)."
303 .It Li \&Er Ta Yes Ta Yes Ta "Error number (source code)."
304 .It Li \&Ev Ta Yes Ta Yes Ta "Environment variable."
305 .It Li \&Fa Ta Yes Ta Yes Ta "Function argument."
306 .It Li \&Fd Ta Yes Ta Yes Ta "Function declaration."
307 .It Li \&Fn Ta Yes Ta Yes Ta "Function call (also .Fo and .Fc)."
308 .It Li \&Ic Ta Yes Ta Yes Ta "Interactive command."
309 .It Li \&Li Ta Yes Ta Yes Ta "Literal text."
310 .It Li \&Nm Ta Yes Ta Yes Ta "Command name."
311 .It Li \&Op Ta Yes Ta Yes Ta "Option (also .Oo and .Oc)."
312 .It Li \&Ot Ta Yes Ta Yes Ta "Old style function type (Fortran only)."
313 .It Li \&Pa Ta Yes Ta Yes Ta "Pathname or filename."
314 .It Li \&St Ta Yes Ta Yes Ta "Standards (\-p1003.2, \-p1003.1 or \-ansiC)"
315 .It Li \&Va Ta Yes Ta Yes Ta "Variable name."
316 .It Li \&Vt Ta Yes Ta Yes Ta "Variable type (Fortran only)."
317 .It Li \&Xr Ta Yes Ta Yes Ta "Manual Page Cross Reference."
319 .Ss General Text Domain Macros
320 .Bl -column "Name" "Parsed" Callable" -compact
321 .It Em "Name Parsed Callable Description"
322 .It Li \&%A Ta Yes Ta \&No Ta "Reference author."
323 .It Li \&%B Ta Yes Ta Yes Ta "Reference book title."
324 .It Li \&%\&C Ta \&No Ta \&No Ta "Reference place of publishing (city)."
325 .It Li \&%\&D Ta \&No Ta \&No Ta "Reference date."
326 .It Li \&%J Ta Yes Ta Yes Ta "Reference journal title."
327 .It Li \&%N Ta \&No Ta \&No Ta "Reference issue number."
328 .It Li \&%\&O Ta \&No Ta \&No Ta "Reference optional information."
329 .It Li \&%P Ta \&No Ta \&No Ta "Reference page number(s)."
330 .It Li \&%R Ta \&No Ta \&No Ta "Reference report Name."
331 .It Li \&%T Ta Yes Ta Yes Ta "Reference article title."
332 .It Li \&%V Ta \&No Ta \&No Ta "Reference volume."
333 .It Li \&Ac Ta Yes Ta Yes Ta "Angle close quote."
334 .It Li \&Ao Ta Yes Ta Yes Ta "Angle open quote."
335 .It Li \&Ap Ta Yes Ta Yes Ta "Apostrophe."
336 .It Li \&Aq Ta Yes Ta Yes Ta "Angle quote."
337 .It Li \&At Ta \&No Ta \&No Ta Tn "AT&T UNIX"
338 .It Li \&Bc Ta Yes Ta Yes Ta "Bracket close quote."
339 .It Li \&Bf Ta \&No Ta \&No Ta "Begin font mode."
340 .It Li \&Bo Ta Yes Ta Yes Ta "Bracket open quote."
341 .It Li \&Bq Ta Yes Ta Yes Ta "Bracket quote."
342 .It Li \&Bx Ta Yes Ta Yes Ta Bx .
343 .It Li \&Db Ta \&No Ta \&No Ta "Debug (default is \*qoff\*q)"
344 .It Li \&Dc Ta Yes Ta Yes Ta "Double close quote."
345 .It Li \&Do Ta Yes Ta Yes Ta "Double open quote."
346 .It Li \&Dq Ta Yes Ta Yes Ta "Double quote."
347 .It Li \&Ec Ta Yes Ta Yes Ta "Enclose string close quote."
348 .It Li \&Ef Ta \&No Ta \&No Ta "End font mode."
349 .It Li \&Em Ta Yes Ta Yes Ta "Emphasis (traditional English)."
350 .It Li \&Eo Ta Yes Ta Yes Ta "Enclose string open quote."
351 .It Li \&Fx Ta \&No Ta \&No Ta Tn "FreeBSD operating system"
352 .It Li \&No Ta Yes Ta Yes Ta "Normal text (no-op)."
353 .It Li \&Ns Ta Yes Ta Yes Ta "No space."
354 .It Li \&Pc Ta Yes Ta Yes Ta "Parenthesis close quote."
355 .It Li \&Pf Ta Yes Ta \&No Ta "Prefix string."
356 .It Li \&Po Ta Yes Ta Yes Ta "Parenthesis open quote."
357 .It Li \&Pq Ta Yes Ta Yes Ta "Parentheses quote."
358 .It Li \&Qc Ta Yes Ta Yes Ta "Straight Double close quote."
359 .It Li \&Ql Ta Yes Ta Yes Ta "Quoted literal."
360 .It Li \&Qo Ta Yes Ta Yes Ta "Straight Double open quote."
361 .It Li \&Qq Ta Yes Ta Yes Ta "Straight Double quote."
362 .It Li \&Re Ta \&No Ta \&No Ta "Reference end."
363 .It Li \&Rs Ta \&No Ta \&No Ta "Reference start."
364 .It Li \&Rv Ta \&No Ta \&No Ta "Return values (sections two and three only)."
365 .It Li \&Sc Ta Yes Ta Yes Ta "Single close quote."
366 .It Li \&So Ta Yes Ta Yes Ta "Single open quote."
367 .It Li \&Sq Ta Yes Ta Yes Ta "Single quote."
368 .It Li \&Sm Ta \&No Ta \&No Ta "Space mode (default is \\*qon\\*q)"
369 .It Li \&Sx Ta Yes Ta Yes Ta "Section Cross Reference."
370 .It Li \&Sy Ta Yes Ta Yes Ta "Symbolic (traditional English)."
371 .It Li \&Tn Ta Yes Ta Yes Ta "Trade or type name (small Caps)."
372 .It Li \&Ux Ta Yes Ta Yes Ta Ux
373 .It Li \&Xc Ta Yes Ta Yes Ta "Extend argument list close."
374 .It Li \&Xo Ta Yes Ta Yes Ta "Extend argument list open."
376 .\" .It Sy \&Hf Ta \&No Ta \&No Ta "Include file with header"
378 Macro names ending in
380 quote remaining items on the argument list.
381 Macro names ending in
383 begin a quote which may span more than one line of input and
384 are close quoted with the matching macro name ending in
386 Enclosure macros may be nested and are limited to
389 Note: the extended argument list macros
392 and the function enclosure macros
396 The extended list macros are used when the number of macro arguments
399 limitation of nine arguments.
401 The macros UR (starting a URI/URL hypertext reference), UE (ending one),
402 and UN (identifying a target for a reference) are also available.
405 for more information on these macros.
406 .\" The following does not apply on Linux:
407 .\" .Sh CONFIGURATION
408 .\" For site specific configuration of the macro package,
410 .\" .Pa /usr/src/share/tmac/README .
412 .Bl -tag -width "tmac.doc-ditroff" -compact
414 Manual and general text domain macros.
415 .It Pa tmac/doc-common
416 Common structural macros and definitions.
417 .It Pa tmac/doc-nroff
421 .It Pa tmac/doc-ditroff
426 Special defines (such as the standards macro).