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