Annotation of mandoc/mdoc.7, Revision 1.247
1.247 ! schwarze 1: .\" $Id: mdoc.7,v 1.246 2014/12/28 15:23:33 schwarze Exp $
1.1 kristaps 2: .\"
1.179 schwarze 3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.223 schwarze 4: .\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
1.22 kristaps 7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: .\"
1.22 kristaps 10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.50 kristaps 17: .\"
1.247 ! schwarze 18: .Dd $Mdocdate: December 28 2014 $
1.20 kristaps 19: .Dt MDOC 7
1.1 kristaps 20: .Os
21: .Sh NAME
1.57 kristaps 22: .Nm mdoc
1.211 schwarze 23: .Nd semantic markup language for formatting manual pages
1.1 kristaps 24: .Sh DESCRIPTION
25: The
1.57 kristaps 26: .Nm mdoc
1.211 schwarze 27: language supports authoring of manual pages for the
28: .Xr man 1
29: utility by allowing semantic annotations of words, phrases,
30: page sections and complete manual pages.
31: Such annotations are used by formatting tools to achieve a uniform
32: presentation across all manuals written in
33: .Nm ,
34: and to support hyperlinking if supported by the output medium.
35: .Pp
36: This reference document describes the structure of manual pages
37: and the syntax and usage of the
1.200 kristaps 38: .Nm
1.211 schwarze 39: language.
40: The reference implementation of a parsing and formatting tool is
1.144 schwarze 41: .Xr mandoc 1 ;
42: the
1.57 kristaps 43: .Sx COMPATIBILITY
1.200 kristaps 44: section describes compatibility with other implementations.
1.57 kristaps 45: .Pp
1.211 schwarze 46: In an
1.57 kristaps 47: .Nm
1.211 schwarze 48: document, lines beginning with the control character
1.185 kristaps 49: .Sq \&.
1.211 schwarze 50: are called
51: .Dq macro lines .
52: The first word is the macro name.
53: It consists of two or three letters.
54: Most macro names begin with a capital letter.
55: For a list of available macros, see
56: .Sx MACRO OVERVIEW .
57: The words following the macro name are arguments to the macro, optionally
58: including the names of other, callable macros; see
59: .Sx MACRO SYNTAX
60: for details.
61: .Pp
62: Lines not beginning with the control character are called
63: .Dq text lines .
64: They provide free-form text to be printed; the formatting of the text
65: depends on the respective processing context:
1.57 kristaps 66: .Bd -literal -offset indent
1.13 kristaps 67: \&.Sh Macro lines change control state.
1.185 kristaps 68: Text lines are interpreted within the current state.
1.57 kristaps 69: .Ed
1.211 schwarze 70: .Pp
71: Many aspects of the basic syntax of the
1.57 kristaps 72: .Nm
1.211 schwarze 73: language are based on the
74: .Xr roff 7
75: language; see the
76: .Em LANGUAGE SYNTAX
77: and
78: .Em MACRO SYNTAX
79: sections in the
80: .Xr roff 7
81: manual for details, in particular regarding
82: comments, escape sequences, whitespace, and quoting.
83: However, using
84: .Xr roff 7
85: requests in
1.200 kristaps 86: .Nm
1.211 schwarze 87: documents is discouraged;
88: .Xr mandoc 1
89: supports some of them merely for backward compatibility.
1.43 kristaps 90: .Sh MANUAL STRUCTURE
1.66 kristaps 91: A well-formed
1.57 kristaps 92: .Nm
1.66 kristaps 93: document consists of a document prologue followed by one or more
94: sections.
95: .Pp
1.141 kristaps 96: The prologue, which consists of the
1.64 kristaps 97: .Sx \&Dd ,
98: .Sx \&Dt ,
1.33 kristaps 99: and
1.66 kristaps 100: .Sx \&Os
1.141 kristaps 101: macros in that order, is required for every document.
1.66 kristaps 102: .Pp
1.82 kristaps 103: The first section (sections are denoted by
1.66 kristaps 104: .Sx \&Sh )
105: must be the NAME section, consisting of at least one
1.64 kristaps 106: .Sx \&Nm
1.50 kristaps 107: followed by
1.66 kristaps 108: .Sx \&Nd .
109: .Pp
1.122 kristaps 110: Following that, convention dictates specifying at least the
111: .Em SYNOPSIS
112: and
113: .Em DESCRIPTION
114: sections, although this varies between manual sections.
1.66 kristaps 115: .Pp
116: The following is a well-formed skeleton
117: .Nm
1.188 kristaps 118: file for a utility
119: .Qq progname :
1.57 kristaps 120: .Bd -literal -offset indent
1.43 kristaps 121: \&.Dd $\&Mdocdate$
1.188 kristaps 122: \&.Dt PROGNAME section
1.43 kristaps 123: \&.Os
124: \&.Sh NAME
1.188 kristaps 125: \&.Nm progname
1.194 schwarze 126: \&.Nd one line about what it does
1.203 kristaps 127: \&.\e\(dq .Sh LIBRARY
1.227 schwarze 128: \&.\e\(dq For sections 2, 3, and 9 only.
1.203 kristaps 129: \&.\e\(dq Not used in OpenBSD.
1.58 kristaps 130: \&.Sh SYNOPSIS
1.188 kristaps 131: \&.Nm progname
1.58 kristaps 132: \&.Op Fl options
133: \&.Ar
134: \&.Sh DESCRIPTION
135: The
136: \&.Nm
137: utility processes files ...
1.228 schwarze 138: \&.\e\(dq .Sh CONTEXT
139: \&.\e\(dq For section 9 functions only.
1.203 kristaps 140: \&.\e\(dq .Sh IMPLEMENTATION NOTES
141: \&.\e\(dq Not used in OpenBSD.
142: \&.\e\(dq .Sh RETURN VALUES
1.227 schwarze 143: \&.\e\(dq For sections 2, 3, and 9 function return values only.
1.203 kristaps 144: \&.\e\(dq .Sh ENVIRONMENT
1.227 schwarze 145: \&.\e\(dq For sections 1, 6, 7, and 8 only.
1.203 kristaps 146: \&.\e\(dq .Sh FILES
147: \&.\e\(dq .Sh EXIT STATUS
1.227 schwarze 148: \&.\e\(dq For sections 1, 6, and 8 only.
1.203 kristaps 149: \&.\e\(dq .Sh EXAMPLES
150: \&.\e\(dq .Sh DIAGNOSTICS
1.227 schwarze 151: \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
1.203 kristaps 152: \&.\e\(dq .Sh ERRORS
1.227 schwarze 153: \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
1.203 kristaps 154: \&.\e\(dq .Sh SEE ALSO
155: \&.\e\(dq .Xr foobar 1
156: \&.\e\(dq .Sh STANDARDS
157: \&.\e\(dq .Sh HISTORY
158: \&.\e\(dq .Sh AUTHORS
159: \&.\e\(dq .Sh CAVEATS
160: \&.\e\(dq .Sh BUGS
161: \&.\e\(dq .Sh SECURITY CONSIDERATIONS
162: \&.\e\(dq Not used in OpenBSD.
1.57 kristaps 163: .Ed
164: .Pp
1.144 schwarze 165: The sections in an
1.66 kristaps 166: .Nm
1.100 kristaps 167: document are conventionally ordered as they appear above.
168: Sections should be composed as follows:
1.73 kristaps 169: .Bl -ohang -offset Ds
170: .It Em NAME
1.144 schwarze 171: The name(s) and a one line description of the documented material.
1.100 kristaps 172: The syntax for this as follows:
1.73 kristaps 173: .Bd -literal -offset indent
1.144 schwarze 174: \&.Nm name0 ,
175: \&.Nm name1 ,
1.73 kristaps 176: \&.Nm name2
1.144 schwarze 177: \&.Nd a one line description
1.73 kristaps 178: .Ed
179: .Pp
1.185 kristaps 180: Multiple
181: .Sq \&Nm
182: names should be separated by commas.
183: .Pp
1.73 kristaps 184: The
1.66 kristaps 185: .Sx \&Nm
1.73 kristaps 186: macro(s) must precede the
187: .Sx \&Nd
188: macro.
1.80 kristaps 189: .Pp
1.82 kristaps 190: See
1.80 kristaps 191: .Sx \&Nm
192: and
193: .Sx \&Nd .
1.73 kristaps 194: .It Em LIBRARY
195: The name of the library containing the documented material, which is
1.108 kristaps 196: assumed to be a function in a section 2, 3, or 9 manual.
1.100 kristaps 197: The syntax for this is as follows:
1.73 kristaps 198: .Bd -literal -offset indent
199: \&.Lb libarm
200: .Ed
201: .Pp
202: See
1.80 kristaps 203: .Sx \&Lb .
1.73 kristaps 204: .It Em SYNOPSIS
205: Documents the utility invocation syntax, function call syntax, or device
1.82 kristaps 206: configuration.
1.73 kristaps 207: .Pp
208: For the first, utilities (sections 1, 6, and 8), this is
209: generally structured as follows:
210: .Bd -literal -offset indent
1.185 kristaps 211: \&.Nm bar
1.73 kristaps 212: \&.Op Fl v
213: \&.Op Fl o Ar file
214: \&.Op Ar
1.185 kristaps 215: \&.Nm foo
1.73 kristaps 216: \&.Op Fl v
217: \&.Op Fl o Ar file
218: \&.Op Ar
219: .Ed
220: .Pp
1.185 kristaps 221: Commands should be ordered alphabetically.
222: .Pp
1.73 kristaps 223: For the second, function calls (sections 2, 3, 9):
224: .Bd -literal -offset indent
1.146 kristaps 225: \&.In header.h
1.73 kristaps 226: \&.Vt extern const char *global;
227: \&.Ft "char *"
228: \&.Fn foo "const char *src"
229: \&.Ft "char *"
230: \&.Fn bar "const char *src"
231: .Ed
232: .Pp
1.185 kristaps 233: Ordering of
234: .Sx \&In ,
235: .Sx \&Vt ,
236: .Sx \&Fn ,
237: and
238: .Sx \&Fo
239: macros should follow C header-file conventions.
240: .Pp
1.73 kristaps 241: And for the third, configurations (section 4):
242: .Bd -literal -offset indent
1.203 kristaps 243: \&.Cd \(dqit* at isa? port 0x2e\(dq
244: \&.Cd \(dqit* at isa? port 0x4e\(dq
1.73 kristaps 245: .Ed
246: .Pp
1.82 kristaps 247: Manuals not in these sections generally don't need a
1.73 kristaps 248: .Em SYNOPSIS .
1.80 kristaps 249: .Pp
1.122 kristaps 250: Some macros are displayed differently in the
251: .Em SYNOPSIS
252: section, particularly
253: .Sx \&Nm ,
1.80 kristaps 254: .Sx \&Cd ,
1.122 kristaps 255: .Sx \&Fd ,
256: .Sx \&Fn ,
257: .Sx \&Fo ,
258: .Sx \&In ,
259: .Sx \&Vt ,
260: and
261: .Sx \&Ft .
1.138 kristaps 262: All of these macros are output on their own line.
1.144 schwarze 263: If two such dissimilar macros are pairwise invoked (except for
1.122 kristaps 264: .Sx \&Ft
265: before
266: .Sx \&Fo
267: or
1.123 kristaps 268: .Sx \&Fn ) ,
1.122 kristaps 269: they are separated by a vertical space, unless in the case of
270: .Sx \&Fo ,
1.80 kristaps 271: .Sx \&Fn ,
1.122 kristaps 272: and
1.80 kristaps 273: .Sx \&Ft ,
1.122 kristaps 274: which are always separated by vertical space.
1.128 schwarze 275: .Pp
276: When text and macros following an
277: .Sx \&Nm
278: macro starting an input line span multiple output lines,
279: all output lines but the first will be indented to align
280: with the text immediately following the
281: .Sx \&Nm
282: macro, up to the next
283: .Sx \&Nm ,
1.141 kristaps 284: .Sx \&Sh ,
1.128 schwarze 285: or
286: .Sx \&Ss
287: macro or the end of an enclosing block, whichever comes first.
1.73 kristaps 288: .It Em DESCRIPTION
1.185 kristaps 289: This begins with an expansion of the brief, one line description in
290: .Em NAME :
291: .Bd -literal -offset indent
292: The
293: \&.Nm
294: utility does this, that, and the other.
295: .Ed
296: .Pp
297: It usually follows with a breakdown of the options (if documenting a
1.73 kristaps 298: command), such as:
299: .Bd -literal -offset indent
300: The arguments are as follows:
301: \&.Bl \-tag \-width Ds
302: \&.It Fl v
303: Print verbose information.
304: \&.El
305: .Ed
1.80 kristaps 306: .Pp
1.73 kristaps 307: Manuals not documenting a command won't include the above fragment.
1.198 schwarze 308: .Pp
309: Since the
310: .Em DESCRIPTION
311: section usually contains most of the text of a manual, longer manuals
312: often use the
313: .Sx \&Ss
314: macro to form subsections.
315: In very long manuals, the
316: .Em DESCRIPTION
317: may be split into multiple sections, each started by an
318: .Sx \&Sh
319: macro followed by a non-standard section name, and each having
320: several subsections, like in the present
321: .Nm
322: manual.
1.228 schwarze 323: .It Em CONTEXT
324: This section lists the contexts in which functions can be called in section 9.
325: The contexts are autoconf, process, or interrupt.
1.73 kristaps 326: .It Em IMPLEMENTATION NOTES
1.100 kristaps 327: Implementation-specific notes should be kept here.
328: This is useful when implementing standard functions that may have side
329: effects or notable algorithmic implications.
1.73 kristaps 330: .It Em RETURN VALUES
1.144 schwarze 331: This section documents the
332: return values of functions in sections 2, 3, and 9.
1.73 kristaps 333: .Pp
334: See
335: .Sx \&Rv .
336: .It Em ENVIRONMENT
1.141 kristaps 337: Lists the environment variables used by the utility,
338: and explains the syntax and semantics of their values.
339: The
340: .Xr environ 7
341: manual provides examples of typical content and formatting.
1.73 kristaps 342: .Pp
343: See
344: .Sx \&Ev .
345: .It Em FILES
1.100 kristaps 346: Documents files used.
1.141 kristaps 347: It's helpful to document both the file name and a short description of how
1.100 kristaps 348: the file is used (created, modified, etc.).
1.73 kristaps 349: .Pp
350: See
351: .Sx \&Pa .
1.99 kristaps 352: .It Em EXIT STATUS
1.144 schwarze 353: This section documents the
354: command exit status for section 1, 6, and 8 utilities.
1.100 kristaps 355: Historically, this information was described in
1.99 kristaps 356: .Em DIAGNOSTICS ,
357: a practise that is now discouraged.
358: .Pp
359: See
360: .Sx \&Ex .
1.73 kristaps 361: .It Em EXAMPLES
1.100 kristaps 362: Example usages.
363: This often contains snippets of well-formed, well-tested invocations.
1.144 schwarze 364: Make sure that examples work properly!
1.73 kristaps 365: .It Em DIAGNOSTICS
1.227 schwarze 366: Documents error messages.
367: In section 4 and 9 manuals, these are usually messages printed by the
368: kernel to the console and to the kernel log.
369: In section 1, 6, 7, and 8, these are usually messages printed by
370: userland programs to the standard error output.
371: .Pp
1.73 kristaps 372: Historically, this section was used in place of
373: .Em EXIT STATUS
374: for manuals in sections 1, 6, and 8; however, this practise is
375: discouraged.
376: .Pp
377: See
1.80 kristaps 378: .Sx \&Bl
379: .Fl diag .
1.73 kristaps 380: .It Em ERRORS
1.227 schwarze 381: Documents
382: .Xr errno 2
383: settings in sections 2, 3, 4, and 9.
1.73 kristaps 384: .Pp
385: See
386: .Sx \&Er .
387: .It Em SEE ALSO
1.100 kristaps 388: References other manuals with related topics.
389: This section should exist for most manuals.
390: Cross-references should conventionally be ordered first by section, then
1.238 schwarze 391: alphabetically (ignoring case).
1.73 kristaps 392: .Pp
1.198 schwarze 393: References to other documentation concerning the topic of the manual page,
394: for example authoritative books or journal articles, may also be
395: provided in this section.
396: .Pp
1.73 kristaps 397: See
1.198 schwarze 398: .Sx \&Rs
399: and
1.73 kristaps 400: .Sx \&Xr .
401: .It Em STANDARDS
1.100 kristaps 402: References any standards implemented or used.
403: If not adhering to any standards, the
1.73 kristaps 404: .Em HISTORY
405: section should be used instead.
406: .Pp
407: See
408: .Sx \&St .
409: .It Em HISTORY
1.198 schwarze 410: A brief history of the subject, including where it was first implemented,
411: and when it was ported to or reimplemented for the operating system at hand.
1.73 kristaps 412: .It Em AUTHORS
1.143 schwarze 413: Credits to the person or persons who wrote the code and/or documentation.
1.141 kristaps 414: Authors should generally be noted by both name and email address.
1.73 kristaps 415: .Pp
416: See
417: .Sx \&An .
418: .It Em CAVEATS
1.141 kristaps 419: Common misuses and misunderstandings should be explained
1.73 kristaps 420: in this section.
421: .It Em BUGS
1.147 kristaps 422: Known bugs, limitations, and work-arounds should be described
1.141 kristaps 423: in this section.
1.73 kristaps 424: .It Em SECURITY CONSIDERATIONS
425: Documents any security precautions that operators should consider.
1.66 kristaps 426: .El
1.211 schwarze 427: .Sh MACRO OVERVIEW
428: This overview is sorted such that macros of similar purpose are listed
429: together, to help find the best macro for any given purpose.
430: Deprecated macros are not included in the overview, but can be found below
431: in the alphabetical
432: .Sx MACRO REFERENCE .
433: .Ss Document preamble and NAME section macros
434: .Bl -column "Brq, Bro, Brc" description
435: .It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year
1.244 schwarze 436: .It Sx \&Dt Ta document title: Ar TITLE section Op Ar arch
1.211 schwarze 437: .It Sx \&Os Ta operating system version: Op Ar system Op Ar version
438: .It Sx \&Nm Ta document name (one argument)
439: .It Sx \&Nd Ta document description (one line)
440: .El
441: .Ss Sections and cross references
442: .Bl -column "Brq, Bro, Brc" description
443: .It Sx \&Sh Ta section header (one line)
444: .It Sx \&Ss Ta subsection header (one line)
445: .It Sx \&Sx Ta internal cross reference to a section or subsection
446: .It Sx \&Xr Ta cross reference to another manual page: Ar name section
447: .It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)
448: .El
449: .Ss Displays and lists
450: .Bl -column "Brq, Bro, Brc" description
451: .It Sx \&Bd , \&Ed Ta display block:
452: .Fl Ar type
453: .Op Fl offset Ar width
454: .Op Fl compact
455: .It Sx \&D1 Ta indented display (one line)
456: .It Sx \&Dl Ta indented literal display (one line)
457: .It Sx \&Bl , \&El Ta list block:
458: .Fl Ar type
459: .Op Fl width Ar val
460: .Op Fl offset Ar val
461: .Op Fl compact
462: .It Sx \&It Ta list item (syntax depends on Fl Ar type )
1.212 schwarze 463: .It Sx \&Ta Ta table cell separator in Sx \&Bl Fl column No lists
1.211 schwarze 464: .It Sx \&Rs , \&%* , \&Re Ta bibliographic block (references)
1.57 kristaps 465: .El
1.211 schwarze 466: .Ss Spacing control
467: .Bl -column "Brq, Bro, Brc" description
468: .It Sx \&Pf Ta prefix, no following horizontal space (one argument)
469: .It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments)
470: .It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)
1.234 schwarze 471: .It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off
1.211 schwarze 472: .It Sx \&Bk , \&Ek Ta keep block: Fl words
473: .It Sx \&br Ta force output line break in text mode (no arguments)
474: .It Sx \&sp Ta force vertical space: Op Ar height
1.57 kristaps 475: .El
1.211 schwarze 476: .Ss Semantic markup for command line utilities:
477: .Bl -column "Brq, Bro, Brc" description
478: .It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility
479: .It Sx \&Fl Ta command line options (flags) (>=0 arguments)
480: .It Sx \&Cm Ta command modifier (>0 arguments)
481: .It Sx \&Ar Ta command arguments (>=0 arguments)
482: .It Sx \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)
483: .It Sx \&Ic Ta internal or interactive command (>0 arguments)
484: .It Sx \&Ev Ta environmental variable (>0 arguments)
485: .It Sx \&Pa Ta file system path (>=0 arguments)
1.57 kristaps 486: .El
1.211 schwarze 487: .Ss Semantic markup for function libraries:
488: .Bl -column "Brq, Bro, Brc" description
489: .It Sx \&Lb Ta function library (one argument)
490: .It Sx \&In Ta include file (one argument)
1.222 schwarze 491: .It Sx \&Fd Ta other preprocessor directive (>0 arguments)
1.211 schwarze 492: .It Sx \&Ft Ta function type (>0 arguments)
493: .It Sx \&Fo , \&Fc Ta function block: Ar funcname
494: .It Sx \&Fn Ta function name:
495: .Op Ar functype
496: .Ar funcname
497: .Oo
498: .Op Ar argtype
499: .Ar argname
500: .Oc
501: .It Sx \&Fa Ta function argument (>0 arguments)
502: .It Sx \&Vt Ta variable type (>0 arguments)
503: .It Sx \&Va Ta variable name (>0 arguments)
504: .It Sx \&Dv Ta defined variable or preprocessor constant (>0 arguments)
505: .It Sx \&Er Ta error constant (>0 arguments)
506: .It Sx \&Ev Ta environmental variable (>0 arguments)
1.57 kristaps 507: .El
1.211 schwarze 508: .Ss Various semantic markup:
509: .Bl -column "Brq, Bro, Brc" description
510: .It Sx \&An Ta author name (>0 arguments)
511: .It Sx \&Lk Ta hyperlink: Ar uri Op Ar name
512: .It Sx \&Mt Ta Do mailto Dc hyperlink: Ar address
513: .It Sx \&Cd Ta kernel configuration declaration (>0 arguments)
514: .It Sx \&Ad Ta memory address (>0 arguments)
515: .It Sx \&Ms Ta mathematical symbol (>0 arguments)
1.190 schwarze 516: .El
1.211 schwarze 517: .Ss Physical markup
518: .Bl -column "Brq, Bro, Brc" description
519: .It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)
520: .It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)
521: .It Sx \&Li Ta typewriter font (literal) (>0 arguments)
522: .It Sx \&No Ta return to roman font (normal) (no arguments)
523: .It Sx \&Bf , \&Ef Ta font block:
524: .Op Fl Ar type | Cm \&Em | \&Li | \&Sy
1.82 kristaps 525: .El
1.211 schwarze 526: .Ss Physical enclosures
527: .Bl -column "Brq, Bro, Brc" description
528: .It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text
529: .It Sx \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text
530: .It Sx \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
531: .It Sx \&Ql Ta single-quoted literal text: Ql text
532: .It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text
533: .It Sx \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
534: .It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
535: .It Sx \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text
536: .It Sx \&Eo , \&Ec Ta generic enclosure
1.195 schwarze 537: .El
1.211 schwarze 538: .Ss Text production
539: .Bl -column "Brq, Bro, Brc" description
540: .It Sx \&Ex Fl std Ta standard command exit values: Op Ar utility ...
541: .It Sx \&Rv Fl std Ta standard function return values: Op Ar function ...
542: .It Sx \&St Ta reference to a standards document (one argument)
543: .It Sx \&At Ta At
544: .It Sx \&Bx Ta Bx
545: .It Sx \&Bsx Ta Bsx
546: .It Sx \&Nx Ta Nx
547: .It Sx \&Fx Ta Fx
548: .It Sx \&Ox Ta Ox
549: .It Sx \&Dx Ta Dx
1.195 schwarze 550: .El
1.211 schwarze 551: .Sh MACRO REFERENCE
552: This section is a canonical reference of all macros, arranged
553: alphabetically.
554: For the scoping of individual macros, see
555: .Sx MACRO SYNTAX .
556: .Ss \&%A
557: Author name of an
558: .Sx \&Rs
559: block.
560: Multiple authors should each be accorded their own
561: .Sx \%%A
562: line.
563: Author names should be ordered with full or abbreviated forename(s)
564: first, then full surname.
565: .Ss \&%B
566: Book title of an
567: .Sx \&Rs
1.138 kristaps 568: block.
569: This macro may also be used in a non-bibliographic context when
1.63 kristaps 570: referring to book titles.
571: .Ss \&%C
572: Publication city or location of an
573: .Sx \&Rs
574: block.
575: .Ss \&%D
576: Publication date of an
577: .Sx \&Rs
1.138 kristaps 578: block.
1.181 schwarze 579: Recommended formats of arguments are
580: .Ar month day , year
581: or just
582: .Ar year .
1.63 kristaps 583: .Ss \&%I
584: Publisher or issuer name of an
585: .Sx \&Rs
586: block.
587: .Ss \&%J
588: Journal name of an
589: .Sx \&Rs
590: block.
591: .Ss \&%N
592: Issue number (usually for journals) of an
593: .Sx \&Rs
594: block.
595: .Ss \&%O
596: Optional information of an
597: .Sx \&Rs
598: block.
599: .Ss \&%P
600: Book or journal page number of an
601: .Sx \&Rs
602: block.
603: .Ss \&%Q
604: Institutional author (school, government, etc.) of an
605: .Sx \&Rs
1.138 kristaps 606: block.
607: Multiple institutional authors should each be accorded their own
1.64 kristaps 608: .Sx \&%Q
1.63 kristaps 609: line.
610: .Ss \&%R
611: Technical report name of an
612: .Sx \&Rs
613: block.
614: .Ss \&%T
615: Article title of an
616: .Sx \&Rs
1.138 kristaps 617: block.
618: This macro may also be used in a non-bibliographical context when
619: referring to article titles.
1.69 kristaps 620: .Ss \&%U
1.70 kristaps 621: URI of reference document.
1.63 kristaps 622: .Ss \&%V
623: Volume number of an
624: .Sx \&Rs
625: block.
626: .Ss \&Ac
1.141 kristaps 627: Close an
1.63 kristaps 628: .Sx \&Ao
1.138 kristaps 629: block.
630: Does not have any tail arguments.
1.63 kristaps 631: .Ss \&Ad
1.141 kristaps 632: Memory address.
633: Do not use this for postal addresses.
1.63 kristaps 634: .Pp
1.64 kristaps 635: Examples:
1.173 kristaps 636: .Dl \&.Ad [0,$]
637: .Dl \&.Ad 0x00000000
1.63 kristaps 638: .Ss \&An
1.100 kristaps 639: Author name.
1.196 schwarze 640: Can be used both for the authors of the program, function, or driver
641: documented in the manual, or for the authors of the manual itself.
1.141 kristaps 642: Requires either the name of an author or one of the following arguments:
1.140 kristaps 643: .Pp
644: .Bl -tag -width "-nosplitX" -offset indent -compact
1.64 kristaps 645: .It Fl split
1.141 kristaps 646: Start a new output line before each subsequent invocation of
647: .Sx \&An .
1.64 kristaps 648: .It Fl nosplit
649: The opposite of
650: .Fl split .
651: .El
652: .Pp
1.141 kristaps 653: The default is
654: .Fl nosplit .
655: The effect of selecting either of the
656: .Fl split
657: modes ends at the beginning of the
658: .Em AUTHORS
659: section.
1.140 kristaps 660: In the
661: .Em AUTHORS
1.141 kristaps 662: section, the default is
663: .Fl nosplit
664: for the first author listing and
1.64 kristaps 665: .Fl split
1.141 kristaps 666: for all other author listings.
1.64 kristaps 667: .Pp
668: Examples:
1.173 kristaps 669: .Dl \&.An -nosplit
1.219 schwarze 670: .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
1.63 kristaps 671: .Ss \&Ao
1.141 kristaps 672: Begin a block enclosed by angle brackets.
1.100 kristaps 673: Does not have any head arguments.
1.63 kristaps 674: .Pp
1.64 kristaps 675: Examples:
1.173 kristaps 676: .Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
1.63 kristaps 677: .Pp
1.64 kristaps 678: See also
679: .Sx \&Aq .
1.63 kristaps 680: .Ss \&Ap
1.138 kristaps 681: Inserts an apostrophe without any surrounding whitespace.
1.124 kristaps 682: This is generally used as a grammatical device when referring to the verb
1.140 kristaps 683: form of a function.
684: .Pp
685: Examples:
1.173 kristaps 686: .Dl \&.Fn execve \&Ap d
1.63 kristaps 687: .Ss \&Aq
1.141 kristaps 688: Encloses its arguments in angle brackets.
1.64 kristaps 689: .Pp
690: Examples:
1.173 kristaps 691: .Dl \&.Fl -key= \&Ns \&Aq \&Ar val
1.64 kristaps 692: .Pp
693: .Em Remarks :
694: this macro is often abused for rendering URIs, which should instead use
695: .Sx \&Lk
696: or
697: .Sx \&Mt ,
698: or to note pre-processor
699: .Dq Li #include
700: statements, which should use
701: .Sx \&In .
702: .Pp
703: See also
704: .Sx \&Ao .
1.63 kristaps 705: .Ss \&Ar
1.100 kristaps 706: Command arguments.
707: If an argument is not provided, the string
1.141 kristaps 708: .Dq file ...\&
1.66 kristaps 709: is used as a default.
1.64 kristaps 710: .Pp
711: Examples:
1.196 schwarze 712: .Dl ".Fl o Ar file"
713: .Dl ".Ar"
714: .Dl ".Ar arg1 , arg2 ."
715: .Pp
716: The arguments to the
717: .Sx \&Ar
718: macro are names and placeholders for command arguments;
719: for fixed strings to be passed verbatim as arguments, use
720: .Sx \&Fl
721: or
722: .Sx \&Cm .
1.63 kristaps 723: .Ss \&At
1.220 schwarze 724: Formats an
725: .At
726: version.
1.141 kristaps 727: Accepts one optional argument:
1.140 kristaps 728: .Pp
729: .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
1.64 kristaps 730: .It Cm v[1-7] | 32v
731: A version of
732: .At .
1.192 schwarze 733: .It Cm III
734: .At III .
1.64 kristaps 735: .It Cm V[.[1-4]]?
1.141 kristaps 736: A version of
737: .At V .
1.64 kristaps 738: .El
739: .Pp
1.141 kristaps 740: Note that these arguments do not begin with a hyphen.
1.64 kristaps 741: .Pp
742: Examples:
1.173 kristaps 743: .Dl \&.At
1.192 schwarze 744: .Dl \&.At III
1.173 kristaps 745: .Dl \&.At V.1
1.65 kristaps 746: .Pp
747: See also
1.66 kristaps 748: .Sx \&Bsx ,
1.65 kristaps 749: .Sx \&Bx ,
1.66 kristaps 750: .Sx \&Dx ,
1.65 kristaps 751: .Sx \&Fx ,
752: .Sx \&Nx ,
753: and
1.230 schwarze 754: .Sx \&Ox .
1.63 kristaps 755: .Ss \&Bc
1.141 kristaps 756: Close a
1.64 kristaps 757: .Sx \&Bo
1.138 kristaps 758: block.
759: Does not have any tail arguments.
1.63 kristaps 760: .Ss \&Bd
1.141 kristaps 761: Begin a display block.
1.131 kristaps 762: Its syntax is as follows:
763: .Bd -ragged -offset indent
764: .Pf \. Sx \&Bd
1.141 kristaps 765: .Fl Ns Ar type
1.131 kristaps 766: .Op Fl offset Ar width
767: .Op Fl compact
768: .Ed
769: .Pp
1.141 kristaps 770: Display blocks are used to select a different indentation and
771: justification than the one used by the surrounding text.
1.185 kristaps 772: They may contain both macro lines and text lines.
1.141 kristaps 773: By default, a display block is preceded by a vertical space.
1.64 kristaps 774: .Pp
1.141 kristaps 775: The
776: .Ar type
777: must be one of the following:
778: .Bl -tag -width 13n -offset indent
779: .It Fl centered
1.198 schwarze 780: Produce one output line from each input line, and centre-justify each line.
1.141 kristaps 781: Using this display type is not recommended; many
782: .Nm
783: implementations render it poorly.
784: .It Fl filled
1.198 schwarze 785: Change the positions of line breaks to fill each line, and left- and
786: right-justify the resulting block.
1.141 kristaps 787: .It Fl literal
1.198 schwarze 788: Produce one output line from each input line,
789: and do not justify the block at all.
1.169 kristaps 790: Preserve white space as it appears in the input.
1.198 schwarze 791: Always use a constant-width font.
792: Use this for displaying source code.
1.64 kristaps 793: .It Fl ragged
1.198 schwarze 794: Change the positions of line breaks to fill each line, and left-justify
795: the resulting block.
1.64 kristaps 796: .It Fl unfilled
1.198 schwarze 797: The same as
798: .Fl literal ,
799: but using the same font as for normal text, which is a variable width font
800: if supported by the output device.
1.64 kristaps 801: .El
802: .Pp
1.141 kristaps 803: The
804: .Ar type
805: must be provided first.
806: Additional arguments may follow:
807: .Bl -tag -width 13n -offset indent
808: .It Fl offset Ar width
809: Indent the display by the
810: .Ar width ,
811: which may be one of the following:
1.64 kristaps 812: .Bl -item
813: .It
1.141 kristaps 814: One of the pre-defined strings
815: .Cm indent ,
1.198 schwarze 816: the width of a standard indentation (six constant width characters);
1.141 kristaps 817: .Cm indent-two ,
1.64 kristaps 818: twice
1.141 kristaps 819: .Cm indent ;
820: .Cm left ,
1.131 kristaps 821: which has no effect;
1.141 kristaps 822: .Cm right ,
823: which justifies to the right margin; or
824: .Cm center ,
1.64 kristaps 825: which aligns around an imagined centre axis.
826: .It
1.141 kristaps 827: A macro invocation, which selects a predefined width
828: associated with that macro.
1.100 kristaps 829: The most popular is the imaginary macro
1.67 kristaps 830: .Ar \&Ds ,
1.64 kristaps 831: which resolves to
1.141 kristaps 832: .Sy 6n .
1.64 kristaps 833: .It
1.215 schwarze 834: A scaling width as described in
835: .Xr roff 7 .
1.64 kristaps 836: .It
1.141 kristaps 837: An arbitrary string, which indents by the length of this string.
1.64 kristaps 838: .El
839: .Pp
1.141 kristaps 840: When the argument is missing,
841: .Fl offset
842: is ignored.
1.64 kristaps 843: .It Fl compact
1.141 kristaps 844: Do not assert vertical space before the display.
1.64 kristaps 845: .El
846: .Pp
847: Examples:
848: .Bd -literal -offset indent
1.141 kristaps 849: \&.Bd \-literal \-offset indent \-compact
1.65 kristaps 850: Hello world.
1.64 kristaps 851: \&.Ed
852: .Ed
1.66 kristaps 853: .Pp
854: See also
855: .Sx \&D1
856: and
857: .Sx \&Dl .
1.63 kristaps 858: .Ss \&Bf
1.129 kristaps 859: Change the font mode for a scoped block of text.
860: Its syntax is as follows:
861: .Bd -ragged -offset indent
862: .Pf \. Sx \&Bf
863: .Oo
864: .Fl emphasis | literal | symbolic |
865: .Cm \&Em | \&Li | \&Sy
866: .Oc
867: .Ed
868: .Pp
869: The
870: .Fl emphasis
871: and
872: .Cm \&Em
873: argument are equivalent, as are
874: .Fl symbolic
875: and
1.144 schwarze 876: .Cm \&Sy ,
1.129 kristaps 877: and
878: .Fl literal
879: and
880: .Cm \&Li .
881: Without an argument, this macro does nothing.
882: The font mode continues until broken by a new font mode in a nested
883: scope or
884: .Sx \&Ef
885: is encountered.
886: .Pp
887: See also
888: .Sx \&Li ,
889: .Sx \&Ef ,
1.141 kristaps 890: .Sx \&Em ,
1.129 kristaps 891: and
892: .Sx \&Sy .
1.63 kristaps 893: .Ss \&Bk
1.186 schwarze 894: For each macro, keep its output together on the same output line,
895: until the end of the macro or the end of the input line is reached,
896: whichever comes first.
1.185 kristaps 897: Line breaks in text lines are unaffected.
1.141 kristaps 898: The syntax is as follows:
1.131 kristaps 899: .Pp
900: .D1 Pf \. Sx \&Bk Fl words
901: .Pp
1.133 kristaps 902: The
903: .Fl words
1.141 kristaps 904: argument is required; additional arguments are ignored.
1.127 schwarze 905: .Pp
1.141 kristaps 906: The following example will not break within each
1.133 kristaps 907: .Sx \&Op
908: macro line:
1.127 schwarze 909: .Bd -literal -offset indent
910: \&.Bk \-words
1.133 kristaps 911: \&.Op Fl f Ar flags
912: \&.Op Fl o Ar output
1.127 schwarze 913: \&.Ek
914: .Ed
1.129 kristaps 915: .Pp
1.133 kristaps 916: Be careful in using over-long lines within a keep block!
917: Doing so will clobber the right margin.
1.63 kristaps 918: .Ss \&Bl
1.141 kristaps 919: Begin a list.
1.171 schwarze 920: Lists consist of items specified using the
1.141 kristaps 921: .Sx \&It
922: macro, containing a head or a body or both.
923: The list syntax is as follows:
1.131 kristaps 924: .Bd -ragged -offset indent
925: .Pf \. Sx \&Bl
1.141 kristaps 926: .Fl Ns Ar type
1.131 kristaps 927: .Op Fl width Ar val
928: .Op Fl offset Ar val
929: .Op Fl compact
930: .Op HEAD ...
931: .Ed
932: .Pp
1.141 kristaps 933: The list
934: .Ar type
935: is mandatory and must be specified first.
936: The
937: .Fl width
938: and
939: .Fl offset
1.240 schwarze 940: arguments accept macro names as described for
941: .Sx \&Bd
942: .Fl offset ,
943: scaling widths as described in
944: .Xr roff 7 ,
1.141 kristaps 945: or use the length of the given string.
946: The
947: .Fl offset
948: is a global indentation for the whole list, affecting both item heads
949: and bodies.
950: For those list types supporting it, the
951: .Fl width
952: argument requests an additional indentation of item bodies,
953: to be added to the
954: .Fl offset .
955: Unless the
956: .Fl compact
957: argument is specified, list entries are separated by vertical space.
958: .Pp
1.103 kristaps 959: A list must specify one of the following list types:
960: .Bl -tag -width 12n -offset indent
961: .It Fl bullet
1.141 kristaps 962: No item heads can be specified, but a bullet will be printed at the head
963: of each item.
964: Item bodies start on the same output line as the bullet
965: and are indented according to the
1.104 kristaps 966: .Fl width
1.141 kristaps 967: argument.
1.103 kristaps 968: .It Fl column
969: A columnated list.
1.104 kristaps 970: The
971: .Fl width
1.141 kristaps 972: argument has no effect; instead, each argument specifies the width
1.215 schwarze 973: of one column, using either the scaling width syntax described in
974: .Xr roff 7
975: or the string length of the argument.
1.141 kristaps 976: If the first line of the body of a
1.114 kristaps 977: .Fl column
978: list is not an
979: .Sx \&It
1.141 kristaps 980: macro line,
981: .Sx \&It
982: contexts spanning one input line each are implied until an
1.114 kristaps 983: .Sx \&It
1.141 kristaps 984: macro line is encountered, at which point items start being interpreted as
1.114 kristaps 985: described in the
986: .Sx \&It
987: documentation.
1.103 kristaps 988: .It Fl dash
1.141 kristaps 989: Like
990: .Fl bullet ,
991: except that dashes are used in place of bullets.
1.103 kristaps 992: .It Fl diag
993: Like
994: .Fl inset ,
1.141 kristaps 995: except that item heads are not parsed for macro invocations.
1.198 schwarze 996: Most often used in the
997: .Em DIAGNOSTICS
998: section with error constants in the item heads.
1.103 kristaps 999: .It Fl enum
1.141 kristaps 1000: A numbered list.
1.198 schwarze 1001: No item heads can be specified.
1.141 kristaps 1002: Formatted like
1003: .Fl bullet ,
1004: except that cardinal numbers are used in place of bullets,
1005: starting at 1.
1.103 kristaps 1006: .It Fl hang
1007: Like
1008: .Fl tag ,
1.141 kristaps 1009: except that the first lines of item bodies are not indented, but follow
1010: the item heads like in
1011: .Fl inset
1012: lists.
1.103 kristaps 1013: .It Fl hyphen
1014: Synonym for
1015: .Fl dash .
1016: .It Fl inset
1.141 kristaps 1017: Item bodies follow items heads on the same line, using normal inter-word
1018: spacing.
1019: Bodies are not indented, and the
1.104 kristaps 1020: .Fl width
1021: argument is ignored.
1.103 kristaps 1022: .It Fl item
1.141 kristaps 1023: No item heads can be specified, and none are printed.
1024: Bodies are not indented, and the
1.104 kristaps 1025: .Fl width
1026: argument is ignored.
1.103 kristaps 1027: .It Fl ohang
1.141 kristaps 1028: Item bodies start on the line following item heads and are not indented.
1.104 kristaps 1029: The
1030: .Fl width
1031: argument is ignored.
1.103 kristaps 1032: .It Fl tag
1.141 kristaps 1033: Item bodies are indented according to the
1.103 kristaps 1034: .Fl width
1035: argument.
1.141 kristaps 1036: When an item head fits inside the indentation, the item body follows
1037: this head on the same output line.
1038: Otherwise, the body starts on the output line following the head.
1.103 kristaps 1039: .El
1.114 kristaps 1040: .Pp
1.198 schwarze 1041: Lists may be nested within lists and displays.
1042: Nesting of
1043: .Fl column
1044: and
1045: .Fl enum
1046: lists may not be portable.
1047: .Pp
1.114 kristaps 1048: See also
1.141 kristaps 1049: .Sx \&El
1050: and
1.114 kristaps 1051: .Sx \&It .
1.63 kristaps 1052: .Ss \&Bo
1.141 kristaps 1053: Begin a block enclosed by square brackets.
1.100 kristaps 1054: Does not have any head arguments.
1.65 kristaps 1055: .Pp
1056: Examples:
1.140 kristaps 1057: .Bd -literal -offset indent -compact
1.65 kristaps 1058: \&.Bo 1 ,
1.91 kristaps 1059: \&.Dv BUFSIZ \&Bc
1.65 kristaps 1060: .Ed
1061: .Pp
1062: See also
1063: .Sx \&Bq .
1.63 kristaps 1064: .Ss \&Bq
1.82 kristaps 1065: Encloses its arguments in square brackets.
1.65 kristaps 1066: .Pp
1067: Examples:
1.173 kristaps 1068: .Dl \&.Bq 1 , \&Dv BUFSIZ
1.65 kristaps 1069: .Pp
1070: .Em Remarks :
1071: this macro is sometimes abused to emulate optional arguments for
1072: commands; the correct macros to use for this purpose are
1073: .Sx \&Op ,
1074: .Sx \&Oo ,
1075: and
1076: .Sx \&Oc .
1077: .Pp
1078: See also
1079: .Sx \&Bo .
1.63 kristaps 1080: .Ss \&Brc
1.141 kristaps 1081: Close a
1.65 kristaps 1082: .Sx \&Bro
1.138 kristaps 1083: block.
1084: Does not have any tail arguments.
1.63 kristaps 1085: .Ss \&Bro
1.141 kristaps 1086: Begin a block enclosed by curly braces.
1.100 kristaps 1087: Does not have any head arguments.
1.65 kristaps 1088: .Pp
1089: Examples:
1.140 kristaps 1090: .Bd -literal -offset indent -compact
1.65 kristaps 1091: \&.Bro 1 , ... ,
1.91 kristaps 1092: \&.Va n \&Brc
1.65 kristaps 1093: .Ed
1094: .Pp
1095: See also
1096: .Sx \&Brq .
1.63 kristaps 1097: .Ss \&Brq
1.65 kristaps 1098: Encloses its arguments in curly braces.
1099: .Pp
1100: Examples:
1.173 kristaps 1101: .Dl \&.Brq 1 , ... , \&Va n
1.65 kristaps 1102: .Pp
1103: See also
1104: .Sx \&Bro .
1.63 kristaps 1105: .Ss \&Bsx
1.220 schwarze 1106: Format the
1107: .Bsx
1108: version provided as an argument, or a default value if
1.65 kristaps 1109: no argument is provided.
1110: .Pp
1111: Examples:
1.173 kristaps 1112: .Dl \&.Bsx 1.0
1113: .Dl \&.Bsx
1.65 kristaps 1114: .Pp
1115: See also
1116: .Sx \&At ,
1117: .Sx \&Bx ,
1.66 kristaps 1118: .Sx \&Dx ,
1.65 kristaps 1119: .Sx \&Fx ,
1120: .Sx \&Nx ,
1121: and
1.230 schwarze 1122: .Sx \&Ox .
1.63 kristaps 1123: .Ss \&Bt
1.230 schwarze 1124: Supported only for compatibility, do not use this in new manuals.
1.66 kristaps 1125: Prints
1.198 schwarze 1126: .Dq is currently in beta test.
1.63 kristaps 1127: .Ss \&Bx
1.220 schwarze 1128: Format the
1129: .Bx
1130: version provided as an argument, or a default value if no
1.65 kristaps 1131: argument is provided.
1132: .Pp
1133: Examples:
1.198 schwarze 1134: .Dl \&.Bx 4.3 Tahoe
1.173 kristaps 1135: .Dl \&.Bx 4.4
1136: .Dl \&.Bx
1.65 kristaps 1137: .Pp
1138: See also
1139: .Sx \&At ,
1140: .Sx \&Bsx ,
1.66 kristaps 1141: .Sx \&Dx ,
1.65 kristaps 1142: .Sx \&Fx ,
1143: .Sx \&Nx ,
1144: and
1.230 schwarze 1145: .Sx \&Ox .
1.63 kristaps 1146: .Ss \&Cd
1.141 kristaps 1147: Kernel configuration declaration.
1.100 kristaps 1148: This denotes strings accepted by
1.66 kristaps 1149: .Xr config 8 .
1.196 schwarze 1150: It is most often used in section 4 manual pages.
1.66 kristaps 1151: .Pp
1152: Examples:
1.173 kristaps 1153: .Dl \&.Cd device le0 at scode?
1.66 kristaps 1154: .Pp
1155: .Em Remarks :
1156: this macro is commonly abused by using quoted literals to retain
1.138 kristaps 1157: whitespace and align consecutive
1.66 kristaps 1158: .Sx \&Cd
1.100 kristaps 1159: declarations.
1160: This practise is discouraged.
1.63 kristaps 1161: .Ss \&Cm
1.100 kristaps 1162: Command modifiers.
1.196 schwarze 1163: Typically used for fixed strings passed as arguments, unless
1164: .Sx \&Fl
1165: is more appropriate.
1166: Also useful when specifying configuration options or keys.
1.66 kristaps 1167: .Pp
1168: Examples:
1.196 schwarze 1169: .Dl ".Nm mt Fl f Ar device Cm rewind"
1170: .Dl ".Nm ps Fl o Cm pid , Ns Cm command"
1171: .Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
1172: .Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"
1173: .Dl ".Cm LogLevel Dv DEBUG"
1.63 kristaps 1174: .Ss \&D1
1.100 kristaps 1175: One-line indented display.
1176: This is formatted by the default rules and is useful for simple indented
1177: statements.
1178: It is followed by a newline.
1.66 kristaps 1179: .Pp
1180: Examples:
1.173 kristaps 1181: .Dl \&.D1 \&Fl abcdefgh
1.66 kristaps 1182: .Pp
1183: See also
1184: .Sx \&Bd
1185: and
1186: .Sx \&Dl .
1.63 kristaps 1187: .Ss \&Db
1.242 schwarze 1188: This macro is obsolete.
1189: No replacement is needed.
1190: It is ignored by
1191: .Xr mandoc 1
1192: and groff including its arguments.
1193: It was formerly used to toggle a debugging mode.
1.63 kristaps 1194: .Ss \&Dc
1.141 kristaps 1195: Close a
1.66 kristaps 1196: .Sx \&Do
1.138 kristaps 1197: block.
1198: Does not have any tail arguments.
1.63 kristaps 1199: .Ss \&Dd
1.233 schwarze 1200: Document date for display in the page footer.
1.100 kristaps 1201: This is the mandatory first macro of any
1.66 kristaps 1202: .Nm
1.100 kristaps 1203: manual.
1.120 kristaps 1204: Its syntax is as follows:
1.66 kristaps 1205: .Pp
1.181 schwarze 1206: .D1 Pf \. Sx \&Dd Ar month day , year
1.66 kristaps 1207: .Pp
1.82 kristaps 1208: The
1.181 schwarze 1209: .Ar month
1210: is the full English month name, the
1211: .Ar day
1212: is an optionally zero-padded numeral, and the
1213: .Ar year
1214: is the full four-digit year.
1215: .Pp
1216: Other arguments are not portable; the
1217: .Xr mandoc 1
1218: utility handles them as follows:
1219: .Bl -dash -offset 3n -compact
1220: .It
1221: To have the date automatically filled in by the
1222: .Ox
1223: version of
1.72 kristaps 1224: .Xr cvs 1 ,
1.181 schwarze 1225: the special string
1226: .Dq $\&Mdocdate$
1227: can be given as an argument.
1228: .It
1.233 schwarze 1229: The traditional, purely numeric
1230: .Xr man 7
1231: format
1232: .Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day
1233: is accepted, too.
1.181 schwarze 1234: .It
1235: If a date string cannot be parsed, it is used verbatim.
1236: .It
1237: If no date string is given, the current date is used.
1238: .El
1.66 kristaps 1239: .Pp
1240: Examples:
1.173 kristaps 1241: .Dl \&.Dd $\&Mdocdate$
1242: .Dl \&.Dd $\&Mdocdate: July 21 2007$
1243: .Dl \&.Dd July 21, 2007
1.66 kristaps 1244: .Pp
1245: See also
1246: .Sx \&Dt
1247: and
1248: .Sx \&Os .
1.63 kristaps 1249: .Ss \&Dl
1.237 schwarze 1250: One-line indented display.
1.100 kristaps 1251: This is formatted as literal text and is useful for commands and
1252: invocations.
1253: It is followed by a newline.
1.66 kristaps 1254: .Pp
1255: Examples:
1.173 kristaps 1256: .Dl \&.Dl % mandoc mdoc.7 \e(ba less
1.66 kristaps 1257: .Pp
1258: See also
1259: .Sx \&Bd
1260: and
1261: .Sx \&D1 .
1.63 kristaps 1262: .Ss \&Do
1.141 kristaps 1263: Begin a block enclosed by double quotes.
1.138 kristaps 1264: Does not have any head arguments.
1.66 kristaps 1265: .Pp
1266: Examples:
1.140 kristaps 1267: .Bd -literal -offset indent -compact
1268: \&.Do
1269: April is the cruellest month
1270: \&.Dc
1271: \e(em T.S. Eliot
1272: .Ed
1.66 kristaps 1273: .Pp
1274: See also
1275: .Sx \&Dq .
1.63 kristaps 1276: .Ss \&Dq
1.138 kristaps 1277: Encloses its arguments in
1278: .Dq typographic
1279: double-quotes.
1.66 kristaps 1280: .Pp
1281: Examples:
1.91 kristaps 1282: .Bd -literal -offset indent -compact
1.66 kristaps 1283: \&.Dq April is the cruellest month
1284: \e(em T.S. Eliot
1285: .Ed
1286: .Pp
1287: See also
1.139 kristaps 1288: .Sx \&Qq ,
1289: .Sx \&Sq ,
1.138 kristaps 1290: and
1.66 kristaps 1291: .Sx \&Do .
1.139 kristaps 1292: .Ss \&Dt
1.233 schwarze 1293: Document title for display in the page header.
1.100 kristaps 1294: This is the mandatory second macro of any
1.66 kristaps 1295: .Nm
1.100 kristaps 1296: file.
1.120 kristaps 1297: Its syntax is as follows:
1298: .Bd -ragged -offset indent
1299: .Pf \. Sx \&Dt
1.233 schwarze 1300: .Ar TITLE
1.141 kristaps 1301: .Ar section
1.244 schwarze 1302: .Op Ar arch
1.120 kristaps 1303: .Ed
1.66 kristaps 1304: .Pp
1305: Its arguments are as follows:
1.233 schwarze 1306: .Bl -tag -width section -offset 2n
1307: .It Ar TITLE
1.111 kristaps 1308: The document's title (name), defaulting to
1.233 schwarze 1309: .Dq UNTITLED
1.111 kristaps 1310: if unspecified.
1.233 schwarze 1311: To achieve a uniform appearance of page header lines,
1312: it should by convention be all caps.
1.141 kristaps 1313: .It Ar section
1.100 kristaps 1314: The manual section.
1315: This may be one of
1.225 schwarze 1316: .Cm 1
1.246 schwarze 1317: .Pq General Commands ,
1.225 schwarze 1318: .Cm 2
1.246 schwarze 1319: .Pq System Calls ,
1.225 schwarze 1320: .Cm 3
1.246 schwarze 1321: .Pq Library Functions ,
1.225 schwarze 1322: .Cm 3p
1.246 schwarze 1323: .Pq Perl Library ,
1.225 schwarze 1324: .Cm 4
1.246 schwarze 1325: .Pq Device Drivers ,
1.225 schwarze 1326: .Cm 5
1.246 schwarze 1327: .Pq File Formats ,
1.225 schwarze 1328: .Cm 6
1.246 schwarze 1329: .Pq Games ,
1.225 schwarze 1330: .Cm 7
1.246 schwarze 1331: .Pq Miscellaneous Information ,
1.225 schwarze 1332: .Cm 8
1.246 schwarze 1333: .Pq System Manager's Manual ,
1334: or
1.225 schwarze 1335: .Cm 9
1.246 schwarze 1336: .Pq Kernel Developer's Manual .
1.111 kristaps 1337: It should correspond to the manual's filename suffix and defaults to
1.233 schwarze 1338: the empty string if unspecified.
1.141 kristaps 1339: .It Ar arch
1.213 schwarze 1340: This specifies the machine architecture a manual page applies to,
1341: where relevant, for example
1342: .Cm alpha ,
1343: .Cm amd64 ,
1344: .Cm i386 ,
1.66 kristaps 1345: or
1.213 schwarze 1346: .Cm sparc64 .
1.243 schwarze 1347: The list of valid architectures varies by operating system.
1.66 kristaps 1348: .El
1349: .Pp
1350: Examples:
1.173 kristaps 1351: .Dl \&.Dt FOO 1
1352: .Dl \&.Dt FOO 9 i386
1.66 kristaps 1353: .Pp
1354: See also
1355: .Sx \&Dd
1356: and
1357: .Sx \&Os .
1.63 kristaps 1358: .Ss \&Dv
1.189 kristaps 1359: Defined variables such as preprocessor constants, constant symbols,
1360: enumeration values, and so on.
1.66 kristaps 1361: .Pp
1362: Examples:
1.189 kristaps 1363: .Dl \&.Dv NULL
1.173 kristaps 1364: .Dl \&.Dv BUFSIZ
1365: .Dl \&.Dv STDOUT_FILENO
1.66 kristaps 1366: .Pp
1367: See also
1.189 kristaps 1368: .Sx \&Er
1369: and
1370: .Sx \&Ev
1.222 schwarze 1371: for special-purpose constants,
1.189 kristaps 1372: .Sx \&Va
1.222 schwarze 1373: for variable symbols, and
1374: .Sx \&Fd
1375: for listing preprocessor variable definitions in the
1376: .Em SYNOPSIS .
1.63 kristaps 1377: .Ss \&Dx
1.220 schwarze 1378: Format the
1379: .Dx
1380: version provided as an argument, or a default
1.66 kristaps 1381: value if no argument is provided.
1382: .Pp
1383: Examples:
1.173 kristaps 1384: .Dl \&.Dx 2.4.1
1385: .Dl \&.Dx
1.66 kristaps 1386: .Pp
1387: See also
1388: .Sx \&At ,
1389: .Sx \&Bsx ,
1390: .Sx \&Bx ,
1391: .Sx \&Fx ,
1392: .Sx \&Nx ,
1393: and
1.230 schwarze 1394: .Sx \&Ox .
1.63 kristaps 1395: .Ss \&Ec
1.131 kristaps 1396: Close a scope started by
1397: .Sx \&Eo .
1398: Its syntax is as follows:
1399: .Pp
1.141 kristaps 1400: .D1 Pf \. Sx \&Ec Op Ar TERM
1.131 kristaps 1401: .Pp
1402: The
1.141 kristaps 1403: .Ar TERM
1.131 kristaps 1404: argument is used as the enclosure tail, for example, specifying \e(rq
1405: will emulate
1406: .Sx \&Dc .
1.63 kristaps 1407: .Ss \&Ed
1.131 kristaps 1408: End a display context started by
1409: .Sx \&Bd .
1.63 kristaps 1410: .Ss \&Ef
1.141 kristaps 1411: End a font mode context started by
1.129 kristaps 1412: .Sx \&Bf .
1.63 kristaps 1413: .Ss \&Ek
1.141 kristaps 1414: End a keep context started by
1.127 schwarze 1415: .Sx \&Bk .
1.63 kristaps 1416: .Ss \&El
1.141 kristaps 1417: End a list context started by
1.117 kristaps 1418: .Sx \&Bl .
1419: .Pp
1420: See also
1421: .Sx \&Bl
1422: and
1423: .Sx \&It .
1.63 kristaps 1424: .Ss \&Em
1.235 schwarze 1425: Request an italic font.
1426: If the output device does not provide that, underline.
1427: .Pp
1428: This is most often used for stress emphasis (not to be confused with
1429: importance, see
1430: .Sx \&Sy ) .
1431: In the rare cases where none of the semantic markup macros fit,
1432: it can also be used for technical terms and placeholders, except
1433: that for syntax elements,
1434: .Sx \&Sy
1435: and
1436: .Sx \&Ar
1437: are preferred, respectively.
1.66 kristaps 1438: .Pp
1439: Examples:
1.235 schwarze 1440: .Bd -literal -compact -offset indent
1441: Selected lines are those
1442: \&.Em not
1443: matching any of the specified patterns.
1444: Some of the functions use a
1445: \&.Em hold space
1446: to save the pattern space for subsequent retrieval.
1447: .Ed
1.138 kristaps 1448: .Pp
1449: See also
1450: .Sx \&Bf ,
1.198 schwarze 1451: .Sx \&Li ,
1452: .Sx \&No ,
1.138 kristaps 1453: and
1.198 schwarze 1454: .Sx \&Sy .
1.63 kristaps 1455: .Ss \&En
1.231 schwarze 1456: This macro is obsolete.
1457: Use
1458: .Sx \&Eo
1459: or any of the other enclosure macros.
1460: .Pp
1461: It encloses its argument in the delimiters specified by the last
1462: .Sx \&Es
1463: macro.
1.63 kristaps 1464: .Ss \&Eo
1.131 kristaps 1465: An arbitrary enclosure.
1466: Its syntax is as follows:
1467: .Pp
1.141 kristaps 1468: .D1 Pf \. Sx \&Eo Op Ar TERM
1.131 kristaps 1469: .Pp
1470: The
1.141 kristaps 1471: .Ar TERM
1.131 kristaps 1472: argument is used as the enclosure head, for example, specifying \e(lq
1473: will emulate
1474: .Sx \&Do .
1.63 kristaps 1475: .Ss \&Er
1.189 kristaps 1476: Error constants for definitions of the
1477: .Va errno
1478: libc global variable.
1.196 schwarze 1479: This is most often used in section 2 and 3 manual pages.
1.66 kristaps 1480: .Pp
1481: Examples:
1.173 kristaps 1482: .Dl \&.Er EPERM
1483: .Dl \&.Er ENOENT
1.66 kristaps 1484: .Pp
1485: See also
1.189 kristaps 1486: .Sx \&Dv
1487: for general constants.
1.63 kristaps 1488: .Ss \&Es
1.231 schwarze 1489: This macro is obsolete.
1490: Use
1491: .Sx \&Eo
1492: or any of the other enclosure macros.
1493: .Pp
1494: It takes two arguments, defining the delimiters to be used by subsequent
1495: .Sx \&En
1496: macros.
1.63 kristaps 1497: .Ss \&Ev
1.66 kristaps 1498: Environmental variables such as those specified in
1499: .Xr environ 7 .
1500: .Pp
1501: Examples:
1.173 kristaps 1502: .Dl \&.Ev DISPLAY
1503: .Dl \&.Ev PATH
1.189 kristaps 1504: .Pp
1505: See also
1506: .Sx \&Dv
1507: for general constants.
1.63 kristaps 1508: .Ss \&Ex
1.191 kristaps 1509: Insert a standard sentence regarding command exit values of 0 on success
1510: and >0 on failure.
1.196 schwarze 1511: This is most often used in section 1, 6, and 8 manual pages.
1.141 kristaps 1512: Its syntax is as follows:
1513: .Pp
1.193 schwarze 1514: .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...
1.141 kristaps 1515: .Pp
1.191 kristaps 1516: If
1.66 kristaps 1517: .Ar utility
1.141 kristaps 1518: is not specified, the document's name set by
1.66 kristaps 1519: .Sx \&Nm
1.141 kristaps 1520: is used.
1.191 kristaps 1521: Multiple
1522: .Ar utility
1523: arguments are treated as separate utilities.
1.139 kristaps 1524: .Pp
1525: See also
1526: .Sx \&Rv .
1.63 kristaps 1527: .Ss \&Fa
1.239 schwarze 1528: Function argument or parameter.
1.120 kristaps 1529: Its syntax is as follows:
1530: .Bd -ragged -offset indent
1531: .Pf \. Sx \&Fa
1.232 schwarze 1532: .Qo
1533: .Op Ar argtype
1534: .Op Ar argname
1535: .Qc Ar \&...
1.120 kristaps 1536: .Ed
1537: .Pp
1.232 schwarze 1538: Each argument may be a name and a type (recommended for the
1539: .Em SYNOPSIS
1540: section), a name alone (for function invocations),
1541: or a type alone (for function prototypes).
1542: If both a type and a name are given or if the type consists of multiple
1543: words, all words belonging to the same function argument have to be
1544: given in a single argument to the
1545: .Sx \&Fa
1546: macro.
1547: .Pp
1548: This macro is also used to specify the field name of a structure.
1549: .Pp
1.117 kristaps 1550: Most often, the
1551: .Sx \&Fa
1552: macro is used in the
1553: .Em SYNOPSIS
1.120 kristaps 1554: within
1555: .Sx \&Fo
1.232 schwarze 1556: blocks when documenting multi-line function prototypes.
1.117 kristaps 1557: If invoked with multiple arguments, the arguments are separated by a
1558: comma.
1559: Furthermore, if the following macro is another
1560: .Sx \&Fa ,
1561: the last argument will also have a trailing comma.
1562: .Pp
1563: Examples:
1.173 kristaps 1564: .Dl \&.Fa \(dqconst char *p\(dq
1565: .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
1.232 schwarze 1566: .Dl \&.Fa \(dqchar *\(dq size_t
1.120 kristaps 1567: .Pp
1568: See also
1569: .Sx \&Fo .
1.63 kristaps 1570: .Ss \&Fc
1.141 kristaps 1571: End a function context started by
1.131 kristaps 1572: .Sx \&Fo .
1.63 kristaps 1573: .Ss \&Fd
1.222 schwarze 1574: Preprocessor directive, in particular for listing it in the
1575: .Em SYNOPSIS .
1576: Historically, it was also used to document include files.
1577: The latter usage has been deprecated in favour of
1.117 kristaps 1578: .Sx \&In .
1.222 schwarze 1579: .Pp
1580: Its syntax is as follows:
1581: .Bd -ragged -offset indent
1582: .Pf \. Sx \&Fd
1583: .Li # Ns Ar directive
1584: .Op Ar argument ...
1585: .Ed
1586: .Pp
1587: Examples:
1588: .Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler
1589: .Dl \&.Fd #define SIO_MAXNFDS
1590: .Dl \&.Fd #ifdef FS_DEBUG
1591: .Dl \&.Ft void
1592: .Dl \&.Fn dbg_open \(dqconst char *\(dq
1593: .Dl \&.Fd #endif
1.117 kristaps 1594: .Pp
1595: See also
1.222 schwarze 1596: .Sx MANUAL STRUCTURE ,
1597: .Sx \&In ,
1.122 kristaps 1598: and
1.222 schwarze 1599: .Sx \&Dv .
1.63 kristaps 1600: .Ss \&Fl
1.196 schwarze 1601: Command-line flag or option.
1.100 kristaps 1602: Used when listing arguments to command-line utilities.
1603: Prints a fixed-width hyphen
1.79 kristaps 1604: .Sq \-
1.100 kristaps 1605: directly followed by each argument.
1606: If no arguments are provided, a hyphen is printed followed by a space.
1607: If the argument is a macro, a hyphen is prefixed to the subsequent macro
1608: output.
1.79 kristaps 1609: .Pp
1610: Examples:
1.199 schwarze 1611: .Dl ".Fl R Op Fl H | L | P"
1612: .Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux"
1613: .Dl ".Fl type Cm d Fl name Pa CVS"
1614: .Dl ".Fl Ar signal_number"
1615: .Dl ".Fl o Fl"
1.79 kristaps 1616: .Pp
1617: See also
1618: .Sx \&Cm .
1.63 kristaps 1619: .Ss \&Fn
1.119 kristaps 1620: A function name.
1.120 kristaps 1621: Its syntax is as follows:
1.119 kristaps 1622: .Bd -ragged -offset indent
1623: .Pf \. Ns Sx \&Fn
1.185 kristaps 1624: .Op Ar functype
1625: .Ar funcname
1626: .Op Oo Ar argtype Oc Ar argname
1.119 kristaps 1627: .Ed
1.120 kristaps 1628: .Pp
1.122 kristaps 1629: Function arguments are surrounded in parenthesis and
1.119 kristaps 1630: are delimited by commas.
1631: If no arguments are specified, blank parenthesis are output.
1.196 schwarze 1632: In the
1633: .Em SYNOPSIS
1634: section, this macro starts a new output line,
1635: and a blank line is automatically inserted between function definitions.
1.119 kristaps 1636: .Pp
1637: Examples:
1.203 kristaps 1638: .Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq
1639: .Dl \&.Fn funcname \(dqint arg0\(dq
1.173 kristaps 1640: .Dl \&.Fn funcname arg0
1.196 schwarze 1641: .Pp
1.120 kristaps 1642: .Bd -literal -offset indent -compact
1643: \&.Ft functype
1644: \&.Fn funcname
1645: .Ed
1.119 kristaps 1646: .Pp
1.163 schwarze 1647: When referring to a function documented in another manual page, use
1.162 schwarze 1648: .Sx \&Xr
1.163 schwarze 1649: instead.
1.119 kristaps 1650: See also
1.196 schwarze 1651: .Sx MANUAL STRUCTURE ,
1652: .Sx \&Fo ,
1.119 kristaps 1653: and
1654: .Sx \&Ft .
1.63 kristaps 1655: .Ss \&Fo
1.120 kristaps 1656: Begin a function block.
1657: This is a multi-line version of
1658: .Sx \&Fn .
1659: Its syntax is as follows:
1660: .Pp
1.185 kristaps 1661: .D1 Pf \. Sx \&Fo Ar funcname
1.120 kristaps 1662: .Pp
1663: Invocations usually occur in the following context:
1664: .Bd -ragged -offset indent
1.185 kristaps 1665: .Pf \. Sx \&Ft Ar functype
1.120 kristaps 1666: .br
1.185 kristaps 1667: .Pf \. Sx \&Fo Ar funcname
1.120 kristaps 1668: .br
1.232 schwarze 1669: .Pf \. Sx \&Fa Qq Ar argtype Ar argname
1.120 kristaps 1670: .br
1.183 kristaps 1671: \&.\.\.
1.120 kristaps 1672: .br
1673: .Pf \. Sx \&Fc
1674: .Ed
1675: .Pp
1676: A
1677: .Sx \&Fo
1678: scope is closed by
1.196 schwarze 1679: .Sx \&Fc .
1.120 kristaps 1680: .Pp
1681: See also
1.122 kristaps 1682: .Sx MANUAL STRUCTURE ,
1.120 kristaps 1683: .Sx \&Fa ,
1684: .Sx \&Fc ,
1685: and
1.139 kristaps 1686: .Sx \&Ft .
1.190 schwarze 1687: .Ss \&Fr
1.231 schwarze 1688: This macro is obsolete.
1689: No replacement markup is needed.
1.198 schwarze 1690: .Pp
1.231 schwarze 1691: It was used to show numerical function return values in an italic font.
1.63 kristaps 1692: .Ss \&Ft
1.120 kristaps 1693: A function type.
1694: Its syntax is as follows:
1695: .Pp
1.185 kristaps 1696: .D1 Pf \. Sx \&Ft Ar functype
1.120 kristaps 1697: .Pp
1.196 schwarze 1698: In the
1699: .Em SYNOPSIS
1700: section, a new output line is started after this macro.
1701: .Pp
1.120 kristaps 1702: Examples:
1.173 kristaps 1703: .Dl \&.Ft int
1.120 kristaps 1704: .Bd -literal -offset indent -compact
1705: \&.Ft functype
1706: \&.Fn funcname
1707: .Ed
1708: .Pp
1709: See also
1.122 kristaps 1710: .Sx MANUAL STRUCTURE ,
1711: .Sx \&Fn ,
1.120 kristaps 1712: and
1.122 kristaps 1713: .Sx \&Fo .
1.63 kristaps 1714: .Ss \&Fx
1.144 schwarze 1715: Format the
1716: .Fx
1717: version provided as an argument, or a default value
1.65 kristaps 1718: if no argument is provided.
1719: .Pp
1720: Examples:
1.173 kristaps 1721: .Dl \&.Fx 7.1
1722: .Dl \&.Fx
1.65 kristaps 1723: .Pp
1724: See also
1725: .Sx \&At ,
1.66 kristaps 1726: .Sx \&Bsx ,
1.65 kristaps 1727: .Sx \&Bx ,
1.66 kristaps 1728: .Sx \&Dx ,
1.65 kristaps 1729: .Sx \&Nx ,
1730: and
1.230 schwarze 1731: .Sx \&Ox .
1.63 kristaps 1732: .Ss \&Hf
1.198 schwarze 1733: This macro is not implemented in
1734: .Xr mandoc 1 .
1735: .Pp
1736: It was used to include the contents of a (header) file literally.
1737: The syntax was:
1738: .Pp
1739: .Dl Pf . Sx \&Hf Ar filename
1.63 kristaps 1740: .Ss \&Ic
1.132 kristaps 1741: Designate an internal or interactive command.
1742: This is similar to
1743: .Sx \&Cm
1744: but used for instructions rather than values.
1745: .Pp
1746: Examples:
1.196 schwarze 1747: .Dl \&.Ic :wq
1.173 kristaps 1748: .Dl \&.Ic hash
1749: .Dl \&.Ic alias
1.132 kristaps 1750: .Pp
1751: Note that using
1.144 schwarze 1752: .Sx \&Bd Fl literal
1.132 kristaps 1753: or
1754: .Sx \&D1
1755: is preferred for displaying code; the
1756: .Sx \&Ic
1757: macro is used when referring to specific instructions.
1.63 kristaps 1758: .Ss \&In
1.118 kristaps 1759: An
1.138 kristaps 1760: .Dq include
1.118 kristaps 1761: file.
1.196 schwarze 1762: When invoked as the first macro on an input line in the
1.118 kristaps 1763: .Em SYNOPSIS
1.196 schwarze 1764: section, the argument is displayed in angle brackets
1765: and preceded by
1.138 kristaps 1766: .Dq #include ,
1.196 schwarze 1767: and a blank line is inserted in front if there is a preceding
1768: function declaration.
1769: This is most often used in section 2, 3, and 9 manual pages.
1.118 kristaps 1770: .Pp
1.122 kristaps 1771: Examples:
1.196 schwarze 1772: .Dl \&.In sys/types.h
1.122 kristaps 1773: .Pp
1774: See also
1775: .Sx MANUAL STRUCTURE .
1.63 kristaps 1776: .Ss \&It
1.120 kristaps 1777: A list item.
1778: The syntax of this macro depends on the list type.
1.114 kristaps 1779: .Pp
1780: Lists
1781: of type
1782: .Fl hang ,
1783: .Fl ohang ,
1784: .Fl inset ,
1785: and
1786: .Fl diag
1.120 kristaps 1787: have the following syntax:
1.114 kristaps 1788: .Pp
1.185 kristaps 1789: .D1 Pf \. Sx \&It Ar args
1.114 kristaps 1790: .Pp
1791: Lists of type
1792: .Fl bullet ,
1793: .Fl dash ,
1794: .Fl enum ,
1795: .Fl hyphen
1796: and
1797: .Fl item
1.120 kristaps 1798: have the following syntax:
1.114 kristaps 1799: .Pp
1.120 kristaps 1800: .D1 Pf \. Sx \&It
1.114 kristaps 1801: .Pp
1802: with subsequent lines interpreted within the scope of the
1803: .Sx \&It
1804: until either a closing
1805: .Sx \&El
1806: or another
1807: .Sx \&It .
1808: .Pp
1809: The
1810: .Fl tag
1.120 kristaps 1811: list has the following syntax:
1.114 kristaps 1812: .Pp
1.120 kristaps 1813: .D1 Pf \. Sx \&It Op Cm args
1.114 kristaps 1814: .Pp
1.120 kristaps 1815: Subsequent lines are interpreted as with
1.114 kristaps 1816: .Fl bullet
1817: and family.
1818: The line arguments correspond to the list's left-hand side; body
1819: arguments correspond to the list's contents.
1820: .Pp
1821: The
1822: .Fl column
1823: list is the most complicated.
1.120 kristaps 1824: Its syntax is as follows:
1.114 kristaps 1825: .Pp
1.190 schwarze 1826: .D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...
1827: .D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...
1.114 kristaps 1828: .Pp
1.190 schwarze 1829: The arguments consist of one or more lines of text and macros
1830: representing a complete table line.
1831: Cells within the line are delimited by tabs or by the special
1832: .Sx \&Ta
1833: block macro.
1834: The tab cell delimiter may only be used within the
1.114 kristaps 1835: .Sx \&It
1.190 schwarze 1836: line itself; on following lines, only the
1837: .Sx \&Ta
1838: macro can be used to delimit cells, and
1839: .Sx \&Ta
1.208 kristaps 1840: is only recognised as a macro when called by other macros,
1.190 schwarze 1841: not as the first macro on a line.
1842: .Pp
1843: Note that quoted strings may span tab-delimited cells on an
1.114 kristaps 1844: .Sx \&It
1.190 schwarze 1845: line.
1846: For example,
1.114 kristaps 1847: .Pp
1.173 kristaps 1848: .Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
1.114 kristaps 1849: .Pp
1850: will preserve the semicolon whitespace except for the last.
1851: .Pp
1852: See also
1853: .Sx \&Bl .
1.63 kristaps 1854: .Ss \&Lb
1.109 kristaps 1855: Specify a library.
1.120 kristaps 1856: The syntax is as follows:
1.109 kristaps 1857: .Pp
1.185 kristaps 1858: .D1 Pf \. Sx \&Lb Ar library
1.109 kristaps 1859: .Pp
1860: The
1.185 kristaps 1861: .Ar library
1.109 kristaps 1862: parameter may be a system library, such as
1.193 schwarze 1863: .Cm libz
1.109 kristaps 1864: or
1.193 schwarze 1865: .Cm libpam ,
1.109 kristaps 1866: in which case a small library description is printed next to the linker
1867: invocation; or a custom library, in which case the library name is
1868: printed in quotes.
1869: This is most commonly used in the
1870: .Em SYNOPSIS
1871: section as described in
1872: .Sx MANUAL STRUCTURE .
1873: .Pp
1874: Examples:
1.173 kristaps 1875: .Dl \&.Lb libz
1.221 schwarze 1876: .Dl \&.Lb libmandoc
1.63 kristaps 1877: .Ss \&Li
1.198 schwarze 1878: Denotes text that should be in a
1879: .Li literal
1880: font mode.
1.131 kristaps 1881: Note that this is a presentation term and should not be used for
1882: stylistically decorating technical terms.
1.138 kristaps 1883: .Pp
1.198 schwarze 1884: On terminal output devices, this is often indistinguishable from
1885: normal text.
1886: .Pp
1.138 kristaps 1887: See also
1888: .Sx \&Bf ,
1.198 schwarze 1889: .Sx \&Em ,
1890: .Sx \&No ,
1.138 kristaps 1891: and
1.198 schwarze 1892: .Sx \&Sy .
1.63 kristaps 1893: .Ss \&Lk
1.100 kristaps 1894: Format a hyperlink.
1.120 kristaps 1895: Its syntax is as follows:
1.70 kristaps 1896: .Pp
1.185 kristaps 1897: .D1 Pf \. Sx \&Lk Ar uri Op Ar name
1.70 kristaps 1898: .Pp
1899: Examples:
1.203 kristaps 1900: .Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq
1.173 kristaps 1901: .Dl \&.Lk http://bsd.lv
1.70 kristaps 1902: .Pp
1903: See also
1904: .Sx \&Mt .
1.63 kristaps 1905: .Ss \&Lp
1.132 kristaps 1906: Synonym for
1907: .Sx \&Pp .
1.63 kristaps 1908: .Ss \&Ms
1.138 kristaps 1909: Display a mathematical symbol.
1.140 kristaps 1910: Its syntax is as follows:
1911: .Pp
1.185 kristaps 1912: .D1 Pf \. Sx \&Ms Ar symbol
1.138 kristaps 1913: .Pp
1914: Examples:
1.173 kristaps 1915: .Dl \&.Ms sigma
1916: .Dl \&.Ms aleph
1.63 kristaps 1917: .Ss \&Mt
1.116 kristaps 1918: Format a
1.138 kristaps 1919: .Dq mailto:
1.116 kristaps 1920: hyperlink.
1.120 kristaps 1921: Its syntax is as follows:
1.116 kristaps 1922: .Pp
1.185 kristaps 1923: .D1 Pf \. Sx \&Mt Ar address
1.116 kristaps 1924: .Pp
1925: Examples:
1.173 kristaps 1926: .Dl \&.Mt discuss@manpages.bsd.lv
1.219 schwarze 1927: .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
1.63 kristaps 1928: .Ss \&Nd
1.144 schwarze 1929: A one line description of the manual's content.
1.132 kristaps 1930: This may only be invoked in the
1931: .Em SYNOPSIS
1932: section subsequent the
1933: .Sx \&Nm
1934: macro.
1935: .Pp
1936: Examples:
1.198 schwarze 1937: .Dl Pf . Sx \&Nd mdoc language reference
1938: .Dl Pf . Sx \&Nd format and display UNIX manuals
1.132 kristaps 1939: .Pp
1940: The
1941: .Sx \&Nd
1942: macro technically accepts child macros and terminates with a subsequent
1943: .Sx \&Sh
1944: invocation.
1945: Do not assume this behaviour: some
1946: .Xr whatis 1
1947: database generators are not smart enough to parse more than the line
1948: arguments and will display macros verbatim.
1949: .Pp
1950: See also
1951: .Sx \&Nm .
1.63 kristaps 1952: .Ss \&Nm
1.128 schwarze 1953: The name of the manual page, or \(em in particular in section 1, 6,
1954: and 8 pages \(em of an additional command or feature documented in
1955: the manual page.
1956: When first invoked, the
1957: .Sx \&Nm
1958: macro expects a single argument, the name of the manual page.
1959: Usually, the first invocation happens in the
1960: .Em NAME
1961: section of the page.
1962: The specified name will be remembered and used whenever the macro is
1963: called again without arguments later in the page.
1964: The
1965: .Sx \&Nm
1966: macro uses
1967: .Sx Block full-implicit
1968: semantics when invoked as the first macro on an input line in the
1969: .Em SYNOPSIS
1970: section; otherwise, it uses ordinary
1971: .Sx In-line
1972: semantics.
1973: .Pp
1974: Examples:
1975: .Bd -literal -offset indent
1976: \&.Sh SYNOPSIS
1977: \&.Nm cat
1978: \&.Op Fl benstuv
1979: \&.Op Ar
1980: .Ed
1981: .Pp
1982: In the
1983: .Em SYNOPSIS
1984: of section 2, 3 and 9 manual pages, use the
1985: .Sx \&Fn
1986: macro rather than
1987: .Sx \&Nm
1988: to mark up the name of the manual page.
1.63 kristaps 1989: .Ss \&No
1.198 schwarze 1990: Normal text.
1991: Closes the scope of any preceding in-line macro.
1992: When used after physical formatting macros like
1993: .Sx \&Em
1994: or
1995: .Sx \&Sy ,
1996: switches back to the standard font face and weight.
1997: Can also be used to embed plain text strings in macro lines
1998: using semantic annotation macros.
1.132 kristaps 1999: .Pp
2000: Examples:
1.198 schwarze 2001: .Dl ".Em italic , Sy bold , No and roman"
2002: .Pp
2003: .Bd -literal -offset indent -compact
2004: \&.Sm off
2005: \&.Cm :C No / Ar pattern No / Ar replacement No /
2006: \&.Sm on
2007: .Ed
2008: .Pp
2009: See also
2010: .Sx \&Em ,
2011: .Sx \&Li ,
2012: and
2013: .Sx \&Sy .
1.63 kristaps 2014: .Ss \&Ns
1.198 schwarze 2015: Suppress a space between the output of the preceding macro
2016: and the following text or macro.
2017: Following invocation, input is interpreted as normal text
2018: just like after an
2019: .Sx \&No
2020: macro.
1.178 kristaps 2021: .Pp
2022: This has no effect when invoked at the start of a macro line.
1.138 kristaps 2023: .Pp
2024: Examples:
1.198 schwarze 2025: .Dl ".Ar name Ns = Ns Ar value"
2026: .Dl ".Cm :M Ns Ar pattern"
2027: .Dl ".Fl o Ns Ar output"
1.138 kristaps 2028: .Pp
2029: See also
2030: .Sx \&No
2031: and
2032: .Sx \&Sm .
1.63 kristaps 2033: .Ss \&Nx
1.144 schwarze 2034: Format the
2035: .Nx
2036: version provided as an argument, or a default value if
1.65 kristaps 2037: no argument is provided.
2038: .Pp
2039: Examples:
1.173 kristaps 2040: .Dl \&.Nx 5.01
2041: .Dl \&.Nx
1.65 kristaps 2042: .Pp
2043: See also
2044: .Sx \&At ,
1.66 kristaps 2045: .Sx \&Bsx ,
1.65 kristaps 2046: .Sx \&Bx ,
1.66 kristaps 2047: .Sx \&Dx ,
1.65 kristaps 2048: .Sx \&Fx ,
2049: and
1.230 schwarze 2050: .Sx \&Ox .
1.63 kristaps 2051: .Ss \&Oc
1.141 kristaps 2052: Close multi-line
1.132 kristaps 2053: .Sx \&Oo
2054: context.
1.63 kristaps 2055: .Ss \&Oo
1.132 kristaps 2056: Multi-line version of
2057: .Sx \&Op .
2058: .Pp
2059: Examples:
1.138 kristaps 2060: .Bd -literal -offset indent -compact
1.132 kristaps 2061: \&.Oo
2062: \&.Op Fl flag Ns Ar value
2063: \&.Oc
2064: .Ed
1.63 kristaps 2065: .Ss \&Op
1.196 schwarze 2066: Optional part of a command line.
1.132 kristaps 2067: Prints the argument(s) in brackets.
1.196 schwarze 2068: This is most often used in the
2069: .Em SYNOPSIS
2070: section of section 1 and 8 manual pages.
1.132 kristaps 2071: .Pp
2072: Examples:
1.173 kristaps 2073: .Dl \&.Op \&Fl a \&Ar b
2074: .Dl \&.Op \&Ar a | b
1.132 kristaps 2075: .Pp
2076: See also
2077: .Sx \&Oo .
1.63 kristaps 2078: .Ss \&Os
1.233 schwarze 2079: Operating system version for display in the page footer.
1.100 kristaps 2080: This is the mandatory third macro of
1.66 kristaps 2081: any
2082: .Nm
1.120 kristaps 2083: file.
2084: Its syntax is as follows:
1.66 kristaps 2085: .Pp
1.185 kristaps 2086: .D1 Pf \. Sx \&Os Op Ar system Op Ar version
1.66 kristaps 2087: .Pp
2088: The optional
1.185 kristaps 2089: .Ar system
1.100 kristaps 2090: parameter specifies the relevant operating system or environment.
1.246 schwarze 2091: It is suggested to leave it unspecified, in which case
2092: .Xr mandoc 1
2093: uses its
2094: .Fl Ios
2095: argument, or, if that isn't specified either,
2096: .Fa sysname
2097: and
2098: .Fa release
2099: as returned by
2100: .Xr uname 3 .
1.66 kristaps 2101: .Pp
2102: Examples:
1.173 kristaps 2103: .Dl \&.Os
2104: .Dl \&.Os KTH/CSC/TCS
2105: .Dl \&.Os BSD 4.3
1.66 kristaps 2106: .Pp
2107: See also
2108: .Sx \&Dd
2109: and
2110: .Sx \&Dt .
1.63 kristaps 2111: .Ss \&Ot
1.231 schwarze 2112: This macro is obsolete.
2113: Use
2114: .Sx \&Ft
2115: instead; with
2116: .Xr mandoc 1 ,
2117: both have the same effect.
1.66 kristaps 2118: .Pp
1.198 schwarze 2119: Historical
1.217 schwarze 2120: .Nm
1.198 schwarze 2121: packages described it as
2122: .Dq "old function type (FORTRAN)" .
1.63 kristaps 2123: .Ss \&Ox
1.144 schwarze 2124: Format the
2125: .Ox
2126: version provided as an argument, or a default value
1.65 kristaps 2127: if no argument is provided.
2128: .Pp
2129: Examples:
1.173 kristaps 2130: .Dl \&.Ox 4.5
2131: .Dl \&.Ox
1.65 kristaps 2132: .Pp
2133: See also
2134: .Sx \&At ,
2135: .Sx \&Bsx ,
2136: .Sx \&Bx ,
1.66 kristaps 2137: .Sx \&Dx ,
1.65 kristaps 2138: .Sx \&Fx ,
2139: and
1.230 schwarze 2140: .Sx \&Nx .
1.63 kristaps 2141: .Ss \&Pa
1.196 schwarze 2142: An absolute or relative file system path, or a file or directory name.
2143: If an argument is not provided, the character
2144: .Sq \(ti
1.165 kristaps 2145: is used as a default.
1.132 kristaps 2146: .Pp
2147: Examples:
1.173 kristaps 2148: .Dl \&.Pa /usr/bin/mandoc
2149: .Dl \&.Pa /usr/share/man/man7/mdoc.7
1.132 kristaps 2150: .Pp
2151: See also
2152: .Sx \&Lk .
1.63 kristaps 2153: .Ss \&Pc
1.132 kristaps 2154: Close parenthesised context opened by
2155: .Sx \&Po .
1.63 kristaps 2156: .Ss \&Pf
1.198 schwarze 2157: Removes the space between its argument
1.138 kristaps 2158: .Pq Dq prefix
1.198 schwarze 2159: and the following macro.
1.132 kristaps 2160: Its syntax is as follows:
2161: .Pp
1.198 schwarze 2162: .D1 .Pf Ar prefix macro arguments ...
2163: .Pp
2164: This is equivalent to:
1.132 kristaps 2165: .Pp
1.198 schwarze 2166: .D1 .No Ar prefix No \&Ns Ar macro arguments ...
1.132 kristaps 2167: .Pp
2168: Examples:
1.198 schwarze 2169: .Dl ".Pf $ Ar variable_name"
2170: .Dl ".Pf 0x Ar hex_digits"
2171: .Pp
2172: See also
2173: .Sx \&Ns
2174: and
2175: .Sx \&Sm .
1.63 kristaps 2176: .Ss \&Po
1.132 kristaps 2177: Multi-line version of
2178: .Sx \&Pq .
1.63 kristaps 2179: .Ss \&Pp
1.132 kristaps 2180: Break a paragraph.
2181: This will assert vertical space between prior and subsequent macros
2182: and/or text.
1.198 schwarze 2183: .Pp
2184: Paragraph breaks are not needed before or after
2185: .Sx \&Sh
2186: or
2187: .Sx \&Ss
2188: macros or before displays
2189: .Pq Sx \&Bd
2190: or lists
2191: .Pq Sx \&Bl
2192: unless the
2193: .Fl compact
2194: flag is given.
1.63 kristaps 2195: .Ss \&Pq
1.132 kristaps 2196: Parenthesised enclosure.
2197: .Pp
2198: See also
2199: .Sx \&Po .
1.63 kristaps 2200: .Ss \&Qc
1.138 kristaps 2201: Close quoted context opened by
2202: .Sx \&Qo .
1.63 kristaps 2203: .Ss \&Ql
1.247 ! schwarze 2204: Request a literal font and enclose in single quotes.
! 2205: For arguments of three or more characters, formatters other than
! 2206: .Xr mandoc 1
! 2207: usually omit the quotes on non-terminal output devices.
1.138 kristaps 2208: See also
1.247 ! schwarze 2209: .Sx \&Li
1.138 kristaps 2210: and
2211: .Sx \&Sq .
1.63 kristaps 2212: .Ss \&Qo
1.138 kristaps 2213: Multi-line version of
2214: .Sx \&Qq .
1.63 kristaps 2215: .Ss \&Qq
1.138 kristaps 2216: Encloses its arguments in
1.198 schwarze 2217: .Qq typewriter
1.138 kristaps 2218: double-quotes.
2219: Consider using
2220: .Sx \&Dq .
2221: .Pp
2222: See also
2223: .Sx \&Dq ,
2224: .Sx \&Sq ,
2225: and
2226: .Sx \&Qo .
1.63 kristaps 2227: .Ss \&Re
1.141 kristaps 2228: Close an
1.63 kristaps 2229: .Sx \&Rs
1.100 kristaps 2230: block.
2231: Does not have any tail arguments.
1.63 kristaps 2232: .Ss \&Rs
1.141 kristaps 2233: Begin a bibliographic
1.63 kristaps 2234: .Pq Dq reference
1.100 kristaps 2235: block.
2236: Does not have any head arguments.
2237: The block macro may only contain
1.63 kristaps 2238: .Sx \&%A ,
2239: .Sx \&%B ,
2240: .Sx \&%C ,
2241: .Sx \&%D ,
2242: .Sx \&%I ,
2243: .Sx \&%J ,
2244: .Sx \&%N ,
2245: .Sx \&%O ,
2246: .Sx \&%P ,
2247: .Sx \&%Q ,
2248: .Sx \&%R ,
2249: .Sx \&%T ,
1.120 kristaps 2250: .Sx \&%U ,
1.63 kristaps 2251: and
2252: .Sx \&%V
2253: child macros (at least one must be specified).
2254: .Pp
1.64 kristaps 2255: Examples:
1.91 kristaps 2256: .Bd -literal -offset indent -compact
1.63 kristaps 2257: \&.Rs
2258: \&.%A J. E. Hopcroft
2259: \&.%A J. D. Ullman
2260: \&.%B Introduction to Automata Theory, Languages, and Computation
2261: \&.%I Addison-Wesley
2262: \&.%C Reading, Massachusettes
2263: \&.%D 1979
2264: \&.Re
2265: .Ed
2266: .Pp
2267: If an
2268: .Sx \&Rs
2269: block is used within a SEE ALSO section, a vertical space is asserted
2270: before the rendered output, else the block continues on the current
2271: line.
2272: .Ss \&Rv
1.193 schwarze 2273: Insert a standard sentence regarding a function call's return value of 0
1.191 kristaps 2274: on success and \-1 on error, with the
2275: .Va errno
2276: libc global variable set on error.
2277: Its syntax is as follows:
2278: .Pp
1.193 schwarze 2279: .D1 Pf \. Sx \&Rv Fl std Op Ar function ...
1.191 kristaps 2280: .Pp
1.139 kristaps 2281: If
2282: .Ar function
1.191 kristaps 2283: is not specified, the document's name set by
1.139 kristaps 2284: .Sx \&Nm
1.191 kristaps 2285: is used.
2286: Multiple
2287: .Ar function
2288: arguments are treated as separate functions.
1.139 kristaps 2289: .Pp
2290: See also
2291: .Sx \&Ex .
1.63 kristaps 2292: .Ss \&Sc
1.138 kristaps 2293: Close single-quoted context opened by
2294: .Sx \&So .
1.63 kristaps 2295: .Ss \&Sh
1.138 kristaps 2296: Begin a new section.
2297: For a list of conventional manual sections, see
2298: .Sx MANUAL STRUCTURE .
2299: These sections should be used unless it's absolutely necessary that
2300: custom sections be used.
2301: .Pp
2302: Section names should be unique so that they may be keyed by
2303: .Sx \&Sx .
1.197 kristaps 2304: Although this macro is parsed, it should not consist of child node or it
2305: may not be linked with
2306: .Sx \&Sx .
1.138 kristaps 2307: .Pp
2308: See also
2309: .Sx \&Pp ,
2310: .Sx \&Ss ,
2311: and
2312: .Sx \&Sx .
1.63 kristaps 2313: .Ss \&Sm
1.134 schwarze 2314: Switches the spacing mode for output generated from macros.
2315: Its syntax is as follows:
2316: .Pp
1.234 schwarze 2317: .D1 Pf \. Sx \&Sm Op Cm on | off
1.134 schwarze 2318: .Pp
2319: By default, spacing is
1.193 schwarze 2320: .Cm on .
1.134 schwarze 2321: When switched
1.193 schwarze 2322: .Cm off ,
1.134 schwarze 2323: no white space is inserted between macro arguments and between the
1.185 kristaps 2324: output generated from adjacent macros, but text lines
1.134 schwarze 2325: still get normal spacing between words and sentences.
1.234 schwarze 2326: .Pp
2327: When called without an argument, the
2328: .Sx \&Sm
2329: macro toggles the spacing mode.
2330: Using this is not recommended because it makes the code harder to read.
1.63 kristaps 2331: .Ss \&So
1.138 kristaps 2332: Multi-line version of
2333: .Sx \&Sq .
1.63 kristaps 2334: .Ss \&Sq
1.138 kristaps 2335: Encloses its arguments in
1.198 schwarze 2336: .Sq typewriter
1.138 kristaps 2337: single-quotes.
2338: .Pp
2339: See also
2340: .Sx \&Dq ,
2341: .Sx \&Qq ,
2342: and
2343: .Sx \&So .
1.63 kristaps 2344: .Ss \&Ss
1.198 schwarze 2345: Begin a new subsection.
1.138 kristaps 2346: Unlike with
2347: .Sx \&Sh ,
1.198 schwarze 2348: there is no convention for the naming of subsections.
2349: Except
2350: .Em DESCRIPTION ,
2351: the conventional sections described in
2352: .Sx MANUAL STRUCTURE
2353: rarely have subsections.
1.138 kristaps 2354: .Pp
2355: Sub-section names should be unique so that they may be keyed by
1.197 kristaps 2356: .Sx \&Sx .
2357: Although this macro is parsed, it should not consist of child node or it
2358: may not be linked with
1.138 kristaps 2359: .Sx \&Sx .
2360: .Pp
2361: See also
2362: .Sx \&Pp ,
2363: .Sx \&Sh ,
2364: and
2365: .Sx \&Sx .
1.63 kristaps 2366: .Ss \&St
1.139 kristaps 2367: Replace an abbreviation for a standard with the full form.
1.226 schwarze 2368: The following standards are recognised.
2369: Where multiple lines are given without a blank line in between,
2370: they all refer to the same standard, and using the first form
2371: is recommended.
2372: .Bl -tag -width 1n
2373: .It C language standards
1.139 kristaps 2374: .Pp
1.226 schwarze 2375: .Bl -tag -width "-p1003.1g-2000" -compact
2376: .It \-ansiC
2377: .St -ansiC
2378: .It \-ansiC-89
2379: .St -ansiC-89
1.139 kristaps 2380: .It \-isoC
2381: .St -isoC
2382: .It \-isoC-90
2383: .St -isoC-90
1.226 schwarze 2384: .br
2385: The original C standard.
2386: .Pp
1.139 kristaps 2387: .It \-isoC-amd1
2388: .St -isoC-amd1
1.226 schwarze 2389: .Pp
1.139 kristaps 2390: .It \-isoC-tcor1
2391: .St -isoC-tcor1
1.226 schwarze 2392: .Pp
1.211 schwarze 2393: .It \-isoC-tcor2
2394: .St -isoC-tcor2
1.226 schwarze 2395: .Pp
1.211 schwarze 2396: .It \-isoC-99
2397: .St -isoC-99
1.226 schwarze 2398: .br
2399: The second major version of the C language standard.
2400: .Pp
1.214 kristaps 2401: .It \-isoC-2011
2402: .St -isoC-2011
1.226 schwarze 2403: .br
2404: The third major version of the C language standard.
2405: .El
2406: .It POSIX.1 before the Single UNIX Specification
2407: .Pp
2408: .Bl -tag -width "-p1003.1g-2000" -compact
2409: .It \-p1003.1-88
2410: .St -p1003.1-88
2411: .It \-p1003.1
2412: .St -p1003.1
2413: .br
2414: The original POSIX standard, based on ANSI C.
2415: .Pp
2416: .It \-p1003.1-90
2417: .St -p1003.1-90
1.211 schwarze 2418: .It \-iso9945-1-90
2419: .St -iso9945-1-90
1.226 schwarze 2420: .br
2421: The first update of POSIX.1.
2422: .Pp
2423: .It \-p1003.1b-93
2424: .St -p1003.1b-93
2425: .It \-p1003.1b
2426: .St -p1003.1b
2427: .br
2428: Real-time extensions.
2429: .Pp
2430: .It \-p1003.1c-95
2431: .St -p1003.1c-95
2432: .br
2433: POSIX thread interfaces.
2434: .Pp
2435: .It \-p1003.1i-95
2436: .St -p1003.1i-95
2437: .br
2438: Technical Corrigendum.
2439: .Pp
2440: .It \-p1003.1-96
2441: .St -p1003.1-96
1.211 schwarze 2442: .It \-iso9945-1-96
2443: .St -iso9945-1-96
1.226 schwarze 2444: .br
2445: Includes POSIX.1-1990, 1b, 1c, and 1i.
2446: .El
2447: .It X/Open Portability Guide version 4 and related standards
2448: .Pp
2449: .Bl -tag -width "-p1003.1g-2000" -compact
2450: .It \-xpg3
2451: .St -xpg3
2452: .br
2453: An XPG4 precursor, published in 1989.
2454: .Pp
2455: .It \-p1003.2
2456: .St -p1003.2
2457: .It \-p1003.2-92
2458: .St -p1003.2-92
1.211 schwarze 2459: .It \-iso9945-2-93
2460: .St -iso9945-2-93
1.226 schwarze 2461: .br
2462: An XCU4 precursor.
2463: .Pp
2464: .It \-p1003.2a-92
2465: .St -p1003.2a-92
2466: .br
2467: Updates to POSIX.2.
2468: .Pp
1.211 schwarze 2469: .It \-xpg4
2470: .St -xpg4
1.226 schwarze 2471: .br
2472: Based on POSIX.1 and POSIX.2, published in 1992.
2473: .El
2474: .It Single UNIX Specification version 1 and related standards
2475: .Pp
2476: .Bl -tag -width "-p1003.1g-2000" -compact
1.236 schwarze 2477: .It \-susv1
2478: .St -susv1
1.211 schwarze 2479: .It \-xpg4.2
2480: .St -xpg4.2
1.226 schwarze 2481: .br
1.236 schwarze 2482: This standard was published in 1994.
1.226 schwarze 2483: It was used as the basis for UNIX 95 certification.
2484: The following three refer to parts of it.
2485: .Pp
2486: .It \-xsh4.2
2487: .St -xsh4.2
2488: .Pp
2489: .It \-xcurses4.2
2490: .St -xcurses4.2
2491: .Pp
2492: .It \-p1003.1g-2000
2493: .St -p1003.1g-2000
2494: .br
2495: Networking APIs, including sockets.
2496: .Pp
2497: .It \-svid4
2498: .St -svid4 ,
2499: .br
2500: Published in 1995.
2501: .El
2502: .It Single UNIX Specification version 2 and related standards
2503: .Pp
2504: .Bl -tag -width "-p1003.1g-2000" -compact
2505: .It \-susv2
2506: .St -susv2
2507: This Standard was published in 1997
2508: and is also called X/Open Portability Guide version 5.
2509: It was used as the basis for UNIX 98 certification.
2510: The following refer to parts of it.
2511: .Pp
1.211 schwarze 2512: .It \-xbd5
2513: .St -xbd5
1.226 schwarze 2514: .Pp
2515: .It \-xsh5
2516: .St -xsh5
2517: .Pp
1.211 schwarze 2518: .It \-xcu5
2519: .St -xcu5
1.226 schwarze 2520: .Pp
1.211 schwarze 2521: .It \-xns5
2522: .St -xns5
2523: .It \-xns5.2
2524: .St -xns5.2
1.226 schwarze 2525: .El
1.245 schwarze 2526: .It Single UNIX Specification version 3
1.226 schwarze 2527: .Pp
1.245 schwarze 2528: .Bl -tag -width "-p1003.1-2001" -compact
1.226 schwarze 2529: .It \-p1003.1-2001
2530: .St -p1003.1-2001
1.211 schwarze 2531: .It \-susv3
2532: .St -susv3
1.226 schwarze 2533: .br
2534: This standard is based on C99, SUSv2, POSIX.1-1996, 1d, and 1j.
2535: It is also called X/Open Portability Guide version 6.
2536: It is used as the basis for UNIX 03 certification.
2537: .Pp
2538: .It \-p1003.1-2004
2539: .St -p1003.1-2004
2540: .br
2541: The second and last Technical Corrigendum.
2542: .El
2543: .It Single UNIX Specification version 4
2544: .Pp
2545: .Bl -tag -width "-p1003.1g-2000" -compact
2546: .It \-p1003.1-2008
2547: .St -p1003.1-2008
1.236 schwarze 2548: .It \-susv4
2549: .St -susv4
1.226 schwarze 2550: .br
1.236 schwarze 2551: This standard is also called
1.226 schwarze 2552: X/Open Portability Guide version 7.
2553: .Pp
2554: .It \-p1003.1-2013
2555: .St -p1003.1-2013
2556: .br
2557: This is the first Technical Corrigendum.
2558: .El
2559: .It Other standards
2560: .Pp
2561: .Bl -tag -width "-p1003.1g-2000" -compact
2562: .It \-ieee754
2563: .St -ieee754
2564: .br
2565: Floating-point arithmetic.
2566: .Pp
2567: .It \-iso8601
2568: .St -iso8601
2569: .br
2570: Representation of dates and times, published in 1988.
2571: .Pp
2572: .It \-iso8802-3
2573: .St -iso8802-3
2574: .br
2575: Ethernet local area networks.
2576: .Pp
2577: .It \-ieee1275-94
2578: .St -ieee1275-94
2579: .El
1.211 schwarze 2580: .El
2581: .Ss \&Sx
2582: Reference a section or subsection in the same manual page.
2583: The referenced section or subsection name must be identical to the
2584: enclosed argument, including whitespace.
2585: .Pp
2586: Examples:
2587: .Dl \&.Sx MANUAL STRUCTURE
2588: .Pp
2589: See also
2590: .Sx \&Sh
2591: and
2592: .Sx \&Ss .
2593: .Ss \&Sy
1.235 schwarze 2594: Request a boldface font.
2595: .Pp
2596: This is most often used to indicate importance or seriousness (not to be
2597: confused with stress emphasis, see
2598: .Sx \&Em ) .
2599: When none of the semantic macros fit, it is also adequate for syntax
2600: elements that have to be given or that appear verbatim.
2601: .Pp
2602: Examples:
2603: .Bd -literal -compact -offset indent
2604: \&.Sy Warning :
2605: If
2606: \&.Sy s
2607: appears in the owner permissions, set-user-ID mode is set.
2608: This utility replaces the former
2609: \&.Sy dumpdir
2610: program.
2611: .Ed
1.211 schwarze 2612: .Pp
2613: See also
2614: .Sx \&Bf ,
2615: .Sx \&Em ,
2616: .Sx \&Li ,
2617: and
2618: .Sx \&No .
2619: .Ss \&Ta
2620: Table cell separator in
2621: .Sx \&Bl Fl column
2622: lists; can only be used below
2623: .Sx \&It .
2624: .Ss \&Tn
1.230 schwarze 2625: Supported only for compatibility, do not use this in new manuals.
2626: Even though the macro name
2627: .Pq Dq tradename
2628: suggests a semantic function, historic usage is inconsistent, mostly
2629: using it as a presentation-level macro to request a small caps font.
1.211 schwarze 2630: .Ss \&Ud
1.230 schwarze 2631: Supported only for compatibility, do not use this in new manuals.
1.211 schwarze 2632: Prints out
2633: .Dq currently under development.
2634: .Ss \&Ux
1.230 schwarze 2635: Supported only for compatibility, do not use this in new manuals.
2636: Prints out
2637: .Dq Ux .
1.211 schwarze 2638: .Ss \&Va
2639: A variable name.
2640: .Pp
2641: Examples:
2642: .Dl \&.Va foo
2643: .Dl \&.Va const char *bar ;
1.239 schwarze 2644: .Pp
2645: For function arguments and parameters, use
2646: .Sx \&Fa
2647: instead.
2648: For declarations of global variables in the
2649: .Em SYNOPSIS
2650: section, use
2651: .Sx \&Vt .
1.211 schwarze 2652: .Ss \&Vt
2653: A variable type.
1.239 schwarze 2654: .Pp
1.211 schwarze 2655: This is also used for indicating global variables in the
2656: .Em SYNOPSIS
2657: section, in which case a variable name is also specified.
2658: Note that it accepts
2659: .Sx Block partial-implicit
2660: syntax when invoked as the first macro on an input line in the
2661: .Em SYNOPSIS
2662: section, else it accepts ordinary
2663: .Sx In-line
2664: syntax.
2665: In the former case, this macro starts a new output line,
2666: and a blank line is inserted in front if there is a preceding
2667: function definition or include directive.
2668: .Pp
2669: Examples:
2670: .Dl \&.Vt unsigned char
2671: .Dl \&.Vt extern const char * const sys_signame[] \&;
2672: .Pp
1.239 schwarze 2673: For parameters in function prototypes, use
2674: .Sx \&Fa
2675: instead, for function return types
2676: .Sx \&Ft ,
2677: and for variable names outside the
2678: .Em SYNOPSIS
2679: section
2680: .Sx \&Va ,
2681: even when including a type with the name.
1.211 schwarze 2682: See also
1.239 schwarze 2683: .Sx MANUAL STRUCTURE .
1.211 schwarze 2684: .Ss \&Xc
2685: Close a scope opened by
2686: .Sx \&Xo .
2687: .Ss \&Xo
2688: Extend the header of an
2689: .Sx \&It
2690: macro or the body of a partial-implicit block macro
2691: beyond the end of the input line.
2692: This macro originally existed to work around the 9-argument limit
2693: of historic
2694: .Xr roff 7 .
2695: .Ss \&Xr
2696: Link to another manual
2697: .Pq Qq cross-reference .
2698: Its syntax is as follows:
2699: .Pp
1.216 schwarze 2700: .D1 Pf \. Sx \&Xr Ar name Op section
1.211 schwarze 2701: .Pp
1.216 schwarze 2702: Cross reference the
1.211 schwarze 2703: .Ar name
2704: and
2705: .Ar section
1.216 schwarze 2706: number of another man page;
2707: omitting the section number is rarely useful.
1.211 schwarze 2708: .Pp
2709: Examples:
2710: .Dl \&.Xr mandoc 1
2711: .Dl \&.Xr mandoc 1 \&;
2712: .Dl \&.Xr mandoc 1 \&Ns s behaviour
2713: .Ss \&br
2714: Emits a line-break.
2715: This macro should not be used; it is implemented for compatibility with
2716: historical manuals.
2717: .Pp
2718: Consider using
2719: .Sx \&Pp
2720: in the event of natural paragraph breaks.
2721: .Ss \&sp
2722: Emits vertical space.
2723: This macro should not be used; it is implemented for compatibility with
2724: historical manuals.
2725: Its syntax is as follows:
2726: .Pp
2727: .D1 Pf \. Sx \&sp Op Ar height
2728: .Pp
2729: The
2730: .Ar height
1.215 schwarze 2731: argument is a scaling width as described in
2732: .Xr roff 7 .
1.211 schwarze 2733: If unspecified,
2734: .Sx \&sp
2735: asserts a single vertical space.
2736: .Sh MACRO SYNTAX
2737: The syntax of a macro depends on its classification.
2738: In this section,
2739: .Sq \-arg
2740: refers to macro arguments, which may be followed by zero or more
2741: .Sq parm
2742: parameters;
2743: .Sq \&Yo
2744: opens the scope of a macro; and if specified,
2745: .Sq \&Yc
2746: closes it out.
2747: .Pp
2748: The
2749: .Em Callable
2750: column indicates that the macro may also be called by passing its name
2751: as an argument to another macro.
2752: For example,
2753: .Sq \&.Op \&Fl O \&Ar file
2754: produces
2755: .Sq Op Fl O Ar file .
2756: To prevent a macro call and render the macro name literally,
2757: escape it by prepending a zero-width space,
2758: .Sq \e& .
2759: For example,
2760: .Sq \&Op \e&Fl O
2761: produces
2762: .Sq Op \&Fl O .
2763: If a macro is not callable but its name appears as an argument
2764: to another macro, it is interpreted as opaque text.
2765: For example,
2766: .Sq \&.Fl \&Sh
2767: produces
2768: .Sq Fl \&Sh .
2769: .Pp
2770: The
2771: .Em Parsed
2772: column indicates whether the macro may call other macros by receiving
2773: their names as arguments.
2774: If a macro is not parsed but the name of another macro appears
2775: as an argument, it is interpreted as opaque text.
2776: .Pp
2777: The
2778: .Em Scope
2779: column, if applicable, describes closure rules.
2780: .Ss Block full-explicit
2781: Multi-line scope closed by an explicit closing macro.
2782: All macros contains bodies; only
2783: .Sx \&Bf
2784: and
2785: .Pq optionally
2786: .Sx \&Bl
2787: contain a head.
2788: .Bd -literal -offset indent
2789: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
2790: \(lBbody...\(rB
2791: \&.Yc
2792: .Ed
2793: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent
2794: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
2795: .It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed
2796: .It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef
2797: .It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek
2798: .It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El
2799: .It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd
2800: .It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf
2801: .It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk
2802: .It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl
2803: .El
2804: .Ss Block full-implicit
2805: Multi-line scope closed by end-of-file or implicitly by another macro.
2806: All macros have bodies; some
2807: .Po
2808: .Sx \&It Fl bullet ,
2809: .Fl hyphen ,
2810: .Fl dash ,
2811: .Fl enum ,
2812: .Fl item
2813: .Pc
2814: don't have heads; only one
2815: .Po
2816: .Sx \&It
2817: in
2818: .Sx \&Bl Fl column
2819: .Pc
2820: has multiple heads.
2821: .Bd -literal -offset indent
2822: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
2823: \(lBbody...\(rB
2824: .Ed
2825: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent
2826: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
2827: .It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El
2828: .It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh
2829: .It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss
2830: .It Sx \&Sh Ta \&No Ta Yes Ta closed by Sx \&Sh
2831: .It Sx \&Ss Ta \&No Ta Yes Ta closed by Sx \&Sh , Sx \&Ss
2832: .El
2833: .Pp
2834: Note that the
2835: .Sx \&Nm
2836: macro is a
2837: .Sx Block full-implicit
2838: macro only when invoked as the first macro
2839: in a
2840: .Em SYNOPSIS
2841: section line, else it is
2842: .Sx In-line .
2843: .Ss Block partial-explicit
2844: Like block full-explicit, but also with single-line scope.
2845: Each has at least a body and, in limited circumstances, a head
2846: .Po
2847: .Sx \&Fo ,
2848: .Sx \&Eo
2849: .Pc
2850: and/or tail
2851: .Pq Sx \&Ec .
2852: .Bd -literal -offset indent
2853: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
2854: \(lBbody...\(rB
2855: \&.Yc \(lBtail...\(rB
2856:
2857: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
2858: \(lBbody...\(rB \&Yc \(lBtail...\(rB
2859: .Ed
2860: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
2861: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
2862: .It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao
2863: .It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac
2864: .It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo
2865: .It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc
2866: .It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro
2867: .It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc
2868: .It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do
2869: .It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc
2870: .It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo
2871: .It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec
2872: .It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo
2873: .It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc
2874: .It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo
2875: .It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc
2876: .It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po
2877: .It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc
2878: .It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo
2879: .It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc
2880: .It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs
2881: .It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re
2882: .It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So
2883: .It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc
2884: .It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo
2885: .It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc
2886: .El
2887: .Ss Block partial-implicit
2888: Like block full-implicit, but with single-line scope closed by the
2889: end of the line.
2890: .Bd -literal -offset indent
2891: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
2892: .Ed
2893: .Bl -column "MacroX" "CallableX" "ParsedX" -offset indent
2894: .It Em Macro Ta Em Callable Ta Em Parsed
2895: .It Sx \&Aq Ta Yes Ta Yes
2896: .It Sx \&Bq Ta Yes Ta Yes
2897: .It Sx \&Brq Ta Yes Ta Yes
2898: .It Sx \&D1 Ta \&No Ta \&Yes
2899: .It Sx \&Dl Ta \&No Ta Yes
2900: .It Sx \&Dq Ta Yes Ta Yes
1.231 schwarze 2901: .It Sx \&En Ta Yes Ta Yes
1.211 schwarze 2902: .It Sx \&Op Ta Yes Ta Yes
2903: .It Sx \&Pq Ta Yes Ta Yes
2904: .It Sx \&Ql Ta Yes Ta Yes
2905: .It Sx \&Qq Ta Yes Ta Yes
2906: .It Sx \&Sq Ta Yes Ta Yes
2907: .It Sx \&Vt Ta Yes Ta Yes
2908: .El
2909: .Pp
2910: Note that the
2911: .Sx \&Vt
2912: macro is a
2913: .Sx Block partial-implicit
2914: only when invoked as the first macro
2915: in a
2916: .Em SYNOPSIS
2917: section line, else it is
2918: .Sx In-line .
2919: .Ss Special block macro
2920: The
2921: .Sx \&Ta
2922: macro can only be used below
2923: .Sx \&It
2924: in
2925: .Sx \&Bl Fl column
2926: lists.
2927: It delimits blocks representing table cells;
2928: these blocks have bodies, but no heads.
2929: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
2930: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
2931: .It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It
2932: .El
2933: .Ss In-line
2934: Closed by the end of the line, fixed argument lengths,
2935: and/or subsequent macros.
2936: In-line macros have only text children.
2937: If a number (or inequality) of arguments is
2938: .Pq n ,
2939: then the macro accepts an arbitrary number of arguments.
2940: .Bd -literal -offset indent
2941: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB
2942:
2943: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
2944:
2945: \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
2946: .Ed
2947: .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent
2948: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
2949: .It Sx \&%A Ta \&No Ta \&No Ta >0
2950: .It Sx \&%B Ta \&No Ta \&No Ta >0
2951: .It Sx \&%C Ta \&No Ta \&No Ta >0
2952: .It Sx \&%D Ta \&No Ta \&No Ta >0
2953: .It Sx \&%I Ta \&No Ta \&No Ta >0
2954: .It Sx \&%J Ta \&No Ta \&No Ta >0
2955: .It Sx \&%N Ta \&No Ta \&No Ta >0
2956: .It Sx \&%O Ta \&No Ta \&No Ta >0
2957: .It Sx \&%P Ta \&No Ta \&No Ta >0
2958: .It Sx \&%Q Ta \&No Ta \&No Ta >0
2959: .It Sx \&%R Ta \&No Ta \&No Ta >0
2960: .It Sx \&%T Ta \&No Ta \&No Ta >0
2961: .It Sx \&%U Ta \&No Ta \&No Ta >0
2962: .It Sx \&%V Ta \&No Ta \&No Ta >0
2963: .It Sx \&Ad Ta Yes Ta Yes Ta >0
2964: .It Sx \&An Ta Yes Ta Yes Ta >0
2965: .It Sx \&Ap Ta Yes Ta Yes Ta 0
2966: .It Sx \&Ar Ta Yes Ta Yes Ta n
2967: .It Sx \&At Ta Yes Ta Yes Ta 1
2968: .It Sx \&Bsx Ta Yes Ta Yes Ta n
2969: .It Sx \&Bt Ta \&No Ta \&No Ta 0
2970: .It Sx \&Bx Ta Yes Ta Yes Ta n
2971: .It Sx \&Cd Ta Yes Ta Yes Ta >0
2972: .It Sx \&Cm Ta Yes Ta Yes Ta >0
2973: .It Sx \&Db Ta \&No Ta \&No Ta 1
2974: .It Sx \&Dd Ta \&No Ta \&No Ta n
2975: .It Sx \&Dt Ta \&No Ta \&No Ta n
2976: .It Sx \&Dv Ta Yes Ta Yes Ta >0
2977: .It Sx \&Dx Ta Yes Ta Yes Ta n
2978: .It Sx \&Em Ta Yes Ta Yes Ta >0
2979: .It Sx \&Er Ta Yes Ta Yes Ta >0
1.231 schwarze 2980: .It Sx \&Es Ta Yes Ta Yes Ta 2
1.211 schwarze 2981: .It Sx \&Ev Ta Yes Ta Yes Ta >0
2982: .It Sx \&Ex Ta \&No Ta \&No Ta n
2983: .It Sx \&Fa Ta Yes Ta Yes Ta >0
2984: .It Sx \&Fd Ta \&No Ta \&No Ta >0
2985: .It Sx \&Fl Ta Yes Ta Yes Ta n
2986: .It Sx \&Fn Ta Yes Ta Yes Ta >0
1.231 schwarze 2987: .It Sx \&Fr Ta Yes Ta Yes Ta >0
1.211 schwarze 2988: .It Sx \&Ft Ta Yes Ta Yes Ta >0
2989: .It Sx \&Fx Ta Yes Ta Yes Ta n
2990: .It Sx \&Hf Ta \&No Ta \&No Ta n
2991: .It Sx \&Ic Ta Yes Ta Yes Ta >0
2992: .It Sx \&In Ta \&No Ta \&No Ta 1
2993: .It Sx \&Lb Ta \&No Ta \&No Ta 1
2994: .It Sx \&Li Ta Yes Ta Yes Ta >0
2995: .It Sx \&Lk Ta Yes Ta Yes Ta >0
2996: .It Sx \&Lp Ta \&No Ta \&No Ta 0
2997: .It Sx \&Ms Ta Yes Ta Yes Ta >0
2998: .It Sx \&Mt Ta Yes Ta Yes Ta >0
2999: .It Sx \&Nm Ta Yes Ta Yes Ta n
3000: .It Sx \&No Ta Yes Ta Yes Ta 0
3001: .It Sx \&Ns Ta Yes Ta Yes Ta 0
3002: .It Sx \&Nx Ta Yes Ta Yes Ta n
3003: .It Sx \&Os Ta \&No Ta \&No Ta n
1.231 schwarze 3004: .It Sx \&Ot Ta Yes Ta Yes Ta >0
1.211 schwarze 3005: .It Sx \&Ox Ta Yes Ta Yes Ta n
3006: .It Sx \&Pa Ta Yes Ta Yes Ta n
3007: .It Sx \&Pf Ta Yes Ta Yes Ta 1
3008: .It Sx \&Pp Ta \&No Ta \&No Ta 0
3009: .It Sx \&Rv Ta \&No Ta \&No Ta n
1.234 schwarze 3010: .It Sx \&Sm Ta \&No Ta \&No Ta <2
1.211 schwarze 3011: .It Sx \&St Ta \&No Ta Yes Ta 1
3012: .It Sx \&Sx Ta Yes Ta Yes Ta >0
3013: .It Sx \&Sy Ta Yes Ta Yes Ta >0
3014: .It Sx \&Tn Ta Yes Ta Yes Ta >0
3015: .It Sx \&Ud Ta \&No Ta \&No Ta 0
3016: .It Sx \&Ux Ta Yes Ta Yes Ta n
3017: .It Sx \&Va Ta Yes Ta Yes Ta n
3018: .It Sx \&Vt Ta Yes Ta Yes Ta >0
3019: .It Sx \&Xr Ta Yes Ta Yes Ta >0
3020: .It Sx \&br Ta \&No Ta \&No Ta 0
3021: .It Sx \&sp Ta \&No Ta \&No Ta 1
1.139 kristaps 3022: .El
1.211 schwarze 3023: .Ss Delimiters
3024: When a macro argument consists of one single input character
3025: considered as a delimiter, the argument gets special handling.
3026: This does not apply when delimiters appear in arguments containing
3027: more than one character.
3028: Consequently, to prevent special handling and just handle it
3029: like any other argument, a delimiter can be escaped by prepending
3030: a zero-width space
3031: .Pq Sq \e& .
3032: In text lines, delimiters never need escaping, but may be used
3033: as normal punctuation.
1.138 kristaps 3034: .Pp
1.211 schwarze 3035: For many macros, when the leading arguments are opening delimiters,
3036: these delimiters are put before the macro scope,
3037: and when the trailing arguments are closing delimiters,
3038: these delimiters are put after the macro scope.
3039: For example,
1.172 kristaps 3040: .Pp
1.211 schwarze 3041: .D1 Pf \. \&Aq "( [ word ] ) ."
1.138 kristaps 3042: .Pp
1.211 schwarze 3043: renders as:
1.138 kristaps 3044: .Pp
1.211 schwarze 3045: .D1 Aq ( [ word ] ) .
1.198 schwarze 3046: .Pp
1.211 schwarze 3047: Opening delimiters are:
1.65 kristaps 3048: .Pp
1.211 schwarze 3049: .Bl -tag -width Ds -offset indent -compact
3050: .It \&(
3051: left parenthesis
3052: .It \&[
3053: left bracket
3054: .El
1.65 kristaps 3055: .Pp
1.211 schwarze 3056: Closing delimiters are:
1.132 kristaps 3057: .Pp
1.211 schwarze 3058: .Bl -tag -width Ds -offset indent -compact
3059: .It \&.
3060: period
3061: .It \&,
3062: comma
3063: .It \&:
3064: colon
3065: .It \&;
3066: semicolon
3067: .It \&)
3068: right parenthesis
3069: .It \&]
3070: right bracket
3071: .It \&?
3072: question mark
3073: .It \&!
3074: exclamation mark
3075: .El
1.83 kristaps 3076: .Pp
1.211 schwarze 3077: Note that even a period preceded by a backslash
3078: .Pq Sq \e.\&
3079: gets this special handling; use
3080: .Sq \e&.
3081: to prevent that.
1.83 kristaps 3082: .Pp
1.211 schwarze 3083: Many in-line macros interrupt their scope when they encounter
3084: delimiters, and resume their scope when more arguments follow that
3085: are not delimiters.
3086: For example,
1.83 kristaps 3087: .Pp
1.211 schwarze 3088: .D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e"
1.84 kristaps 3089: .Pp
1.211 schwarze 3090: renders as:
1.84 kristaps 3091: .Pp
1.211 schwarze 3092: .D1 Fl a ( b | c \*(Ba d ) e
1.84 kristaps 3093: .Pp
1.211 schwarze 3094: This applies to both opening and closing delimiters,
3095: and also to the middle delimiter:
1.140 kristaps 3096: .Pp
1.211 schwarze 3097: .Bl -tag -width Ds -offset indent -compact
3098: .It \&|
3099: vertical bar
3100: .El
1.140 kristaps 3101: .Pp
1.211 schwarze 3102: As a special case, the predefined string \e*(Ba is handled and rendered
3103: in the same way as a plain
3104: .Sq \&|
3105: character.
3106: Using this predefined string is not recommended in new manuals.
3107: .Ss Font handling
3108: In
3109: .Nm
3110: documents, usage of semantic markup is recommended in order to have
3111: proper fonts automatically selected; only when no fitting semantic markup
3112: is available, consider falling back to
3113: .Sx Physical markup
3114: macros.
3115: Whenever any
3116: .Nm
3117: macro switches the
3118: .Xr roff 7
3119: font mode, it will automatically restore the previous font when exiting
3120: its scope.
3121: Manually switching the font using the
3122: .Xr roff 7
3123: .Ql \ef
3124: font escape sequences is never required.
1.4 kristaps 3125: .Sh COMPATIBILITY
1.229 schwarze 3126: This section provides an incomplete list of compatibility issues
3127: between mandoc and other troff implementations, at this time limited
3128: to GNU troff
1.93 kristaps 3129: .Pq Qq groff .
1.50 kristaps 3130: The term
1.57 kristaps 3131: .Qq historic groff
1.166 schwarze 3132: refers to groff versions before 1.17,
3133: which featured a significant update of the
1.57 kristaps 3134: .Pa doc.tmac
1.166 schwarze 3135: file.
1.57 kristaps 3136: .Pp
1.93 kristaps 3137: Heirloom troff, the other significant troff implementation accepting
3138: \-mdoc, is similar to historic groff.
3139: .Pp
1.150 kristaps 3140: The following problematic behaviour is found in groff:
3141: .ds hist (Historic groff only.)
3142: .Pp
1.57 kristaps 3143: .Bl -dash -compact
1.168 kristaps 3144: .It
3145: Display macros
1.171 schwarze 3146: .Po
3147: .Sx \&Bd ,
3148: .Sx \&Dl ,
3149: and
3150: .Sx \&D1
3151: .Pc
1.168 kristaps 3152: may not be nested.
3153: \*[hist]
1.147 kristaps 3154: .It
1.150 kristaps 3155: .Sx \&At
3156: with unknown arguments produces no output at all.
3157: \*[hist]
3158: Newer groff and mandoc print
3159: .Qq AT&T UNIX
3160: and the arguments.
1.149 kristaps 3161: .It
1.190 schwarze 3162: .Sx \&Bl Fl column
1.208 kristaps 3163: does not recognise trailing punctuation characters when they immediately
1.150 kristaps 3164: precede tabulator characters, but treats them as normal text and
3165: outputs a space before them.
3166: .It
3167: .Sx \&Bd Fl ragged compact
3168: does not start a new line.
3169: \*[hist]
1.142 kristaps 3170: .It
1.150 kristaps 3171: .Sx \&Dd
1.181 schwarze 3172: with non-standard arguments behaves very strangely.
3173: When there are three arguments, they are printed verbatim.
3174: Any other number of arguments is replaced by the current date,
3175: but without any arguments the string
3176: .Dq Epoch
3177: is printed.
1.125 kristaps 3178: .It
1.150 kristaps 3179: .Sx \&Fl
3180: does not print a dash for an empty argument.
3181: \*[hist]
1.137 kristaps 3182: .It
1.150 kristaps 3183: .Sx \&Fn
3184: does not start a new line unless invoked as the line macro in the
3185: .Em SYNOPSIS
3186: section.
3187: \*[hist]
1.119 kristaps 3188: .It
1.150 kristaps 3189: .Sx \&Fo
3190: with
1.120 kristaps 3191: .Pf non- Sx \&Fa
1.150 kristaps 3192: children causes inconsistent spacing between arguments.
3193: In mandoc, a single space is always inserted between arguments.
1.120 kristaps 3194: .It
3195: .Sx \&Ft
3196: in the
1.150 kristaps 3197: .Em SYNOPSIS
3198: causes inconsistent vertical spacing, depending on whether a prior
1.120 kristaps 3199: .Sx \&Fn
3200: has been invoked.
3201: See
3202: .Sx \&Ft
3203: and
3204: .Sx \&Fn
1.150 kristaps 3205: for the normalised behaviour in mandoc.
1.120 kristaps 3206: .It
1.150 kristaps 3207: .Sx \&In
3208: ignores additional arguments and is not treated specially in the
3209: .Em SYNOPSIS .
3210: \*[hist]
1.118 kristaps 3211: .It
1.150 kristaps 3212: .Sx \&It
3213: sometimes requires a
3214: .Fl nested
3215: flag.
3216: \*[hist]
3217: In new groff and mandoc, any list may be nested by default and
3218: .Fl enum
3219: lists will restart the sequence only for the sub-list.
1.115 kristaps 3220: .It
1.150 kristaps 3221: .Sx \&Li
1.195 schwarze 3222: followed by a delimiter is incorrectly used in some manuals
1.150 kristaps 3223: instead of properly quoting that character, which sometimes works with
3224: historic groff.
1.57 kristaps 3225: .It
1.150 kristaps 3226: .Sx \&Lk
3227: only accepts a single link-name argument; the remainder is misformatted.
1.81 kristaps 3228: .It
1.80 kristaps 3229: .Sx \&Pa
1.150 kristaps 3230: does not format its arguments when used in the FILES section under
1.100 kristaps 3231: certain list types.
1.80 kristaps 3232: .It
1.150 kristaps 3233: .Sx \&Ta
3234: can only be called by other macros, but not at the beginning of a line.
3235: .It
3236: .Sx \&%C
1.229 schwarze 3237: is not implemented (up to and including groff-1.22.2).
1.166 schwarze 3238: .It
3239: Historic groff only allows up to eight or nine arguments per macro input
3240: line, depending on the exact situation.
3241: Providing more arguments causes garbled output.
3242: The number of arguments on one input line is not limited with mandoc.
1.150 kristaps 3243: .It
3244: Historic groff has many un-callable macros.
3245: Most of these (excluding some block-level macros) are callable
3246: in new groff and mandoc.
3247: .It
3248: .Sq \(ba
3249: (vertical bar) is not fully supported as a delimiter.
3250: \*[hist]
1.79 kristaps 3251: .It
1.77 kristaps 3252: .Sq \ef
1.150 kristaps 3253: .Pq font face
3254: and
1.229 schwarze 3255: .Sq \eF
1.150 kristaps 3256: .Pq font family face
1.93 kristaps 3257: .Sx Text Decoration
1.150 kristaps 3258: escapes behave irregularly when specified within line-macro scopes.
1.77 kristaps 3259: .It
1.150 kristaps 3260: Negative scaling units return to prior lines.
3261: Instead, mandoc truncates them to zero.
3262: .El
3263: .Pp
3264: The following features are unimplemented in mandoc:
3265: .Pp
3266: .Bl -dash -compact
1.61 kristaps 3267: .It
1.150 kristaps 3268: .Sx \&Bd
3269: .Fl file Ar file .
1.57 kristaps 3270: .It
1.78 kristaps 3271: .Sx \&Bd
1.225 schwarze 3272: .Fl offset Cm center
1.64 kristaps 3273: and
1.225 schwarze 3274: .Fl offset Cm right .
1.208 kristaps 3275: Groff does not implement centred and flush-right rendering either,
1.150 kristaps 3276: but produces large indentations.
1.57 kristaps 3277: .El
1.2 kristaps 3278: .Sh SEE ALSO
1.159 schwarze 3279: .Xr man 1 ,
1.57 kristaps 3280: .Xr mandoc 1 ,
1.180 kristaps 3281: .Xr eqn 7 ,
1.174 kristaps 3282: .Xr man 7 ,
1.198 schwarze 3283: .Xr mandoc_char 7 ,
1.174 kristaps 3284: .Xr roff 7 ,
3285: .Xr tbl 7
1.151 kristaps 3286: .Sh HISTORY
3287: The
3288: .Nm
3289: language first appeared as a troff macro package in
3290: .Bx 4.4 .
3291: It was later significantly updated by Werner Lemberg and Ruslan Ermilov
1.155 kristaps 3292: in groff-1.17.
1.151 kristaps 3293: The standalone implementation that is part of the
3294: .Xr mandoc 1
3295: utility written by Kristaps Dzonsons appeared in
3296: .Ox 4.6 .
1.2 kristaps 3297: .Sh AUTHORS
3298: The
1.57 kristaps 3299: .Nm
1.50 kristaps 3300: reference was written by
1.219 schwarze 3301: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
CVSweb