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