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