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