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