Annotation of mandoc/mdoc.7, Revision 1.235
1.235 ! schwarze 1: .\" $Id: mdoc.7,v 1.234 2014/08/08 16:38:06 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.234 schwarze 18: .Dd $Mdocdate: August 8 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
391: alphabetically.
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.215 schwarze 940: arguments accept scaling widths as described in
941: .Xr roff 7
1.141 kristaps 942: or use the length of the given string.
943: The
944: .Fl offset
945: is a global indentation for the whole list, affecting both item heads
946: and bodies.
947: For those list types supporting it, the
948: .Fl width
949: argument requests an additional indentation of item bodies,
950: to be added to the
951: .Fl offset .
952: Unless the
953: .Fl compact
954: argument is specified, list entries are separated by vertical space.
955: .Pp
1.103 kristaps 956: A list must specify one of the following list types:
957: .Bl -tag -width 12n -offset indent
958: .It Fl bullet
1.141 kristaps 959: No item heads can be specified, but a bullet will be printed at the head
960: of each item.
961: Item bodies start on the same output line as the bullet
962: and are indented according to the
1.104 kristaps 963: .Fl width
1.141 kristaps 964: argument.
1.103 kristaps 965: .It Fl column
966: A columnated list.
1.104 kristaps 967: The
968: .Fl width
1.141 kristaps 969: argument has no effect; instead, each argument specifies the width
1.215 schwarze 970: of one column, using either the scaling width syntax described in
971: .Xr roff 7
972: or the string length of the argument.
1.141 kristaps 973: If the first line of the body of a
1.114 kristaps 974: .Fl column
975: list is not an
976: .Sx \&It
1.141 kristaps 977: macro line,
978: .Sx \&It
979: contexts spanning one input line each are implied until an
1.114 kristaps 980: .Sx \&It
1.141 kristaps 981: macro line is encountered, at which point items start being interpreted as
1.114 kristaps 982: described in the
983: .Sx \&It
984: documentation.
1.103 kristaps 985: .It Fl dash
1.141 kristaps 986: Like
987: .Fl bullet ,
988: except that dashes are used in place of bullets.
1.103 kristaps 989: .It Fl diag
990: Like
991: .Fl inset ,
1.141 kristaps 992: except that item heads are not parsed for macro invocations.
1.198 schwarze 993: Most often used in the
994: .Em DIAGNOSTICS
995: section with error constants in the item heads.
1.103 kristaps 996: .It Fl enum
1.141 kristaps 997: A numbered list.
1.198 schwarze 998: No item heads can be specified.
1.141 kristaps 999: Formatted like
1000: .Fl bullet ,
1001: except that cardinal numbers are used in place of bullets,
1002: starting at 1.
1.103 kristaps 1003: .It Fl hang
1004: Like
1005: .Fl tag ,
1.141 kristaps 1006: except that the first lines of item bodies are not indented, but follow
1007: the item heads like in
1008: .Fl inset
1009: lists.
1.103 kristaps 1010: .It Fl hyphen
1011: Synonym for
1012: .Fl dash .
1013: .It Fl inset
1.141 kristaps 1014: Item bodies follow items heads on the same line, using normal inter-word
1015: spacing.
1016: Bodies are not indented, and the
1.104 kristaps 1017: .Fl width
1018: argument is ignored.
1.103 kristaps 1019: .It Fl item
1.141 kristaps 1020: No item heads can be specified, and none are printed.
1021: Bodies are not indented, and the
1.104 kristaps 1022: .Fl width
1023: argument is ignored.
1.103 kristaps 1024: .It Fl ohang
1.141 kristaps 1025: Item bodies start on the line following item heads and are not indented.
1.104 kristaps 1026: The
1027: .Fl width
1028: argument is ignored.
1.103 kristaps 1029: .It Fl tag
1.141 kristaps 1030: Item bodies are indented according to the
1.103 kristaps 1031: .Fl width
1032: argument.
1.141 kristaps 1033: When an item head fits inside the indentation, the item body follows
1034: this head on the same output line.
1035: Otherwise, the body starts on the output line following the head.
1.103 kristaps 1036: .El
1.114 kristaps 1037: .Pp
1.198 schwarze 1038: Lists may be nested within lists and displays.
1039: Nesting of
1040: .Fl column
1041: and
1042: .Fl enum
1043: lists may not be portable.
1044: .Pp
1.114 kristaps 1045: See also
1.141 kristaps 1046: .Sx \&El
1047: and
1.114 kristaps 1048: .Sx \&It .
1.63 kristaps 1049: .Ss \&Bo
1.141 kristaps 1050: Begin a block enclosed by square brackets.
1.100 kristaps 1051: Does not have any head arguments.
1.65 kristaps 1052: .Pp
1053: Examples:
1.140 kristaps 1054: .Bd -literal -offset indent -compact
1.65 kristaps 1055: \&.Bo 1 ,
1.91 kristaps 1056: \&.Dv BUFSIZ \&Bc
1.65 kristaps 1057: .Ed
1058: .Pp
1059: See also
1060: .Sx \&Bq .
1.63 kristaps 1061: .Ss \&Bq
1.82 kristaps 1062: Encloses its arguments in square brackets.
1.65 kristaps 1063: .Pp
1064: Examples:
1.173 kristaps 1065: .Dl \&.Bq 1 , \&Dv BUFSIZ
1.65 kristaps 1066: .Pp
1067: .Em Remarks :
1068: this macro is sometimes abused to emulate optional arguments for
1069: commands; the correct macros to use for this purpose are
1070: .Sx \&Op ,
1071: .Sx \&Oo ,
1072: and
1073: .Sx \&Oc .
1074: .Pp
1075: See also
1076: .Sx \&Bo .
1.63 kristaps 1077: .Ss \&Brc
1.141 kristaps 1078: Close a
1.65 kristaps 1079: .Sx \&Bro
1.138 kristaps 1080: block.
1081: Does not have any tail arguments.
1.63 kristaps 1082: .Ss \&Bro
1.141 kristaps 1083: Begin a block enclosed by curly braces.
1.100 kristaps 1084: Does not have any head arguments.
1.65 kristaps 1085: .Pp
1086: Examples:
1.140 kristaps 1087: .Bd -literal -offset indent -compact
1.65 kristaps 1088: \&.Bro 1 , ... ,
1.91 kristaps 1089: \&.Va n \&Brc
1.65 kristaps 1090: .Ed
1091: .Pp
1092: See also
1093: .Sx \&Brq .
1.63 kristaps 1094: .Ss \&Brq
1.65 kristaps 1095: Encloses its arguments in curly braces.
1096: .Pp
1097: Examples:
1.173 kristaps 1098: .Dl \&.Brq 1 , ... , \&Va n
1.65 kristaps 1099: .Pp
1100: See also
1101: .Sx \&Bro .
1.63 kristaps 1102: .Ss \&Bsx
1.220 schwarze 1103: Format the
1104: .Bsx
1105: version provided as an argument, or a default value if
1.65 kristaps 1106: no argument is provided.
1107: .Pp
1108: Examples:
1.173 kristaps 1109: .Dl \&.Bsx 1.0
1110: .Dl \&.Bsx
1.65 kristaps 1111: .Pp
1112: See also
1113: .Sx \&At ,
1114: .Sx \&Bx ,
1.66 kristaps 1115: .Sx \&Dx ,
1.65 kristaps 1116: .Sx \&Fx ,
1117: .Sx \&Nx ,
1118: and
1.230 schwarze 1119: .Sx \&Ox .
1.63 kristaps 1120: .Ss \&Bt
1.230 schwarze 1121: Supported only for compatibility, do not use this in new manuals.
1.66 kristaps 1122: Prints
1.198 schwarze 1123: .Dq is currently in beta test.
1.63 kristaps 1124: .Ss \&Bx
1.220 schwarze 1125: Format the
1126: .Bx
1127: version provided as an argument, or a default value if no
1.65 kristaps 1128: argument is provided.
1129: .Pp
1130: Examples:
1.198 schwarze 1131: .Dl \&.Bx 4.3 Tahoe
1.173 kristaps 1132: .Dl \&.Bx 4.4
1133: .Dl \&.Bx
1.65 kristaps 1134: .Pp
1135: See also
1136: .Sx \&At ,
1137: .Sx \&Bsx ,
1.66 kristaps 1138: .Sx \&Dx ,
1.65 kristaps 1139: .Sx \&Fx ,
1140: .Sx \&Nx ,
1141: and
1.230 schwarze 1142: .Sx \&Ox .
1.63 kristaps 1143: .Ss \&Cd
1.141 kristaps 1144: Kernel configuration declaration.
1.100 kristaps 1145: This denotes strings accepted by
1.66 kristaps 1146: .Xr config 8 .
1.196 schwarze 1147: It is most often used in section 4 manual pages.
1.66 kristaps 1148: .Pp
1149: Examples:
1.173 kristaps 1150: .Dl \&.Cd device le0 at scode?
1.66 kristaps 1151: .Pp
1152: .Em Remarks :
1153: this macro is commonly abused by using quoted literals to retain
1.138 kristaps 1154: whitespace and align consecutive
1.66 kristaps 1155: .Sx \&Cd
1.100 kristaps 1156: declarations.
1157: This practise is discouraged.
1.63 kristaps 1158: .Ss \&Cm
1.100 kristaps 1159: Command modifiers.
1.196 schwarze 1160: Typically used for fixed strings passed as arguments, unless
1161: .Sx \&Fl
1162: is more appropriate.
1163: Also useful when specifying configuration options or keys.
1.66 kristaps 1164: .Pp
1165: Examples:
1.196 schwarze 1166: .Dl ".Nm mt Fl f Ar device Cm rewind"
1167: .Dl ".Nm ps Fl o Cm pid , Ns Cm command"
1168: .Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
1169: .Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"
1170: .Dl ".Cm LogLevel Dv DEBUG"
1.63 kristaps 1171: .Ss \&D1
1.100 kristaps 1172: One-line indented display.
1173: This is formatted by the default rules and is useful for simple indented
1174: statements.
1175: It is followed by a newline.
1.66 kristaps 1176: .Pp
1177: Examples:
1.173 kristaps 1178: .Dl \&.D1 \&Fl abcdefgh
1.66 kristaps 1179: .Pp
1180: See also
1181: .Sx \&Bd
1182: and
1183: .Sx \&Dl .
1.63 kristaps 1184: .Ss \&Db
1.141 kristaps 1185: Switch debugging mode.
1.120 kristaps 1186: Its syntax is as follows:
1.117 kristaps 1187: .Pp
1.120 kristaps 1188: .D1 Pf \. Sx \&Db Cm on | off
1.141 kristaps 1189: .Pp
1190: This macro is ignored by
1191: .Xr mandoc 1 .
1.63 kristaps 1192: .Ss \&Dc
1.141 kristaps 1193: Close a
1.66 kristaps 1194: .Sx \&Do
1.138 kristaps 1195: block.
1196: Does not have any tail arguments.
1.63 kristaps 1197: .Ss \&Dd
1.233 schwarze 1198: Document date for display in the page footer.
1.100 kristaps 1199: This is the mandatory first macro of any
1.66 kristaps 1200: .Nm
1.100 kristaps 1201: manual.
1.120 kristaps 1202: Its syntax is as follows:
1.66 kristaps 1203: .Pp
1.181 schwarze 1204: .D1 Pf \. Sx \&Dd Ar month day , year
1.66 kristaps 1205: .Pp
1.82 kristaps 1206: The
1.181 schwarze 1207: .Ar month
1208: is the full English month name, the
1209: .Ar day
1210: is an optionally zero-padded numeral, and the
1211: .Ar year
1212: is the full four-digit year.
1213: .Pp
1214: Other arguments are not portable; the
1215: .Xr mandoc 1
1216: utility handles them as follows:
1217: .Bl -dash -offset 3n -compact
1218: .It
1219: To have the date automatically filled in by the
1220: .Ox
1221: version of
1.72 kristaps 1222: .Xr cvs 1 ,
1.181 schwarze 1223: the special string
1224: .Dq $\&Mdocdate$
1225: can be given as an argument.
1226: .It
1.233 schwarze 1227: The traditional, purely numeric
1228: .Xr man 7
1229: format
1230: .Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day
1231: is accepted, too.
1.181 schwarze 1232: .It
1233: If a date string cannot be parsed, it is used verbatim.
1234: .It
1235: If no date string is given, the current date is used.
1236: .El
1.66 kristaps 1237: .Pp
1238: Examples:
1.173 kristaps 1239: .Dl \&.Dd $\&Mdocdate$
1240: .Dl \&.Dd $\&Mdocdate: July 21 2007$
1241: .Dl \&.Dd July 21, 2007
1.66 kristaps 1242: .Pp
1243: See also
1244: .Sx \&Dt
1245: and
1246: .Sx \&Os .
1.63 kristaps 1247: .Ss \&Dl
1.100 kristaps 1248: One-line intended display.
1249: This is formatted as literal text and is useful for commands and
1250: invocations.
1251: It is followed by a newline.
1.66 kristaps 1252: .Pp
1253: Examples:
1.173 kristaps 1254: .Dl \&.Dl % mandoc mdoc.7 \e(ba less
1.66 kristaps 1255: .Pp
1256: See also
1257: .Sx \&Bd
1258: and
1259: .Sx \&D1 .
1.63 kristaps 1260: .Ss \&Do
1.141 kristaps 1261: Begin a block enclosed by double quotes.
1.138 kristaps 1262: Does not have any head arguments.
1.66 kristaps 1263: .Pp
1264: Examples:
1.140 kristaps 1265: .Bd -literal -offset indent -compact
1266: \&.Do
1267: April is the cruellest month
1268: \&.Dc
1269: \e(em T.S. Eliot
1270: .Ed
1.66 kristaps 1271: .Pp
1272: See also
1273: .Sx \&Dq .
1.63 kristaps 1274: .Ss \&Dq
1.138 kristaps 1275: Encloses its arguments in
1276: .Dq typographic
1277: double-quotes.
1.66 kristaps 1278: .Pp
1279: Examples:
1.91 kristaps 1280: .Bd -literal -offset indent -compact
1.66 kristaps 1281: \&.Dq April is the cruellest month
1282: \e(em T.S. Eliot
1283: .Ed
1284: .Pp
1285: See also
1.139 kristaps 1286: .Sx \&Qq ,
1287: .Sx \&Sq ,
1.138 kristaps 1288: and
1.66 kristaps 1289: .Sx \&Do .
1.139 kristaps 1290: .Ss \&Dt
1.233 schwarze 1291: Document title for display in the page header.
1.100 kristaps 1292: This is the mandatory second macro of any
1.66 kristaps 1293: .Nm
1.100 kristaps 1294: file.
1.120 kristaps 1295: Its syntax is as follows:
1296: .Bd -ragged -offset indent
1297: .Pf \. Sx \&Dt
1.233 schwarze 1298: .Ar TITLE
1.141 kristaps 1299: .Ar section
1.233 schwarze 1300: .Op Ar volume | arch
1.120 kristaps 1301: .Ed
1.66 kristaps 1302: .Pp
1303: Its arguments are as follows:
1.233 schwarze 1304: .Bl -tag -width section -offset 2n
1305: .It Ar TITLE
1.111 kristaps 1306: The document's title (name), defaulting to
1.233 schwarze 1307: .Dq UNTITLED
1.111 kristaps 1308: if unspecified.
1.233 schwarze 1309: To achieve a uniform appearance of page header lines,
1310: it should by convention be all caps.
1.141 kristaps 1311: .It Ar section
1.100 kristaps 1312: The manual section.
1313: This may be one of
1.225 schwarze 1314: .Cm 1
1.66 kristaps 1315: .Pq utilities ,
1.225 schwarze 1316: .Cm 2
1.66 kristaps 1317: .Pq system calls ,
1.225 schwarze 1318: .Cm 3
1.66 kristaps 1319: .Pq libraries ,
1.225 schwarze 1320: .Cm 3p
1.66 kristaps 1321: .Pq Perl libraries ,
1.225 schwarze 1322: .Cm 4
1.66 kristaps 1323: .Pq devices ,
1.225 schwarze 1324: .Cm 5
1.66 kristaps 1325: .Pq file formats ,
1.225 schwarze 1326: .Cm 6
1.66 kristaps 1327: .Pq games ,
1.225 schwarze 1328: .Cm 7
1.66 kristaps 1329: .Pq miscellaneous ,
1.225 schwarze 1330: .Cm 8
1.66 kristaps 1331: .Pq system utilities ,
1.225 schwarze 1332: .Cm 9
1.66 kristaps 1333: .Pq kernel functions ,
1.225 schwarze 1334: .Cm X11
1.66 kristaps 1335: .Pq X Window System ,
1.225 schwarze 1336: .Cm X11R6
1.66 kristaps 1337: .Pq X Window System ,
1.225 schwarze 1338: .Cm unass
1.66 kristaps 1339: .Pq unassociated ,
1.225 schwarze 1340: .Cm local
1.66 kristaps 1341: .Pq local system ,
1.225 schwarze 1342: .Cm draft
1.66 kristaps 1343: .Pq draft manual ,
1344: or
1.225 schwarze 1345: .Cm paper
1.66 kristaps 1346: .Pq paper .
1.111 kristaps 1347: It should correspond to the manual's filename suffix and defaults to
1.233 schwarze 1348: the empty string if unspecified.
1.141 kristaps 1349: .It Ar volume
1.66 kristaps 1350: This overrides the volume inferred from
1351: .Ar section .
1352: This field is optional, and if specified, must be one of
1.225 schwarze 1353: .Cm USD
1.66 kristaps 1354: .Pq users' supplementary documents ,
1.225 schwarze 1355: .Cm PS1
1.66 kristaps 1356: .Pq programmers' supplementary documents ,
1.225 schwarze 1357: .Cm AMD
1.66 kristaps 1358: .Pq administrators' supplementary documents ,
1.225 schwarze 1359: .Cm SMM
1.66 kristaps 1360: .Pq system managers' manuals ,
1.225 schwarze 1361: .Cm URM
1.66 kristaps 1362: .Pq users' reference manuals ,
1.225 schwarze 1363: .Cm PRM
1.66 kristaps 1364: .Pq programmers' reference manuals ,
1.225 schwarze 1365: .Cm KM
1.66 kristaps 1366: .Pq kernel manuals ,
1.225 schwarze 1367: .Cm IND
1.66 kristaps 1368: .Pq master index ,
1.225 schwarze 1369: .Cm MMI
1.66 kristaps 1370: .Pq master index ,
1.225 schwarze 1371: .Cm LOCAL
1.66 kristaps 1372: .Pq local manuals ,
1.225 schwarze 1373: .Cm LOC
1.66 kristaps 1374: .Pq local manuals ,
1375: or
1.225 schwarze 1376: .Cm CON
1.66 kristaps 1377: .Pq contributed manuals .
1.141 kristaps 1378: .It Ar arch
1.213 schwarze 1379: This specifies the machine architecture a manual page applies to,
1380: where relevant, for example
1381: .Cm alpha ,
1382: .Cm amd64 ,
1383: .Cm i386 ,
1.66 kristaps 1384: or
1.213 schwarze 1385: .Cm sparc64 .
1386: The list of supported architectures varies by operating system.
1387: For the full list of all architectures recognized by
1388: .Xr mandoc 1 ,
1389: see the file
1390: .Pa arch.in
1391: in the source distribution.
1.66 kristaps 1392: .El
1393: .Pp
1394: Examples:
1.173 kristaps 1395: .Dl \&.Dt FOO 1
1396: .Dl \&.Dt FOO 4 KM
1397: .Dl \&.Dt FOO 9 i386
1.66 kristaps 1398: .Pp
1399: See also
1400: .Sx \&Dd
1401: and
1402: .Sx \&Os .
1.63 kristaps 1403: .Ss \&Dv
1.189 kristaps 1404: Defined variables such as preprocessor constants, constant symbols,
1405: enumeration values, and so on.
1.66 kristaps 1406: .Pp
1407: Examples:
1.189 kristaps 1408: .Dl \&.Dv NULL
1.173 kristaps 1409: .Dl \&.Dv BUFSIZ
1410: .Dl \&.Dv STDOUT_FILENO
1.66 kristaps 1411: .Pp
1412: See also
1.189 kristaps 1413: .Sx \&Er
1414: and
1415: .Sx \&Ev
1.222 schwarze 1416: for special-purpose constants,
1.189 kristaps 1417: .Sx \&Va
1.222 schwarze 1418: for variable symbols, and
1419: .Sx \&Fd
1420: for listing preprocessor variable definitions in the
1421: .Em SYNOPSIS .
1.63 kristaps 1422: .Ss \&Dx
1.220 schwarze 1423: Format the
1424: .Dx
1425: version provided as an argument, or a default
1.66 kristaps 1426: value if no argument is provided.
1427: .Pp
1428: Examples:
1.173 kristaps 1429: .Dl \&.Dx 2.4.1
1430: .Dl \&.Dx
1.66 kristaps 1431: .Pp
1432: See also
1433: .Sx \&At ,
1434: .Sx \&Bsx ,
1435: .Sx \&Bx ,
1436: .Sx \&Fx ,
1437: .Sx \&Nx ,
1438: and
1.230 schwarze 1439: .Sx \&Ox .
1.63 kristaps 1440: .Ss \&Ec
1.131 kristaps 1441: Close a scope started by
1442: .Sx \&Eo .
1443: Its syntax is as follows:
1444: .Pp
1.141 kristaps 1445: .D1 Pf \. Sx \&Ec Op Ar TERM
1.131 kristaps 1446: .Pp
1447: The
1.141 kristaps 1448: .Ar TERM
1.131 kristaps 1449: argument is used as the enclosure tail, for example, specifying \e(rq
1450: will emulate
1451: .Sx \&Dc .
1.63 kristaps 1452: .Ss \&Ed
1.131 kristaps 1453: End a display context started by
1454: .Sx \&Bd .
1.63 kristaps 1455: .Ss \&Ef
1.141 kristaps 1456: End a font mode context started by
1.129 kristaps 1457: .Sx \&Bf .
1.63 kristaps 1458: .Ss \&Ek
1.141 kristaps 1459: End a keep context started by
1.127 schwarze 1460: .Sx \&Bk .
1.63 kristaps 1461: .Ss \&El
1.141 kristaps 1462: End a list context started by
1.117 kristaps 1463: .Sx \&Bl .
1464: .Pp
1465: See also
1466: .Sx \&Bl
1467: and
1468: .Sx \&It .
1.63 kristaps 1469: .Ss \&Em
1.235 ! schwarze 1470: Request an italic font.
! 1471: If the output device does not provide that, underline.
! 1472: .Pp
! 1473: This is most often used for stress emphasis (not to be confused with
! 1474: importance, see
! 1475: .Sx \&Sy ) .
! 1476: In the rare cases where none of the semantic markup macros fit,
! 1477: it can also be used for technical terms and placeholders, except
! 1478: that for syntax elements,
! 1479: .Sx \&Sy
! 1480: and
! 1481: .Sx \&Ar
! 1482: are preferred, respectively.
1.66 kristaps 1483: .Pp
1484: Examples:
1.235 ! schwarze 1485: .Bd -literal -compact -offset indent
! 1486: Selected lines are those
! 1487: \&.Em not
! 1488: matching any of the specified patterns.
! 1489: Some of the functions use a
! 1490: \&.Em hold space
! 1491: to save the pattern space for subsequent retrieval.
! 1492: .Ed
1.138 kristaps 1493: .Pp
1494: See also
1495: .Sx \&Bf ,
1.198 schwarze 1496: .Sx \&Li ,
1497: .Sx \&No ,
1.138 kristaps 1498: and
1.198 schwarze 1499: .Sx \&Sy .
1.63 kristaps 1500: .Ss \&En
1.231 schwarze 1501: This macro is obsolete.
1502: Use
1503: .Sx \&Eo
1504: or any of the other enclosure macros.
1505: .Pp
1506: It encloses its argument in the delimiters specified by the last
1507: .Sx \&Es
1508: macro.
1.63 kristaps 1509: .Ss \&Eo
1.131 kristaps 1510: An arbitrary enclosure.
1511: Its syntax is as follows:
1512: .Pp
1.141 kristaps 1513: .D1 Pf \. Sx \&Eo Op Ar TERM
1.131 kristaps 1514: .Pp
1515: The
1.141 kristaps 1516: .Ar TERM
1.131 kristaps 1517: argument is used as the enclosure head, for example, specifying \e(lq
1518: will emulate
1519: .Sx \&Do .
1.63 kristaps 1520: .Ss \&Er
1.189 kristaps 1521: Error constants for definitions of the
1522: .Va errno
1523: libc global variable.
1.196 schwarze 1524: This is most often used in section 2 and 3 manual pages.
1.66 kristaps 1525: .Pp
1526: Examples:
1.173 kristaps 1527: .Dl \&.Er EPERM
1528: .Dl \&.Er ENOENT
1.66 kristaps 1529: .Pp
1530: See also
1.189 kristaps 1531: .Sx \&Dv
1532: for general constants.
1.63 kristaps 1533: .Ss \&Es
1.231 schwarze 1534: This macro is obsolete.
1535: Use
1536: .Sx \&Eo
1537: or any of the other enclosure macros.
1538: .Pp
1539: It takes two arguments, defining the delimiters to be used by subsequent
1540: .Sx \&En
1541: macros.
1.63 kristaps 1542: .Ss \&Ev
1.66 kristaps 1543: Environmental variables such as those specified in
1544: .Xr environ 7 .
1545: .Pp
1546: Examples:
1.173 kristaps 1547: .Dl \&.Ev DISPLAY
1548: .Dl \&.Ev PATH
1.189 kristaps 1549: .Pp
1550: See also
1551: .Sx \&Dv
1552: for general constants.
1.63 kristaps 1553: .Ss \&Ex
1.191 kristaps 1554: Insert a standard sentence regarding command exit values of 0 on success
1555: and >0 on failure.
1.196 schwarze 1556: This is most often used in section 1, 6, and 8 manual pages.
1.141 kristaps 1557: Its syntax is as follows:
1558: .Pp
1.193 schwarze 1559: .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...
1.141 kristaps 1560: .Pp
1.191 kristaps 1561: If
1.66 kristaps 1562: .Ar utility
1.141 kristaps 1563: is not specified, the document's name set by
1.66 kristaps 1564: .Sx \&Nm
1.141 kristaps 1565: is used.
1.191 kristaps 1566: Multiple
1567: .Ar utility
1568: arguments are treated as separate utilities.
1.139 kristaps 1569: .Pp
1570: See also
1571: .Sx \&Rv .
1.63 kristaps 1572: .Ss \&Fa
1.117 kristaps 1573: Function argument.
1.120 kristaps 1574: Its syntax is as follows:
1575: .Bd -ragged -offset indent
1576: .Pf \. Sx \&Fa
1.232 schwarze 1577: .Qo
1578: .Op Ar argtype
1579: .Op Ar argname
1580: .Qc Ar \&...
1.120 kristaps 1581: .Ed
1582: .Pp
1.232 schwarze 1583: Each argument may be a name and a type (recommended for the
1584: .Em SYNOPSIS
1585: section), a name alone (for function invocations),
1586: or a type alone (for function prototypes).
1587: If both a type and a name are given or if the type consists of multiple
1588: words, all words belonging to the same function argument have to be
1589: given in a single argument to the
1590: .Sx \&Fa
1591: macro.
1592: .Pp
1593: This macro is also used to specify the field name of a structure.
1594: .Pp
1.117 kristaps 1595: Most often, the
1596: .Sx \&Fa
1597: macro is used in the
1598: .Em SYNOPSIS
1.120 kristaps 1599: within
1600: .Sx \&Fo
1.232 schwarze 1601: blocks when documenting multi-line function prototypes.
1.117 kristaps 1602: If invoked with multiple arguments, the arguments are separated by a
1603: comma.
1604: Furthermore, if the following macro is another
1605: .Sx \&Fa ,
1606: the last argument will also have a trailing comma.
1607: .Pp
1608: Examples:
1.173 kristaps 1609: .Dl \&.Fa \(dqconst char *p\(dq
1610: .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
1.232 schwarze 1611: .Dl \&.Fa \(dqchar *\(dq size_t
1.120 kristaps 1612: .Pp
1613: See also
1614: .Sx \&Fo .
1.63 kristaps 1615: .Ss \&Fc
1.141 kristaps 1616: End a function context started by
1.131 kristaps 1617: .Sx \&Fo .
1.63 kristaps 1618: .Ss \&Fd
1.222 schwarze 1619: Preprocessor directive, in particular for listing it in the
1620: .Em SYNOPSIS .
1621: Historically, it was also used to document include files.
1622: The latter usage has been deprecated in favour of
1.117 kristaps 1623: .Sx \&In .
1.222 schwarze 1624: .Pp
1625: Its syntax is as follows:
1626: .Bd -ragged -offset indent
1627: .Pf \. Sx \&Fd
1628: .Li # Ns Ar directive
1629: .Op Ar argument ...
1630: .Ed
1631: .Pp
1632: Examples:
1633: .Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler
1634: .Dl \&.Fd #define SIO_MAXNFDS
1635: .Dl \&.Fd #ifdef FS_DEBUG
1636: .Dl \&.Ft void
1637: .Dl \&.Fn dbg_open \(dqconst char *\(dq
1638: .Dl \&.Fd #endif
1.117 kristaps 1639: .Pp
1640: See also
1.222 schwarze 1641: .Sx MANUAL STRUCTURE ,
1642: .Sx \&In ,
1.122 kristaps 1643: and
1.222 schwarze 1644: .Sx \&Dv .
1.63 kristaps 1645: .Ss \&Fl
1.196 schwarze 1646: Command-line flag or option.
1.100 kristaps 1647: Used when listing arguments to command-line utilities.
1648: Prints a fixed-width hyphen
1.79 kristaps 1649: .Sq \-
1.100 kristaps 1650: directly followed by each argument.
1651: If no arguments are provided, a hyphen is printed followed by a space.
1652: If the argument is a macro, a hyphen is prefixed to the subsequent macro
1653: output.
1.79 kristaps 1654: .Pp
1655: Examples:
1.199 schwarze 1656: .Dl ".Fl R Op Fl H | L | P"
1657: .Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux"
1658: .Dl ".Fl type Cm d Fl name Pa CVS"
1659: .Dl ".Fl Ar signal_number"
1660: .Dl ".Fl o Fl"
1.79 kristaps 1661: .Pp
1662: See also
1663: .Sx \&Cm .
1.63 kristaps 1664: .Ss \&Fn
1.119 kristaps 1665: A function name.
1.120 kristaps 1666: Its syntax is as follows:
1.119 kristaps 1667: .Bd -ragged -offset indent
1668: .Pf \. Ns Sx \&Fn
1.185 kristaps 1669: .Op Ar functype
1670: .Ar funcname
1671: .Op Oo Ar argtype Oc Ar argname
1.119 kristaps 1672: .Ed
1.120 kristaps 1673: .Pp
1.122 kristaps 1674: Function arguments are surrounded in parenthesis and
1.119 kristaps 1675: are delimited by commas.
1676: If no arguments are specified, blank parenthesis are output.
1.196 schwarze 1677: In the
1678: .Em SYNOPSIS
1679: section, this macro starts a new output line,
1680: and a blank line is automatically inserted between function definitions.
1.119 kristaps 1681: .Pp
1682: Examples:
1.203 kristaps 1683: .Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq
1684: .Dl \&.Fn funcname \(dqint arg0\(dq
1.173 kristaps 1685: .Dl \&.Fn funcname arg0
1.196 schwarze 1686: .Pp
1.120 kristaps 1687: .Bd -literal -offset indent -compact
1688: \&.Ft functype
1689: \&.Fn funcname
1690: .Ed
1.119 kristaps 1691: .Pp
1.163 schwarze 1692: When referring to a function documented in another manual page, use
1.162 schwarze 1693: .Sx \&Xr
1.163 schwarze 1694: instead.
1.119 kristaps 1695: See also
1.196 schwarze 1696: .Sx MANUAL STRUCTURE ,
1697: .Sx \&Fo ,
1.119 kristaps 1698: and
1699: .Sx \&Ft .
1.63 kristaps 1700: .Ss \&Fo
1.120 kristaps 1701: Begin a function block.
1702: This is a multi-line version of
1703: .Sx \&Fn .
1704: Its syntax is as follows:
1705: .Pp
1.185 kristaps 1706: .D1 Pf \. Sx \&Fo Ar funcname
1.120 kristaps 1707: .Pp
1708: Invocations usually occur in the following context:
1709: .Bd -ragged -offset indent
1.185 kristaps 1710: .Pf \. Sx \&Ft Ar functype
1.120 kristaps 1711: .br
1.185 kristaps 1712: .Pf \. Sx \&Fo Ar funcname
1.120 kristaps 1713: .br
1.232 schwarze 1714: .Pf \. Sx \&Fa Qq Ar argtype Ar argname
1.120 kristaps 1715: .br
1.183 kristaps 1716: \&.\.\.
1.120 kristaps 1717: .br
1718: .Pf \. Sx \&Fc
1719: .Ed
1720: .Pp
1721: A
1722: .Sx \&Fo
1723: scope is closed by
1.196 schwarze 1724: .Sx \&Fc .
1.120 kristaps 1725: .Pp
1726: See also
1.122 kristaps 1727: .Sx MANUAL STRUCTURE ,
1.120 kristaps 1728: .Sx \&Fa ,
1729: .Sx \&Fc ,
1730: and
1.139 kristaps 1731: .Sx \&Ft .
1.190 schwarze 1732: .Ss \&Fr
1.231 schwarze 1733: This macro is obsolete.
1734: No replacement markup is needed.
1.198 schwarze 1735: .Pp
1.231 schwarze 1736: It was used to show numerical function return values in an italic font.
1.63 kristaps 1737: .Ss \&Ft
1.120 kristaps 1738: A function type.
1739: Its syntax is as follows:
1740: .Pp
1.185 kristaps 1741: .D1 Pf \. Sx \&Ft Ar functype
1.120 kristaps 1742: .Pp
1.196 schwarze 1743: In the
1744: .Em SYNOPSIS
1745: section, a new output line is started after this macro.
1746: .Pp
1.120 kristaps 1747: Examples:
1.173 kristaps 1748: .Dl \&.Ft int
1.120 kristaps 1749: .Bd -literal -offset indent -compact
1750: \&.Ft functype
1751: \&.Fn funcname
1752: .Ed
1753: .Pp
1754: See also
1.122 kristaps 1755: .Sx MANUAL STRUCTURE ,
1756: .Sx \&Fn ,
1.120 kristaps 1757: and
1.122 kristaps 1758: .Sx \&Fo .
1.63 kristaps 1759: .Ss \&Fx
1.144 schwarze 1760: Format the
1761: .Fx
1762: version provided as an argument, or a default value
1.65 kristaps 1763: if no argument is provided.
1764: .Pp
1765: Examples:
1.173 kristaps 1766: .Dl \&.Fx 7.1
1767: .Dl \&.Fx
1.65 kristaps 1768: .Pp
1769: See also
1770: .Sx \&At ,
1.66 kristaps 1771: .Sx \&Bsx ,
1.65 kristaps 1772: .Sx \&Bx ,
1.66 kristaps 1773: .Sx \&Dx ,
1.65 kristaps 1774: .Sx \&Nx ,
1775: and
1.230 schwarze 1776: .Sx \&Ox .
1.63 kristaps 1777: .Ss \&Hf
1.198 schwarze 1778: This macro is not implemented in
1779: .Xr mandoc 1 .
1780: .Pp
1781: It was used to include the contents of a (header) file literally.
1782: The syntax was:
1783: .Pp
1784: .Dl Pf . Sx \&Hf Ar filename
1.63 kristaps 1785: .Ss \&Ic
1.132 kristaps 1786: Designate an internal or interactive command.
1787: This is similar to
1788: .Sx \&Cm
1789: but used for instructions rather than values.
1790: .Pp
1791: Examples:
1.196 schwarze 1792: .Dl \&.Ic :wq
1.173 kristaps 1793: .Dl \&.Ic hash
1794: .Dl \&.Ic alias
1.132 kristaps 1795: .Pp
1796: Note that using
1.144 schwarze 1797: .Sx \&Bd Fl literal
1.132 kristaps 1798: or
1799: .Sx \&D1
1800: is preferred for displaying code; the
1801: .Sx \&Ic
1802: macro is used when referring to specific instructions.
1.63 kristaps 1803: .Ss \&In
1.118 kristaps 1804: An
1.138 kristaps 1805: .Dq include
1.118 kristaps 1806: file.
1.196 schwarze 1807: When invoked as the first macro on an input line in the
1.118 kristaps 1808: .Em SYNOPSIS
1.196 schwarze 1809: section, the argument is displayed in angle brackets
1810: and preceded by
1.138 kristaps 1811: .Dq #include ,
1.196 schwarze 1812: and a blank line is inserted in front if there is a preceding
1813: function declaration.
1814: This is most often used in section 2, 3, and 9 manual pages.
1.118 kristaps 1815: .Pp
1.122 kristaps 1816: Examples:
1.196 schwarze 1817: .Dl \&.In sys/types.h
1.122 kristaps 1818: .Pp
1819: See also
1820: .Sx MANUAL STRUCTURE .
1.63 kristaps 1821: .Ss \&It
1.120 kristaps 1822: A list item.
1823: The syntax of this macro depends on the list type.
1.114 kristaps 1824: .Pp
1825: Lists
1826: of type
1827: .Fl hang ,
1828: .Fl ohang ,
1829: .Fl inset ,
1830: and
1831: .Fl diag
1.120 kristaps 1832: have the following syntax:
1.114 kristaps 1833: .Pp
1.185 kristaps 1834: .D1 Pf \. Sx \&It Ar args
1.114 kristaps 1835: .Pp
1836: Lists of type
1837: .Fl bullet ,
1838: .Fl dash ,
1839: .Fl enum ,
1840: .Fl hyphen
1841: and
1842: .Fl item
1.120 kristaps 1843: have the following syntax:
1.114 kristaps 1844: .Pp
1.120 kristaps 1845: .D1 Pf \. Sx \&It
1.114 kristaps 1846: .Pp
1847: with subsequent lines interpreted within the scope of the
1848: .Sx \&It
1849: until either a closing
1850: .Sx \&El
1851: or another
1852: .Sx \&It .
1853: .Pp
1854: The
1855: .Fl tag
1.120 kristaps 1856: list has the following syntax:
1.114 kristaps 1857: .Pp
1.120 kristaps 1858: .D1 Pf \. Sx \&It Op Cm args
1.114 kristaps 1859: .Pp
1.120 kristaps 1860: Subsequent lines are interpreted as with
1.114 kristaps 1861: .Fl bullet
1862: and family.
1863: The line arguments correspond to the list's left-hand side; body
1864: arguments correspond to the list's contents.
1865: .Pp
1866: The
1867: .Fl column
1868: list is the most complicated.
1.120 kristaps 1869: Its syntax is as follows:
1.114 kristaps 1870: .Pp
1.190 schwarze 1871: .D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...
1872: .D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...
1.114 kristaps 1873: .Pp
1.190 schwarze 1874: The arguments consist of one or more lines of text and macros
1875: representing a complete table line.
1876: Cells within the line are delimited by tabs or by the special
1877: .Sx \&Ta
1878: block macro.
1879: The tab cell delimiter may only be used within the
1.114 kristaps 1880: .Sx \&It
1.190 schwarze 1881: line itself; on following lines, only the
1882: .Sx \&Ta
1883: macro can be used to delimit cells, and
1884: .Sx \&Ta
1.208 kristaps 1885: is only recognised as a macro when called by other macros,
1.190 schwarze 1886: not as the first macro on a line.
1887: .Pp
1888: Note that quoted strings may span tab-delimited cells on an
1.114 kristaps 1889: .Sx \&It
1.190 schwarze 1890: line.
1891: For example,
1.114 kristaps 1892: .Pp
1.173 kristaps 1893: .Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
1.114 kristaps 1894: .Pp
1895: will preserve the semicolon whitespace except for the last.
1896: .Pp
1897: See also
1898: .Sx \&Bl .
1.63 kristaps 1899: .Ss \&Lb
1.109 kristaps 1900: Specify a library.
1.120 kristaps 1901: The syntax is as follows:
1.109 kristaps 1902: .Pp
1.185 kristaps 1903: .D1 Pf \. Sx \&Lb Ar library
1.109 kristaps 1904: .Pp
1905: The
1.185 kristaps 1906: .Ar library
1.109 kristaps 1907: parameter may be a system library, such as
1.193 schwarze 1908: .Cm libz
1.109 kristaps 1909: or
1.193 schwarze 1910: .Cm libpam ,
1.109 kristaps 1911: in which case a small library description is printed next to the linker
1912: invocation; or a custom library, in which case the library name is
1913: printed in quotes.
1914: This is most commonly used in the
1915: .Em SYNOPSIS
1916: section as described in
1917: .Sx MANUAL STRUCTURE .
1918: .Pp
1919: Examples:
1.173 kristaps 1920: .Dl \&.Lb libz
1.221 schwarze 1921: .Dl \&.Lb libmandoc
1.63 kristaps 1922: .Ss \&Li
1.198 schwarze 1923: Denotes text that should be in a
1924: .Li literal
1925: font mode.
1.131 kristaps 1926: Note that this is a presentation term and should not be used for
1927: stylistically decorating technical terms.
1.138 kristaps 1928: .Pp
1.198 schwarze 1929: On terminal output devices, this is often indistinguishable from
1930: normal text.
1931: .Pp
1.138 kristaps 1932: See also
1933: .Sx \&Bf ,
1.198 schwarze 1934: .Sx \&Em ,
1935: .Sx \&No ,
1.138 kristaps 1936: and
1.198 schwarze 1937: .Sx \&Sy .
1.63 kristaps 1938: .Ss \&Lk
1.100 kristaps 1939: Format a hyperlink.
1.120 kristaps 1940: Its syntax is as follows:
1.70 kristaps 1941: .Pp
1.185 kristaps 1942: .D1 Pf \. Sx \&Lk Ar uri Op Ar name
1.70 kristaps 1943: .Pp
1944: Examples:
1.203 kristaps 1945: .Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq
1.173 kristaps 1946: .Dl \&.Lk http://bsd.lv
1.70 kristaps 1947: .Pp
1948: See also
1949: .Sx \&Mt .
1.63 kristaps 1950: .Ss \&Lp
1.132 kristaps 1951: Synonym for
1952: .Sx \&Pp .
1.63 kristaps 1953: .Ss \&Ms
1.138 kristaps 1954: Display a mathematical symbol.
1.140 kristaps 1955: Its syntax is as follows:
1956: .Pp
1.185 kristaps 1957: .D1 Pf \. Sx \&Ms Ar symbol
1.138 kristaps 1958: .Pp
1959: Examples:
1.173 kristaps 1960: .Dl \&.Ms sigma
1961: .Dl \&.Ms aleph
1.63 kristaps 1962: .Ss \&Mt
1.116 kristaps 1963: Format a
1.138 kristaps 1964: .Dq mailto:
1.116 kristaps 1965: hyperlink.
1.120 kristaps 1966: Its syntax is as follows:
1.116 kristaps 1967: .Pp
1.185 kristaps 1968: .D1 Pf \. Sx \&Mt Ar address
1.116 kristaps 1969: .Pp
1970: Examples:
1.173 kristaps 1971: .Dl \&.Mt discuss@manpages.bsd.lv
1.219 schwarze 1972: .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
1.63 kristaps 1973: .Ss \&Nd
1.144 schwarze 1974: A one line description of the manual's content.
1.132 kristaps 1975: This may only be invoked in the
1976: .Em SYNOPSIS
1977: section subsequent the
1978: .Sx \&Nm
1979: macro.
1980: .Pp
1981: Examples:
1.198 schwarze 1982: .Dl Pf . Sx \&Nd mdoc language reference
1983: .Dl Pf . Sx \&Nd format and display UNIX manuals
1.132 kristaps 1984: .Pp
1985: The
1986: .Sx \&Nd
1987: macro technically accepts child macros and terminates with a subsequent
1988: .Sx \&Sh
1989: invocation.
1990: Do not assume this behaviour: some
1991: .Xr whatis 1
1992: database generators are not smart enough to parse more than the line
1993: arguments and will display macros verbatim.
1994: .Pp
1995: See also
1996: .Sx \&Nm .
1.63 kristaps 1997: .Ss \&Nm
1.128 schwarze 1998: The name of the manual page, or \(em in particular in section 1, 6,
1999: and 8 pages \(em of an additional command or feature documented in
2000: the manual page.
2001: When first invoked, the
2002: .Sx \&Nm
2003: macro expects a single argument, the name of the manual page.
2004: Usually, the first invocation happens in the
2005: .Em NAME
2006: section of the page.
2007: The specified name will be remembered and used whenever the macro is
2008: called again without arguments later in the page.
2009: The
2010: .Sx \&Nm
2011: macro uses
2012: .Sx Block full-implicit
2013: semantics when invoked as the first macro on an input line in the
2014: .Em SYNOPSIS
2015: section; otherwise, it uses ordinary
2016: .Sx In-line
2017: semantics.
2018: .Pp
2019: Examples:
2020: .Bd -literal -offset indent
2021: \&.Sh SYNOPSIS
2022: \&.Nm cat
2023: \&.Op Fl benstuv
2024: \&.Op Ar
2025: .Ed
2026: .Pp
2027: In the
2028: .Em SYNOPSIS
2029: of section 2, 3 and 9 manual pages, use the
2030: .Sx \&Fn
2031: macro rather than
2032: .Sx \&Nm
2033: to mark up the name of the manual page.
1.63 kristaps 2034: .Ss \&No
1.198 schwarze 2035: Normal text.
2036: Closes the scope of any preceding in-line macro.
2037: When used after physical formatting macros like
2038: .Sx \&Em
2039: or
2040: .Sx \&Sy ,
2041: switches back to the standard font face and weight.
2042: Can also be used to embed plain text strings in macro lines
2043: using semantic annotation macros.
1.132 kristaps 2044: .Pp
2045: Examples:
1.198 schwarze 2046: .Dl ".Em italic , Sy bold , No and roman"
2047: .Pp
2048: .Bd -literal -offset indent -compact
2049: \&.Sm off
2050: \&.Cm :C No / Ar pattern No / Ar replacement No /
2051: \&.Sm on
2052: .Ed
2053: .Pp
2054: See also
2055: .Sx \&Em ,
2056: .Sx \&Li ,
2057: and
2058: .Sx \&Sy .
1.63 kristaps 2059: .Ss \&Ns
1.198 schwarze 2060: Suppress a space between the output of the preceding macro
2061: and the following text or macro.
2062: Following invocation, input is interpreted as normal text
2063: just like after an
2064: .Sx \&No
2065: macro.
1.178 kristaps 2066: .Pp
2067: This has no effect when invoked at the start of a macro line.
1.138 kristaps 2068: .Pp
2069: Examples:
1.198 schwarze 2070: .Dl ".Ar name Ns = Ns Ar value"
2071: .Dl ".Cm :M Ns Ar pattern"
2072: .Dl ".Fl o Ns Ar output"
1.138 kristaps 2073: .Pp
2074: See also
2075: .Sx \&No
2076: and
2077: .Sx \&Sm .
1.63 kristaps 2078: .Ss \&Nx
1.144 schwarze 2079: Format the
2080: .Nx
2081: version provided as an argument, or a default value if
1.65 kristaps 2082: no argument is provided.
2083: .Pp
2084: Examples:
1.173 kristaps 2085: .Dl \&.Nx 5.01
2086: .Dl \&.Nx
1.65 kristaps 2087: .Pp
2088: See also
2089: .Sx \&At ,
1.66 kristaps 2090: .Sx \&Bsx ,
1.65 kristaps 2091: .Sx \&Bx ,
1.66 kristaps 2092: .Sx \&Dx ,
1.65 kristaps 2093: .Sx \&Fx ,
2094: and
1.230 schwarze 2095: .Sx \&Ox .
1.63 kristaps 2096: .Ss \&Oc
1.141 kristaps 2097: Close multi-line
1.132 kristaps 2098: .Sx \&Oo
2099: context.
1.63 kristaps 2100: .Ss \&Oo
1.132 kristaps 2101: Multi-line version of
2102: .Sx \&Op .
2103: .Pp
2104: Examples:
1.138 kristaps 2105: .Bd -literal -offset indent -compact
1.132 kristaps 2106: \&.Oo
2107: \&.Op Fl flag Ns Ar value
2108: \&.Oc
2109: .Ed
1.63 kristaps 2110: .Ss \&Op
1.196 schwarze 2111: Optional part of a command line.
1.132 kristaps 2112: Prints the argument(s) in brackets.
1.196 schwarze 2113: This is most often used in the
2114: .Em SYNOPSIS
2115: section of section 1 and 8 manual pages.
1.132 kristaps 2116: .Pp
2117: Examples:
1.173 kristaps 2118: .Dl \&.Op \&Fl a \&Ar b
2119: .Dl \&.Op \&Ar a | b
1.132 kristaps 2120: .Pp
2121: See also
2122: .Sx \&Oo .
1.63 kristaps 2123: .Ss \&Os
1.233 schwarze 2124: Operating system version for display in the page footer.
1.100 kristaps 2125: This is the mandatory third macro of
1.66 kristaps 2126: any
2127: .Nm
1.120 kristaps 2128: file.
2129: Its syntax is as follows:
1.66 kristaps 2130: .Pp
1.185 kristaps 2131: .D1 Pf \. Sx \&Os Op Ar system Op Ar version
1.66 kristaps 2132: .Pp
2133: The optional
1.185 kristaps 2134: .Ar system
1.100 kristaps 2135: parameter specifies the relevant operating system or environment.
2136: Left unspecified, it defaults to the local operating system version.
2137: This is the suggested form.
1.66 kristaps 2138: .Pp
2139: Examples:
1.173 kristaps 2140: .Dl \&.Os
2141: .Dl \&.Os KTH/CSC/TCS
2142: .Dl \&.Os BSD 4.3
1.66 kristaps 2143: .Pp
2144: See also
2145: .Sx \&Dd
2146: and
2147: .Sx \&Dt .
1.63 kristaps 2148: .Ss \&Ot
1.231 schwarze 2149: This macro is obsolete.
2150: Use
2151: .Sx \&Ft
2152: instead; with
2153: .Xr mandoc 1 ,
2154: both have the same effect.
1.66 kristaps 2155: .Pp
1.198 schwarze 2156: Historical
1.217 schwarze 2157: .Nm
1.198 schwarze 2158: packages described it as
2159: .Dq "old function type (FORTRAN)" .
1.63 kristaps 2160: .Ss \&Ox
1.144 schwarze 2161: Format the
2162: .Ox
2163: version provided as an argument, or a default value
1.65 kristaps 2164: if no argument is provided.
2165: .Pp
2166: Examples:
1.173 kristaps 2167: .Dl \&.Ox 4.5
2168: .Dl \&.Ox
1.65 kristaps 2169: .Pp
2170: See also
2171: .Sx \&At ,
2172: .Sx \&Bsx ,
2173: .Sx \&Bx ,
1.66 kristaps 2174: .Sx \&Dx ,
1.65 kristaps 2175: .Sx \&Fx ,
2176: and
1.230 schwarze 2177: .Sx \&Nx .
1.63 kristaps 2178: .Ss \&Pa
1.196 schwarze 2179: An absolute or relative file system path, or a file or directory name.
2180: If an argument is not provided, the character
2181: .Sq \(ti
1.165 kristaps 2182: is used as a default.
1.132 kristaps 2183: .Pp
2184: Examples:
1.173 kristaps 2185: .Dl \&.Pa /usr/bin/mandoc
2186: .Dl \&.Pa /usr/share/man/man7/mdoc.7
1.132 kristaps 2187: .Pp
2188: See also
2189: .Sx \&Lk .
1.63 kristaps 2190: .Ss \&Pc
1.132 kristaps 2191: Close parenthesised context opened by
2192: .Sx \&Po .
1.63 kristaps 2193: .Ss \&Pf
1.198 schwarze 2194: Removes the space between its argument
1.138 kristaps 2195: .Pq Dq prefix
1.198 schwarze 2196: and the following macro.
1.132 kristaps 2197: Its syntax is as follows:
2198: .Pp
1.198 schwarze 2199: .D1 .Pf Ar prefix macro arguments ...
2200: .Pp
2201: This is equivalent to:
1.132 kristaps 2202: .Pp
1.198 schwarze 2203: .D1 .No Ar prefix No \&Ns Ar macro arguments ...
1.132 kristaps 2204: .Pp
2205: Examples:
1.198 schwarze 2206: .Dl ".Pf $ Ar variable_name"
2207: .Dl ".Pf 0x Ar hex_digits"
2208: .Pp
2209: See also
2210: .Sx \&Ns
2211: and
2212: .Sx \&Sm .
1.63 kristaps 2213: .Ss \&Po
1.132 kristaps 2214: Multi-line version of
2215: .Sx \&Pq .
1.63 kristaps 2216: .Ss \&Pp
1.132 kristaps 2217: Break a paragraph.
2218: This will assert vertical space between prior and subsequent macros
2219: and/or text.
1.198 schwarze 2220: .Pp
2221: Paragraph breaks are not needed before or after
2222: .Sx \&Sh
2223: or
2224: .Sx \&Ss
2225: macros or before displays
2226: .Pq Sx \&Bd
2227: or lists
2228: .Pq Sx \&Bl
2229: unless the
2230: .Fl compact
2231: flag is given.
1.63 kristaps 2232: .Ss \&Pq
1.132 kristaps 2233: Parenthesised enclosure.
2234: .Pp
2235: See also
2236: .Sx \&Po .
1.63 kristaps 2237: .Ss \&Qc
1.138 kristaps 2238: Close quoted context opened by
2239: .Sx \&Qo .
1.63 kristaps 2240: .Ss \&Ql
1.138 kristaps 2241: Format a single-quoted literal.
2242: See also
2243: .Sx \&Qq
2244: and
2245: .Sx \&Sq .
1.63 kristaps 2246: .Ss \&Qo
1.138 kristaps 2247: Multi-line version of
2248: .Sx \&Qq .
1.63 kristaps 2249: .Ss \&Qq
1.138 kristaps 2250: Encloses its arguments in
1.198 schwarze 2251: .Qq typewriter
1.138 kristaps 2252: double-quotes.
2253: Consider using
2254: .Sx \&Dq .
2255: .Pp
2256: See also
2257: .Sx \&Dq ,
2258: .Sx \&Sq ,
2259: and
2260: .Sx \&Qo .
1.63 kristaps 2261: .Ss \&Re
1.141 kristaps 2262: Close an
1.63 kristaps 2263: .Sx \&Rs
1.100 kristaps 2264: block.
2265: Does not have any tail arguments.
1.63 kristaps 2266: .Ss \&Rs
1.141 kristaps 2267: Begin a bibliographic
1.63 kristaps 2268: .Pq Dq reference
1.100 kristaps 2269: block.
2270: Does not have any head arguments.
2271: The block macro may only contain
1.63 kristaps 2272: .Sx \&%A ,
2273: .Sx \&%B ,
2274: .Sx \&%C ,
2275: .Sx \&%D ,
2276: .Sx \&%I ,
2277: .Sx \&%J ,
2278: .Sx \&%N ,
2279: .Sx \&%O ,
2280: .Sx \&%P ,
2281: .Sx \&%Q ,
2282: .Sx \&%R ,
2283: .Sx \&%T ,
1.120 kristaps 2284: .Sx \&%U ,
1.63 kristaps 2285: and
2286: .Sx \&%V
2287: child macros (at least one must be specified).
2288: .Pp
1.64 kristaps 2289: Examples:
1.91 kristaps 2290: .Bd -literal -offset indent -compact
1.63 kristaps 2291: \&.Rs
2292: \&.%A J. E. Hopcroft
2293: \&.%A J. D. Ullman
2294: \&.%B Introduction to Automata Theory, Languages, and Computation
2295: \&.%I Addison-Wesley
2296: \&.%C Reading, Massachusettes
2297: \&.%D 1979
2298: \&.Re
2299: .Ed
2300: .Pp
2301: If an
2302: .Sx \&Rs
2303: block is used within a SEE ALSO section, a vertical space is asserted
2304: before the rendered output, else the block continues on the current
2305: line.
2306: .Ss \&Rv
1.193 schwarze 2307: Insert a standard sentence regarding a function call's return value of 0
1.191 kristaps 2308: on success and \-1 on error, with the
2309: .Va errno
2310: libc global variable set on error.
2311: Its syntax is as follows:
2312: .Pp
1.193 schwarze 2313: .D1 Pf \. Sx \&Rv Fl std Op Ar function ...
1.191 kristaps 2314: .Pp
1.139 kristaps 2315: If
2316: .Ar function
1.191 kristaps 2317: is not specified, the document's name set by
1.139 kristaps 2318: .Sx \&Nm
1.191 kristaps 2319: is used.
2320: Multiple
2321: .Ar function
2322: arguments are treated as separate functions.
1.139 kristaps 2323: .Pp
2324: See also
2325: .Sx \&Ex .
1.63 kristaps 2326: .Ss \&Sc
1.138 kristaps 2327: Close single-quoted context opened by
2328: .Sx \&So .
1.63 kristaps 2329: .Ss \&Sh
1.138 kristaps 2330: Begin a new section.
2331: For a list of conventional manual sections, see
2332: .Sx MANUAL STRUCTURE .
2333: These sections should be used unless it's absolutely necessary that
2334: custom sections be used.
2335: .Pp
2336: Section names should be unique so that they may be keyed by
2337: .Sx \&Sx .
1.197 kristaps 2338: Although this macro is parsed, it should not consist of child node or it
2339: may not be linked with
2340: .Sx \&Sx .
1.138 kristaps 2341: .Pp
2342: See also
2343: .Sx \&Pp ,
2344: .Sx \&Ss ,
2345: and
2346: .Sx \&Sx .
1.63 kristaps 2347: .Ss \&Sm
1.134 schwarze 2348: Switches the spacing mode for output generated from macros.
2349: Its syntax is as follows:
2350: .Pp
1.234 schwarze 2351: .D1 Pf \. Sx \&Sm Op Cm on | off
1.134 schwarze 2352: .Pp
2353: By default, spacing is
1.193 schwarze 2354: .Cm on .
1.134 schwarze 2355: When switched
1.193 schwarze 2356: .Cm off ,
1.134 schwarze 2357: no white space is inserted between macro arguments and between the
1.185 kristaps 2358: output generated from adjacent macros, but text lines
1.134 schwarze 2359: still get normal spacing between words and sentences.
1.234 schwarze 2360: .Pp
2361: When called without an argument, the
2362: .Sx \&Sm
2363: macro toggles the spacing mode.
2364: Using this is not recommended because it makes the code harder to read.
1.63 kristaps 2365: .Ss \&So
1.138 kristaps 2366: Multi-line version of
2367: .Sx \&Sq .
1.63 kristaps 2368: .Ss \&Sq
1.138 kristaps 2369: Encloses its arguments in
1.198 schwarze 2370: .Sq typewriter
1.138 kristaps 2371: single-quotes.
2372: .Pp
2373: See also
2374: .Sx \&Dq ,
2375: .Sx \&Qq ,
2376: and
2377: .Sx \&So .
1.63 kristaps 2378: .Ss \&Ss
1.198 schwarze 2379: Begin a new subsection.
1.138 kristaps 2380: Unlike with
2381: .Sx \&Sh ,
1.198 schwarze 2382: there is no convention for the naming of subsections.
2383: Except
2384: .Em DESCRIPTION ,
2385: the conventional sections described in
2386: .Sx MANUAL STRUCTURE
2387: rarely have subsections.
1.138 kristaps 2388: .Pp
2389: Sub-section names should be unique so that they may be keyed by
1.197 kristaps 2390: .Sx \&Sx .
2391: Although this macro is parsed, it should not consist of child node or it
2392: may not be linked with
1.138 kristaps 2393: .Sx \&Sx .
2394: .Pp
2395: See also
2396: .Sx \&Pp ,
2397: .Sx \&Sh ,
2398: and
2399: .Sx \&Sx .
1.63 kristaps 2400: .Ss \&St
1.139 kristaps 2401: Replace an abbreviation for a standard with the full form.
1.226 schwarze 2402: The following standards are recognised.
2403: Where multiple lines are given without a blank line in between,
2404: they all refer to the same standard, and using the first form
2405: is recommended.
2406: .Bl -tag -width 1n
2407: .It C language standards
1.139 kristaps 2408: .Pp
1.226 schwarze 2409: .Bl -tag -width "-p1003.1g-2000" -compact
2410: .It \-ansiC
2411: .St -ansiC
2412: .It \-ansiC-89
2413: .St -ansiC-89
1.139 kristaps 2414: .It \-isoC
2415: .St -isoC
2416: .It \-isoC-90
2417: .St -isoC-90
1.226 schwarze 2418: .br
2419: The original C standard.
2420: .Pp
1.139 kristaps 2421: .It \-isoC-amd1
2422: .St -isoC-amd1
1.226 schwarze 2423: .Pp
1.139 kristaps 2424: .It \-isoC-tcor1
2425: .St -isoC-tcor1
1.226 schwarze 2426: .Pp
1.211 schwarze 2427: .It \-isoC-tcor2
2428: .St -isoC-tcor2
1.226 schwarze 2429: .Pp
1.211 schwarze 2430: .It \-isoC-99
2431: .St -isoC-99
1.226 schwarze 2432: .It \-ansiC-99
2433: .St -ansiC-99
2434: .br
2435: The second major version of the C language standard.
2436: .Pp
1.214 kristaps 2437: .It \-isoC-2011
2438: .St -isoC-2011
1.226 schwarze 2439: .br
2440: The third major version of the C language standard.
2441: .El
2442: .It POSIX.1 before the Single UNIX Specification
2443: .Pp
2444: .Bl -tag -width "-p1003.1g-2000" -compact
2445: .It \-p1003.1-88
2446: .St -p1003.1-88
2447: .It \-p1003.1
2448: .St -p1003.1
2449: .br
2450: The original POSIX standard, based on ANSI C.
2451: .Pp
2452: .It \-p1003.1-90
2453: .St -p1003.1-90
1.211 schwarze 2454: .It \-iso9945-1-90
2455: .St -iso9945-1-90
1.226 schwarze 2456: .br
2457: The first update of POSIX.1.
2458: .Pp
2459: .It \-p1003.1b-93
2460: .St -p1003.1b-93
2461: .It \-p1003.1b
2462: .St -p1003.1b
2463: .br
2464: Real-time extensions.
2465: .Pp
2466: .It \-p1003.1c-95
2467: .St -p1003.1c-95
2468: .br
2469: POSIX thread interfaces.
2470: .Pp
2471: .It \-p1003.1i-95
2472: .St -p1003.1i-95
2473: .br
2474: Technical Corrigendum.
2475: .Pp
2476: .It \-p1003.1-96
2477: .St -p1003.1-96
1.211 schwarze 2478: .It \-iso9945-1-96
2479: .St -iso9945-1-96
1.226 schwarze 2480: .br
2481: Includes POSIX.1-1990, 1b, 1c, and 1i.
2482: .El
2483: .It X/Open Portability Guide version 4 and related standards
2484: .Pp
2485: .Bl -tag -width "-p1003.1g-2000" -compact
2486: .It \-xpg3
2487: .St -xpg3
2488: .br
2489: An XPG4 precursor, published in 1989.
2490: .Pp
2491: .It \-p1003.2
2492: .St -p1003.2
2493: .It \-p1003.2-92
2494: .St -p1003.2-92
1.211 schwarze 2495: .It \-iso9945-2-93
2496: .St -iso9945-2-93
1.226 schwarze 2497: .br
2498: An XCU4 precursor.
2499: .Pp
2500: .It \-p1003.2a-92
2501: .St -p1003.2a-92
2502: .br
2503: Updates to POSIX.2.
2504: .Pp
1.211 schwarze 2505: .It \-xpg4
2506: .St -xpg4
1.226 schwarze 2507: .br
2508: Based on POSIX.1 and POSIX.2, published in 1992.
2509: .El
2510: .It Single UNIX Specification version 1 and related standards
2511: .Pp
2512: .Bl -tag -width "-p1003.1g-2000" -compact
1.211 schwarze 2513: .It \-xpg4.2
2514: .St -xpg4.2
1.226 schwarze 2515: .br
2516: This standard was published in 1994 and is also called SUSv1.
2517: It was used as the basis for UNIX 95 certification.
2518: The following three refer to parts of it.
2519: .Pp
2520: .It \-xsh4.2
2521: .St -xsh4.2
2522: .Pp
2523: .It \-xcurses4.2
2524: .St -xcurses4.2
2525: .Pp
2526: .It \-p1003.1g-2000
2527: .St -p1003.1g-2000
2528: .br
2529: Networking APIs, including sockets.
2530: .Pp
1.211 schwarze 2531: .It \-xpg4.3
2532: .St -xpg4.3
1.226 schwarze 2533: .Pp
2534: .It \-svid4
2535: .St -svid4 ,
2536: .br
2537: Published in 1995.
2538: .El
2539: .It Single UNIX Specification version 2 and related standards
2540: .Pp
2541: .Bl -tag -width "-p1003.1g-2000" -compact
2542: .It \-susv2
2543: .St -susv2
2544: This Standard was published in 1997
2545: and is also called X/Open Portability Guide version 5.
2546: It was used as the basis for UNIX 98 certification.
2547: The following refer to parts of it.
2548: .Pp
1.211 schwarze 2549: .It \-xbd5
2550: .St -xbd5
1.226 schwarze 2551: .Pp
2552: .It \-xsh5
2553: .St -xsh5
2554: .Pp
1.211 schwarze 2555: .It \-xcu5
2556: .St -xcu5
1.226 schwarze 2557: .Pp
1.211 schwarze 2558: .It \-xns5
2559: .St -xns5
1.226 schwarze 2560: .It \-xns5.2d2.0
2561: .St -xns5.2d2.0
1.211 schwarze 2562: .It \-xns5.2
2563: .St -xns5.2
1.226 schwarze 2564: .Pp
2565: .It \-p1387.2
2566: .St -p1387.2
2567: .It \-p1387.2-95
2568: .St -p1387.2-95
2569: .br
2570: POSIX software administration.
2571: .El
2572: .It Single UNIX Specification version 3 and related standards
2573: .Pp
2574: .Bl -tag -width "-p1003.1g-2000X" -compact
2575: .It \-p1003.1d-99
2576: .St -p1003.1d-99
2577: .br
2578: Additional real-time extensions.
2579: .Pp
2580: .It \-p1003.1j-2000
2581: .St -p1003.1j-2000
2582: .br
2583: Advanced real-time extensions.
2584: .Pp
2585: .It \-p1003.1q-2000
2586: .St -p1003.1q-2000
2587: .br
2588: Amendment 7: Tracing [C Language].
2589: .Pp
2590: .It \-p1003.1-2001
2591: .St -p1003.1-2001
1.211 schwarze 2592: .It \-susv3
2593: .St -susv3
1.226 schwarze 2594: .br
2595: This standard is based on C99, SUSv2, POSIX.1-1996, 1d, and 1j.
2596: It is also called X/Open Portability Guide version 6.
2597: It is used as the basis for UNIX 03 certification.
2598: .Pp
2599: .It \-p1003.1-2004
2600: .St -p1003.1-2004
2601: .br
2602: The second and last Technical Corrigendum.
2603: .El
2604: .It Single UNIX Specification version 4
2605: .Pp
2606: .Bl -tag -width "-p1003.1g-2000" -compact
2607: .It \-p1003.1-2008
2608: .St -p1003.1-2008
2609: .br
2610: This standard is also called SUSv4 and
2611: X/Open Portability Guide version 7.
2612: .Pp
2613: .It \-p1003.1-2013
2614: .St -p1003.1-2013
2615: .br
2616: This is the first Technical Corrigendum.
2617: .El
2618: .It Other standards
2619: .Pp
2620: .Bl -tag -width "-p1003.1g-2000" -compact
2621: .It \-ieee754
2622: .St -ieee754
2623: .br
2624: Floating-point arithmetic.
2625: .Pp
2626: .It \-iso8601
2627: .St -iso8601
2628: .br
2629: Representation of dates and times, published in 1988.
2630: .Pp
2631: .It \-iso8802-3
2632: .St -iso8802-3
2633: .br
2634: Ethernet local area networks.
2635: .Pp
2636: .It \-ieee1275-94
2637: .St -ieee1275-94
2638: .El
1.211 schwarze 2639: .El
2640: .Ss \&Sx
2641: Reference a section or subsection in the same manual page.
2642: The referenced section or subsection name must be identical to the
2643: enclosed argument, including whitespace.
2644: .Pp
2645: Examples:
2646: .Dl \&.Sx MANUAL STRUCTURE
2647: .Pp
2648: See also
2649: .Sx \&Sh
2650: and
2651: .Sx \&Ss .
2652: .Ss \&Sy
1.235 ! schwarze 2653: Request a boldface font.
! 2654: .Pp
! 2655: This is most often used to indicate importance or seriousness (not to be
! 2656: confused with stress emphasis, see
! 2657: .Sx \&Em ) .
! 2658: When none of the semantic macros fit, it is also adequate for syntax
! 2659: elements that have to be given or that appear verbatim.
! 2660: .Pp
! 2661: Examples:
! 2662: .Bd -literal -compact -offset indent
! 2663: \&.Sy Warning :
! 2664: If
! 2665: \&.Sy s
! 2666: appears in the owner permissions, set-user-ID mode is set.
! 2667: This utility replaces the former
! 2668: \&.Sy dumpdir
! 2669: program.
! 2670: .Ed
1.211 schwarze 2671: .Pp
2672: See also
2673: .Sx \&Bf ,
2674: .Sx \&Em ,
2675: .Sx \&Li ,
2676: and
2677: .Sx \&No .
2678: .Ss \&Ta
2679: Table cell separator in
2680: .Sx \&Bl Fl column
2681: lists; can only be used below
2682: .Sx \&It .
2683: .Ss \&Tn
1.230 schwarze 2684: Supported only for compatibility, do not use this in new manuals.
2685: Even though the macro name
2686: .Pq Dq tradename
2687: suggests a semantic function, historic usage is inconsistent, mostly
2688: using it as a presentation-level macro to request a small caps font.
1.211 schwarze 2689: .Ss \&Ud
1.230 schwarze 2690: Supported only for compatibility, do not use this in new manuals.
1.211 schwarze 2691: Prints out
2692: .Dq currently under development.
2693: .Ss \&Ux
1.230 schwarze 2694: Supported only for compatibility, do not use this in new manuals.
2695: Prints out
2696: .Dq Ux .
1.211 schwarze 2697: .Ss \&Va
2698: A variable name.
2699: .Pp
2700: Examples:
2701: .Dl \&.Va foo
2702: .Dl \&.Va const char *bar ;
2703: .Ss \&Vt
2704: A variable type.
2705: This is also used for indicating global variables in the
2706: .Em SYNOPSIS
2707: section, in which case a variable name is also specified.
2708: Note that it accepts
2709: .Sx Block partial-implicit
2710: syntax when invoked as the first macro on an input line in the
2711: .Em SYNOPSIS
2712: section, else it accepts ordinary
2713: .Sx In-line
2714: syntax.
2715: In the former case, this macro starts a new output line,
2716: and a blank line is inserted in front if there is a preceding
2717: function definition or include directive.
2718: .Pp
2719: Note that this should not be confused with
2720: .Sx \&Ft ,
2721: which is used for function return types.
2722: .Pp
2723: Examples:
2724: .Dl \&.Vt unsigned char
2725: .Dl \&.Vt extern const char * const sys_signame[] \&;
2726: .Pp
2727: See also
2728: .Sx MANUAL STRUCTURE
2729: and
2730: .Sx \&Va .
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