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