Annotation of mandoc/mdoc.7, Revision 1.165
1.165 ! kristaps 1: .\" $Id: mdoc.7,v 1.164 2010/11/29 13:02:47 kristaps Exp $
1.1 kristaps 2: .\"
1.130 schwarze 3: .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
4: .\" Copyright (c) 2010 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.165 ! kristaps 18: .Dd $Mdocdate: November 29 2010 $
1.20 kristaps 19: .Dt MDOC 7
1.1 kristaps 20: .Os
21: .Sh NAME
1.57 kristaps 22: .Nm mdoc
23: .Nd mdoc language reference
1.1 kristaps 24: .Sh DESCRIPTION
25: The
1.57 kristaps 26: .Nm mdoc
1.50 kristaps 27: language is used to format
1.57 kristaps 28: .Bx
29: .Ux
1.138 kristaps 30: manuals.
1.144 schwarze 31: This reference document describes its syntax, structure, and
1.138 kristaps 32: usage.
1.144 schwarze 33: The reference implementation is
34: .Xr mandoc 1 ;
35: the
1.57 kristaps 36: .Sx COMPATIBILITY
1.93 kristaps 37: section describes compatibility with other troff \-mdoc implementations.
1.57 kristaps 38: .Pp
1.13 kristaps 39: An
1.57 kristaps 40: .Nm
1.118 kristaps 41: document follows simple rules: lines beginning with the control
1.50 kristaps 42: character
1.57 kristaps 43: .Sq \.
1.138 kristaps 44: are parsed for macros.
45: Other lines are interpreted within the scope of
1.13 kristaps 46: prior macros:
1.57 kristaps 47: .Bd -literal -offset indent
1.13 kristaps 48: \&.Sh Macro lines change control state.
49: Other lines are interpreted within the current state.
1.57 kristaps 50: .Ed
1.46 kristaps 51: .Sh LANGUAGE SYNTAX
1.57 kristaps 52: .Nm
1.13 kristaps 53: documents may contain only graphable 7-bit ASCII characters, the space
1.138 kristaps 54: character, and, in certain circumstances, the tab character.
55: All manuals must have
1.57 kristaps 56: .Ux
1.50 kristaps 57: line terminators.
1.57 kristaps 58: .Ss Comments
1.43 kristaps 59: Text following a
1.135 kristaps 60: .Sq \e\*q ,
1.43 kristaps 61: whether in a macro or free-form text line, is ignored to the end of
1.138 kristaps 62: line.
63: A macro line with only a control character and comment escape,
1.135 kristaps 64: .Sq \&.\e\*q ,
1.138 kristaps 65: is also ignored.
1.144 schwarze 66: Macro lines with only a control character and optional whitespace are
1.138 kristaps 67: stripped from input.
1.57 kristaps 68: .Ss Reserved Characters
1.2 kristaps 69: Within a macro line, the following characters are reserved:
1.61 kristaps 70: .Pp
1.57 kristaps 71: .Bl -tag -width Ds -offset indent -compact
72: .It \&.
73: .Pq period
74: .It \&,
75: .Pq comma
76: .It \&:
77: .Pq colon
78: .It \&;
79: .Pq semicolon
80: .It \&(
81: .Pq left-parenthesis
82: .It \&)
83: .Pq right-parenthesis
84: .It \&[
85: .Pq left-bracket
86: .It \&]
87: .Pq right-bracket
88: .It \&?
89: .Pq question
90: .It \&!
91: .Pq exclamation
92: .It \&|
93: .Pq vertical bar
94: .El
95: .Pp
1.5 kristaps 96: Use of reserved characters is described in
1.57 kristaps 97: .Sx MACRO SYNTAX .
1.141 kristaps 98: For general use in macro lines, these characters can either be escaped
1.43 kristaps 99: with a non-breaking space
1.57 kristaps 100: .Pq Sq \e&
1.141 kristaps 101: or, if applicable, an appropriate escape sequence can be used.
1.57 kristaps 102: .Ss Special Characters
1.43 kristaps 103: Special characters may occur in both macro and free-form lines.
104: Sequences begin with the escape character
1.57 kristaps 105: .Sq \e
1.50 kristaps 106: followed by either an open-parenthesis
1.57 kristaps 107: .Sq \&(
1.1 kristaps 108: for two-character sequences; an open-bracket
1.57 kristaps 109: .Sq \&[
1.1 kristaps 110: for n-character sequences (terminated at a close-bracket
1.57 kristaps 111: .Sq \&] ) ;
1.144 schwarze 112: or a single one character sequence.
1.100 kristaps 113: See
1.57 kristaps 114: .Xr mandoc_char 7
1.100 kristaps 115: for a complete list.
116: Examples include
1.57 kristaps 117: .Sq \e(em
118: .Pq em-dash
1.50 kristaps 119: and
1.57 kristaps 120: .Sq \ee
121: .Pq back-slash .
122: .Ss Text Decoration
1.54 kristaps 123: Terms may be text-decorated using the
1.57 kristaps 124: .Sq \ef
1.144 schwarze 125: escape followed by an indicator: B (bold), I (italic), R (Roman), or P
1.82 kristaps 126: (revert to previous mode):
1.75 kristaps 127: .Pp
1.76 kristaps 128: .D1 \efBbold\efR \efIitalic\efP
129: .Pp
130: A numerical representation 3, 2, or 1 (bold, italic, and Roman,
1.100 kristaps 131: respectively) may be used instead.
132: A text decoration is valid within
1.118 kristaps 133: the current font scope only: if a macro opens a font scope alongside
1.77 kristaps 134: its own scope, such as
1.78 kristaps 135: .Sx \&Bf
1.77 kristaps 136: .Cm \&Sy ,
137: in-scope invocations of
138: .Sq \ef
1.100 kristaps 139: are only valid within the font scope of the macro.
140: If
1.77 kristaps 141: .Sq \ef
142: is specified outside of any font scope, such as in unenclosed, free-form
143: text, it will affect the remainder of the document.
1.76 kristaps 144: .Pp
1.136 kristaps 145: Note this form is
1.76 kristaps 146: .Em not
1.82 kristaps 147: recommended for
1.57 kristaps 148: .Nm ,
1.74 kristaps 149: which encourages semantic annotation.
1.57 kristaps 150: .Ss Predefined Strings
1.82 kristaps 151: Historically,
1.145 kristaps 152: troff
1.82 kristaps 153: also defined a set of package-specific
1.57 kristaps 154: .Dq predefined strings ,
1.82 kristaps 155: which, like
1.57 kristaps 156: .Sx Special Characters ,
1.124 kristaps 157: mark special output characters and strings by way of input codes.
1.54 kristaps 158: Predefined strings are escaped with the slash-asterisk,
1.57 kristaps 159: .Sq \e* :
1.54 kristaps 160: single-character
1.57 kristaps 161: .Sq \e*X ,
1.54 kristaps 162: two-character
1.57 kristaps 163: .Sq \e*(XX ,
1.54 kristaps 164: and N-character
1.57 kristaps 165: .Sq \e*[N] .
1.54 kristaps 166: See
1.57 kristaps 167: .Xr mandoc_char 7
1.100 kristaps 168: for a complete list.
169: Examples include
1.57 kristaps 170: .Sq \e*(Am
171: .Pq ampersand
1.54 kristaps 172: and
1.57 kristaps 173: .Sq \e*(Ba
174: .Pq vertical bar .
175: .Ss Whitespace
1.98 kristaps 176: Whitespace consists of the space character.
1.144 schwarze 177: In free-form lines, whitespace is preserved within a line; unescaped
1.96 kristaps 178: trailing spaces are stripped from input (unless in a literal context).
1.97 kristaps 179: Blank free-form lines, which may include whitespace, are only permitted
1.96 kristaps 180: within literal contexts.
1.57 kristaps 181: .Pp
1.100 kristaps 182: In macro lines, whitespace delimits arguments and is discarded.
183: If arguments are quoted, whitespace within the quotes is retained.
1.57 kristaps 184: .Ss Quotation
1.141 kristaps 185: Macro arguments may be quoted with double-quotes to group
1.100 kristaps 186: space-delimited terms or to retain blocks of whitespace.
187: A quoted argument begins with a double-quote preceded by whitespace.
1.144 schwarze 188: The next double-quote not pairwise adjacent to another double-quote
1.100 kristaps 189: terminates the literal, regardless of surrounding whitespace.
1.57 kristaps 190: .Pp
1.141 kristaps 191: Note that any quoted text, even if it would cause a macro invocation
192: when unquoted, is considered literal text.
1.100 kristaps 193: Thus, the following produces
1.141 kristaps 194: .Sq Op "Fl a" :
1.57 kristaps 195: .Bd -literal -offset indent
1.141 kristaps 196: \&.Op "Fl a"
1.57 kristaps 197: .Ed
198: .Pp
1.46 kristaps 199: In free-form mode, quotes are regarded as opaque text.
1.63 kristaps 200: .Ss Dates
1.66 kristaps 201: There are several macros in
202: .Nm
1.100 kristaps 203: that require a date argument.
204: The canonical form for dates is the American format:
1.66 kristaps 205: .Pp
206: .D1 Cm Month Day , Year
207: .Pp
208: The
209: .Cm Day
1.100 kristaps 210: value is an optionally zero-padded numeral.
211: The
1.66 kristaps 212: .Cm Month
1.100 kristaps 213: value is the full month name.
214: The
1.66 kristaps 215: .Cm Year
216: value is the full four-digit year.
217: .Pp
1.72 kristaps 218: Reduced form dates are broken-down canonical form dates:
1.66 kristaps 219: .Pp
1.72 kristaps 220: .D1 Cm Month , Year
221: .D1 Cm Year
1.66 kristaps 222: .Pp
223: Some examples of valid dates follow:
224: .Pp
225: .D1 "May, 2009" Pq reduced form
226: .D1 "2009" Pq reduced form
227: .D1 "May 20, 2009" Pq canonical form
1.61 kristaps 228: .Ss Scaling Widths
229: Many macros support scaled widths for their arguments, such as
230: stipulating a two-inch list indentation with the following:
231: .Bd -literal -offset indent
232: \&.Bl -tag -width 2i
233: .Ed
234: .Pp
235: The syntax for scaled widths is
1.62 kristaps 236: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
1.61 kristaps 237: where a decimal must be preceded or proceeded by at least one digit.
1.100 kristaps 238: Negative numbers, while accepted, are truncated to zero.
239: The following scaling units are accepted:
1.61 kristaps 240: .Pp
241: .Bl -tag -width Ds -offset indent -compact
242: .It c
243: centimetre
244: .It i
245: inch
246: .It P
247: pica (~1/6 inch)
248: .It p
249: point (~1/72 inch)
250: .It f
251: synonym for
252: .Sq u
253: .It v
254: default vertical span
255: .It m
256: width of rendered
257: .Sq m
258: .Pq em
259: character
260: .It n
261: width of rendered
262: .Sq n
263: .Pq en
264: character
265: .It u
266: default horizontal span
267: .It M
268: mini-em (~1/100 em)
269: .El
270: .Pp
271: Using anything other than
272: .Sq m ,
273: .Sq n ,
274: .Sq u ,
275: or
276: .Sq v
1.100 kristaps 277: is necessarily non-portable across output media.
278: See
1.61 kristaps 279: .Sx COMPATIBILITY .
1.101 kristaps 280: .Ss Sentence Spacing
1.144 schwarze 281: When composing a manual, make sure that sentences end at the end of
1.101 kristaps 282: a line.
283: By doing so, front-ends will be able to apply the proper amount of
284: spacing after the end of sentence (unescaped) period, exclamation mark,
1.107 kristaps 285: or question mark followed by zero or more non-sentence closing
286: delimiters (
287: .Ns Sq \&) ,
288: .Sq \&] ,
289: .Sq \&' ,
290: .Sq \&" ) .
1.102 kristaps 291: .Pp
292: The proper spacing is also intelligently preserved if a sentence ends at
1.144 schwarze 293: the boundary of a macro line.
294: For example:
1.107 kristaps 295: .Pp
296: .D1 \&Xr mandoc 1 \.
297: .D1 \&Fl T \&Ns \&Cm ascii \.
1.43 kristaps 298: .Sh MANUAL STRUCTURE
1.66 kristaps 299: A well-formed
1.57 kristaps 300: .Nm
1.66 kristaps 301: document consists of a document prologue followed by one or more
302: sections.
303: .Pp
1.141 kristaps 304: The prologue, which consists of the
1.64 kristaps 305: .Sx \&Dd ,
306: .Sx \&Dt ,
1.33 kristaps 307: and
1.66 kristaps 308: .Sx \&Os
1.141 kristaps 309: macros in that order, is required for every document.
1.66 kristaps 310: .Pp
1.82 kristaps 311: The first section (sections are denoted by
1.66 kristaps 312: .Sx \&Sh )
313: must be the NAME section, consisting of at least one
1.64 kristaps 314: .Sx \&Nm
1.50 kristaps 315: followed by
1.66 kristaps 316: .Sx \&Nd .
317: .Pp
1.122 kristaps 318: Following that, convention dictates specifying at least the
319: .Em SYNOPSIS
320: and
321: .Em DESCRIPTION
322: sections, although this varies between manual sections.
1.66 kristaps 323: .Pp
324: The following is a well-formed skeleton
325: .Nm
326: file:
1.57 kristaps 327: .Bd -literal -offset indent
1.43 kristaps 328: \&.Dd $\&Mdocdate$
329: \&.Dt mdoc 7
330: \&.Os
331: \&.Sh NAME
1.58 kristaps 332: \&.Nm foo
333: \&.Nd a description goes here
334: \&.\e\*q .Sh LIBRARY
1.156 kristaps 335: \&.\e\*q For sections 2, 3, & 9 only.
336: \&.\e\*q Not used in OpenBSD.
1.58 kristaps 337: \&.Sh SYNOPSIS
338: \&.Nm foo
339: \&.Op Fl options
340: \&.Ar
341: \&.Sh DESCRIPTION
342: The
343: \&.Nm
344: utility processes files ...
1.59 kristaps 345: \&.\e\*q .Sh IMPLEMENTATION NOTES
1.159 schwarze 346: \&.\e\*q Not used in OpenBSD.
1.58 kristaps 347: \&.\e\*q .Sh RETURN VALUES
1.156 kristaps 348: \&.\e\*q For sections 2, 3, & 9 only.
1.58 kristaps 349: \&.\e\*q .Sh ENVIRONMENT
1.156 kristaps 350: \&.\e\*q For sections 1, 6, 7, & 8 only.
1.58 kristaps 351: \&.\e\*q .Sh FILES
1.99 kristaps 352: \&.\e\*q .Sh EXIT STATUS
1.159 schwarze 353: \&.\e\*q For sections 1, 6, & 8 only.
1.58 kristaps 354: \&.\e\*q .Sh EXAMPLES
355: \&.\e\*q .Sh DIAGNOSTICS
1.156 kristaps 356: \&.\e\*q For sections 1, 4, 6, 7, & 8 only.
1.58 kristaps 357: \&.\e\*q .Sh ERRORS
1.156 kristaps 358: \&.\e\*q For sections 2, 3, & 9 only.
1.58 kristaps 359: \&.\e\*q .Sh SEE ALSO
360: \&.\e\*q .Xr foobar 1
361: \&.\e\*q .Sh STANDARDS
362: \&.\e\*q .Sh HISTORY
363: \&.\e\*q .Sh AUTHORS
364: \&.\e\*q .Sh CAVEATS
365: \&.\e\*q .Sh BUGS
366: \&.\e\*q .Sh SECURITY CONSIDERATIONS
1.156 kristaps 367: \&.\e\*q Not used in OpenBSD.
1.57 kristaps 368: .Ed
369: .Pp
1.144 schwarze 370: The sections in an
1.66 kristaps 371: .Nm
1.100 kristaps 372: document are conventionally ordered as they appear above.
373: Sections should be composed as follows:
1.73 kristaps 374: .Bl -ohang -offset Ds
375: .It Em NAME
1.144 schwarze 376: The name(s) and a one line description of the documented material.
1.100 kristaps 377: The syntax for this as follows:
1.73 kristaps 378: .Bd -literal -offset indent
1.144 schwarze 379: \&.Nm name0 ,
380: \&.Nm name1 ,
1.73 kristaps 381: \&.Nm name2
1.144 schwarze 382: \&.Nd a one line description
1.73 kristaps 383: .Ed
384: .Pp
385: The
1.66 kristaps 386: .Sx \&Nm
1.73 kristaps 387: macro(s) must precede the
388: .Sx \&Nd
389: macro.
1.80 kristaps 390: .Pp
1.82 kristaps 391: See
1.80 kristaps 392: .Sx \&Nm
393: and
394: .Sx \&Nd .
1.73 kristaps 395: .It Em LIBRARY
396: The name of the library containing the documented material, which is
1.108 kristaps 397: assumed to be a function in a section 2, 3, or 9 manual.
1.100 kristaps 398: The syntax for this is as follows:
1.73 kristaps 399: .Bd -literal -offset indent
400: \&.Lb libarm
401: .Ed
402: .Pp
403: See
1.80 kristaps 404: .Sx \&Lb .
1.73 kristaps 405: .It Em SYNOPSIS
406: Documents the utility invocation syntax, function call syntax, or device
1.82 kristaps 407: configuration.
1.73 kristaps 408: .Pp
409: For the first, utilities (sections 1, 6, and 8), this is
410: generally structured as follows:
411: .Bd -literal -offset indent
412: \&.Nm foo
413: \&.Op Fl v
414: \&.Op Fl o Ar file
415: \&.Op Ar
416: \&.Nm bar
417: \&.Op Fl v
418: \&.Op Fl o Ar file
419: \&.Op Ar
420: .Ed
421: .Pp
422: For the second, function calls (sections 2, 3, 9):
423: .Bd -literal -offset indent
1.146 kristaps 424: \&.In header.h
1.73 kristaps 425: \&.Vt extern const char *global;
426: \&.Ft "char *"
427: \&.Fn foo "const char *src"
428: \&.Ft "char *"
429: \&.Fn bar "const char *src"
430: .Ed
431: .Pp
432: And for the third, configurations (section 4):
433: .Bd -literal -offset indent
434: \&.Cd \*qit* at isa? port 0x2e\*q
435: \&.Cd \*qit* at isa? port 0x4e\*q
436: .Ed
437: .Pp
1.82 kristaps 438: Manuals not in these sections generally don't need a
1.73 kristaps 439: .Em SYNOPSIS .
1.80 kristaps 440: .Pp
1.122 kristaps 441: Some macros are displayed differently in the
442: .Em SYNOPSIS
443: section, particularly
444: .Sx \&Nm ,
1.80 kristaps 445: .Sx \&Cd ,
1.122 kristaps 446: .Sx \&Fd ,
447: .Sx \&Fn ,
448: .Sx \&Fo ,
449: .Sx \&In ,
450: .Sx \&Vt ,
451: and
452: .Sx \&Ft .
1.138 kristaps 453: All of these macros are output on their own line.
1.144 schwarze 454: If two such dissimilar macros are pairwise invoked (except for
1.122 kristaps 455: .Sx \&Ft
456: before
457: .Sx \&Fo
458: or
1.123 kristaps 459: .Sx \&Fn ) ,
1.122 kristaps 460: they are separated by a vertical space, unless in the case of
461: .Sx \&Fo ,
1.80 kristaps 462: .Sx \&Fn ,
1.122 kristaps 463: and
1.80 kristaps 464: .Sx \&Ft ,
1.122 kristaps 465: which are always separated by vertical space.
1.128 schwarze 466: .Pp
467: When text and macros following an
468: .Sx \&Nm
469: macro starting an input line span multiple output lines,
470: all output lines but the first will be indented to align
471: with the text immediately following the
472: .Sx \&Nm
473: macro, up to the next
474: .Sx \&Nm ,
1.141 kristaps 475: .Sx \&Sh ,
1.128 schwarze 476: or
477: .Sx \&Ss
478: macro or the end of an enclosing block, whichever comes first.
1.73 kristaps 479: .It Em DESCRIPTION
1.144 schwarze 480: This expands upon the brief, one line description in
1.73 kristaps 481: .Em NAME .
1.144 schwarze 482: It usually contains a breakdown of the options (if documenting a
1.73 kristaps 483: command), such as:
484: .Bd -literal -offset indent
485: The arguments are as follows:
486: \&.Bl \-tag \-width Ds
487: \&.It Fl v
488: Print verbose information.
489: \&.El
490: .Ed
1.80 kristaps 491: .Pp
1.73 kristaps 492: Manuals not documenting a command won't include the above fragment.
493: .It Em IMPLEMENTATION NOTES
1.100 kristaps 494: Implementation-specific notes should be kept here.
495: This is useful when implementing standard functions that may have side
496: effects or notable algorithmic implications.
1.73 kristaps 497: .It Em RETURN VALUES
1.144 schwarze 498: This section documents the
499: return values of functions in sections 2, 3, and 9.
1.73 kristaps 500: .Pp
501: See
502: .Sx \&Rv .
503: .It Em ENVIRONMENT
1.141 kristaps 504: Lists the environment variables used by the utility,
505: and explains the syntax and semantics of their values.
506: The
507: .Xr environ 7
508: manual provides examples of typical content and formatting.
1.73 kristaps 509: .Pp
510: See
511: .Sx \&Ev .
512: .It Em FILES
1.100 kristaps 513: Documents files used.
1.141 kristaps 514: It's helpful to document both the file name and a short description of how
1.100 kristaps 515: the file is used (created, modified, etc.).
1.73 kristaps 516: .Pp
517: See
518: .Sx \&Pa .
1.99 kristaps 519: .It Em EXIT STATUS
1.144 schwarze 520: This section documents the
521: command exit status for section 1, 6, and 8 utilities.
1.100 kristaps 522: Historically, this information was described in
1.99 kristaps 523: .Em DIAGNOSTICS ,
524: a practise that is now discouraged.
525: .Pp
526: See
527: .Sx \&Ex .
1.73 kristaps 528: .It Em EXAMPLES
1.100 kristaps 529: Example usages.
530: This often contains snippets of well-formed, well-tested invocations.
1.144 schwarze 531: Make sure that examples work properly!
1.73 kristaps 532: .It Em DIAGNOSTICS
1.100 kristaps 533: Documents error conditions.
534: This is most useful in section 4 manuals.
1.73 kristaps 535: Historically, this section was used in place of
536: .Em EXIT STATUS
537: for manuals in sections 1, 6, and 8; however, this practise is
538: discouraged.
539: .Pp
540: See
1.80 kristaps 541: .Sx \&Bl
542: .Fl diag .
1.73 kristaps 543: .It Em ERRORS
544: Documents error handling in sections 2, 3, and 9.
545: .Pp
546: See
547: .Sx \&Er .
548: .It Em SEE ALSO
1.100 kristaps 549: References other manuals with related topics.
550: This section should exist for most manuals.
551: Cross-references should conventionally be ordered first by section, then
552: alphabetically.
1.73 kristaps 553: .Pp
554: See
555: .Sx \&Xr .
556: .It Em STANDARDS
1.100 kristaps 557: References any standards implemented or used.
558: If not adhering to any standards, the
1.73 kristaps 559: .Em HISTORY
560: section should be used instead.
561: .Pp
562: See
563: .Sx \&St .
564: .It Em HISTORY
1.143 schwarze 565: A brief history of the subject, including where support first appeared.
1.73 kristaps 566: .It Em AUTHORS
1.143 schwarze 567: Credits to the person or persons who wrote the code and/or documentation.
1.141 kristaps 568: Authors should generally be noted by both name and email address.
1.73 kristaps 569: .Pp
570: See
571: .Sx \&An .
572: .It Em CAVEATS
1.141 kristaps 573: Common misuses and misunderstandings should be explained
1.73 kristaps 574: in this section.
575: .It Em BUGS
1.147 kristaps 576: Known bugs, limitations, and work-arounds should be described
1.141 kristaps 577: in this section.
1.73 kristaps 578: .It Em SECURITY CONSIDERATIONS
579: Documents any security precautions that operators should consider.
1.66 kristaps 580: .El
1.43 kristaps 581: .Sh MACRO SYNTAX
1.56 kristaps 582: Macros are one to three three characters in length and begin with a
1.141 kristaps 583: control character,
1.57 kristaps 584: .Sq \&. ,
1.100 kristaps 585: at the beginning of the line.
586: An arbitrary amount of whitespace may sit between the control character
587: and the macro name.
588: Thus, the following are equivalent:
1.64 kristaps 589: .Bd -literal -offset indent
590: \&.Pp
591: \&.\ \ \ \&Pp
592: .Ed
1.57 kristaps 593: .Pp
1.100 kristaps 594: The syntax of a macro depends on its classification.
595: In this section,
1.57 kristaps 596: .Sq \-arg
1.43 kristaps 597: refers to macro arguments, which may be followed by zero or more
1.57 kristaps 598: .Sq parm
1.43 kristaps 599: parameters;
1.57 kristaps 600: .Sq \&Yo
1.43 kristaps 601: opens the scope of a macro; and if specified,
1.57 kristaps 602: .Sq \&Yc
1.43 kristaps 603: closes it out.
1.57 kristaps 604: .Pp
1.43 kristaps 605: The
1.57 kristaps 606: .Em Callable
1.43 kristaps 607: column indicates that the macro may be called subsequent to the initial
1.100 kristaps 608: line-macro.
609: If a macro is not callable, then its invocation after the initial line
610: macro is interpreted as opaque text, such that
1.60 kristaps 611: .Sq \&.Fl \&Sh
1.55 kristaps 612: produces
1.60 kristaps 613: .Sq Fl \&Sh .
1.57 kristaps 614: .Pp
1.55 kristaps 615: The
1.141 kristaps 616: .Em Parsed
1.43 kristaps 617: column indicates whether the macro may be followed by further
1.100 kristaps 618: (ostensibly callable) macros.
1.141 kristaps 619: If a macro is not parsed, subsequent macro invocations on the line
1.100 kristaps 620: will be interpreted as opaque text.
1.57 kristaps 621: .Pp
1.55 kristaps 622: The
1.57 kristaps 623: .Em Scope
1.43 kristaps 624: column, if applicable, describes closure rules.
1.57 kristaps 625: .Ss Block full-explicit
1.100 kristaps 626: Multi-line scope closed by an explicit closing macro.
627: All macros contains bodies; only
1.64 kristaps 628: .Sx \&Bf
1.43 kristaps 629: contains a head.
1.57 kristaps 630: .Bd -literal -offset indent
1.50 kristaps 631: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
632: \(lBbody...\(rB
1.43 kristaps 633: \&.Yc
1.57 kristaps 634: .Ed
635: .Pp
1.141 kristaps 636: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX"
637: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.64 kristaps 638: .It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed
639: .It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef
640: .It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek
641: .It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El
642: .It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd
643: .It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf
644: .It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk
645: .It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl
1.57 kristaps 646: .El
647: .Ss Block full-implicit
1.43 kristaps 648: Multi-line scope closed by end-of-file or implicitly by another macro.
1.50 kristaps 649: All macros have bodies; some
1.57 kristaps 650: .Po
1.64 kristaps 651: .Sx \&It Fl bullet ,
652: .Fl hyphen ,
653: .Fl dash ,
654: .Fl enum ,
655: .Fl item
1.57 kristaps 656: .Pc
1.64 kristaps 657: don't have heads; only one
658: .Po
1.141 kristaps 659: .Sx \&It
660: in
661: .Sx \&Bl Fl column
1.82 kristaps 662: .Pc
1.64 kristaps 663: has multiple heads.
1.57 kristaps 664: .Bd -literal -offset indent
1.50 kristaps 665: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
666: \(lBbody...\(rB
1.57 kristaps 667: .Ed
668: .Pp
1.141 kristaps 669: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX"
670: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.64 kristaps 671: .It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El
672: .It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh
1.128 schwarze 673: .It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss
1.64 kristaps 674: .It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh
675: .It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss
1.57 kristaps 676: .El
1.128 schwarze 677: .Pp
678: Note that the
679: .Sx \&Nm
680: macro is a
681: .Sx Block full-implicit
682: macro only when invoked as the first macro
683: in a
684: .Em SYNOPSIS
685: section line, else it is
686: .Sx In-line .
1.57 kristaps 687: .Ss Block partial-explicit
1.100 kristaps 688: Like block full-explicit, but also with single-line scope.
689: Each has at least a body and, in limited circumstances, a head
1.64 kristaps 690: .Po
691: .Sx \&Fo ,
692: .Sx \&Eo
693: .Pc
1.50 kristaps 694: and/or tail
1.64 kristaps 695: .Pq Sx \&Ec .
1.57 kristaps 696: .Bd -literal -offset indent
1.50 kristaps 697: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
698: \(lBbody...\(rB
699: \&.Yc \(lBtail...\(rB
1.2 kristaps 700:
1.43 kristaps 701: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
1.50 kristaps 702: \(lBbody...\(rB \&Yc \(lBtail...\(rB
1.57 kristaps 703: .Ed
704: .Pp
1.141 kristaps 705: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent
706: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.64 kristaps 707: .It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao
1.63 kristaps 708: .It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac
1.64 kristaps 709: .It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo
710: .It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc
711: .It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro
712: .It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc
713: .It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do
714: .It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc
715: .It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo
716: .It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec
717: .It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo
718: .It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc
719: .It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo
720: .It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc
721: .It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po
722: .It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc
723: .It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo
724: .It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc
1.63 kristaps 725: .It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs
726: .It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re
1.64 kristaps 727: .It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So
728: .It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc
729: .It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo
730: .It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc
1.57 kristaps 731: .El
732: .Ss Block partial-implicit
1.50 kristaps 733: Like block full-implicit, but with single-line scope closed by
1.57 kristaps 734: .Sx Reserved Characters
1.43 kristaps 735: or end of line.
1.57 kristaps 736: .Bd -literal -offset indent
1.43 kristaps 737: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
1.57 kristaps 738: .Ed
739: .Pp
1.141 kristaps 740: .Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent
741: .It Em Macro Ta Em Callable Ta Em Parsed
1.64 kristaps 742: .It Sx \&Aq Ta Yes Ta Yes
743: .It Sx \&Bq Ta Yes Ta Yes
744: .It Sx \&Brq Ta Yes Ta Yes
745: .It Sx \&D1 Ta \&No Ta \&Yes
746: .It Sx \&Dl Ta \&No Ta Yes
747: .It Sx \&Dq Ta Yes Ta Yes
748: .It Sx \&Op Ta Yes Ta Yes
749: .It Sx \&Pq Ta Yes Ta Yes
750: .It Sx \&Ql Ta Yes Ta Yes
751: .It Sx \&Qq Ta Yes Ta Yes
752: .It Sx \&Sq Ta Yes Ta Yes
1.83 kristaps 753: .It Sx \&Vt Ta Yes Ta Yes
1.57 kristaps 754: .El
1.83 kristaps 755: .Pp
756: Note that the
757: .Sx \&Vt
758: macro is a
759: .Sx Block partial-implicit
760: only when invoked as the first macro
1.109 kristaps 761: in a
762: .Em SYNOPSIS
763: section line, else it is
1.83 kristaps 764: .Sx In-line .
1.57 kristaps 765: .Ss In-line
1.50 kristaps 766: Closed by
1.57 kristaps 767: .Sx Reserved Characters ,
1.100 kristaps 768: end of line, fixed argument lengths, and/or subsequent macros.
769: In-line macros have only text children.
770: If a number (or inequality) of arguments is
1.57 kristaps 771: .Pq n ,
1.3 kristaps 772: then the macro accepts an arbitrary number of arguments.
1.57 kristaps 773: .Bd -literal -offset indent
1.144 schwarze 774: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB
1.43 kristaps 775:
776: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
777:
778: \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
1.57 kristaps 779: .Ed
780: .Pp
1.141 kristaps 781: .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent
782: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
1.63 kristaps 783: .It Sx \&%A Ta \&No Ta \&No Ta >0
784: .It Sx \&%B Ta \&No Ta \&No Ta >0
785: .It Sx \&%C Ta \&No Ta \&No Ta >0
786: .It Sx \&%D Ta \&No Ta \&No Ta >0
787: .It Sx \&%I Ta \&No Ta \&No Ta >0
788: .It Sx \&%J Ta \&No Ta \&No Ta >0
789: .It Sx \&%N Ta \&No Ta \&No Ta >0
790: .It Sx \&%O Ta \&No Ta \&No Ta >0
791: .It Sx \&%P Ta \&No Ta \&No Ta >0
1.69 kristaps 792: .It Sx \&%Q Ta \&No Ta \&No Ta >0
1.63 kristaps 793: .It Sx \&%R Ta \&No Ta \&No Ta >0
794: .It Sx \&%T Ta \&No Ta \&No Ta >0
1.69 kristaps 795: .It Sx \&%U Ta \&No Ta \&No Ta >0
1.63 kristaps 796: .It Sx \&%V Ta \&No Ta \&No Ta >0
1.64 kristaps 797: .It Sx \&Ad Ta Yes Ta Yes Ta n
798: .It Sx \&An Ta Yes Ta Yes Ta n
799: .It Sx \&Ap Ta Yes Ta Yes Ta 0
800: .It Sx \&Ar Ta Yes Ta Yes Ta n
801: .It Sx \&At Ta Yes Ta Yes Ta 1
802: .It Sx \&Bsx Ta Yes Ta Yes Ta n
803: .It Sx \&Bt Ta \&No Ta \&No Ta 0
804: .It Sx \&Bx Ta Yes Ta Yes Ta n
805: .It Sx \&Cd Ta Yes Ta Yes Ta >0
806: .It Sx \&Cm Ta Yes Ta Yes Ta n
807: .It Sx \&Db Ta \&No Ta \&No Ta 1
1.142 kristaps 808: .It Sx \&Dd Ta \&No Ta \&No Ta n
1.64 kristaps 809: .It Sx \&Dt Ta \&No Ta \&No Ta n
810: .It Sx \&Dv Ta Yes Ta Yes Ta n
811: .It Sx \&Dx Ta Yes Ta Yes Ta n
812: .It Sx \&Em Ta Yes Ta Yes Ta >0
813: .It Sx \&En Ta \&No Ta \&No Ta 0
814: .It Sx \&Er Ta Yes Ta Yes Ta >0
815: .It Sx \&Es Ta \&No Ta \&No Ta 0
816: .It Sx \&Ev Ta Yes Ta Yes Ta n
817: .It Sx \&Ex Ta \&No Ta \&No Ta n
818: .It Sx \&Fa Ta Yes Ta Yes Ta n
819: .It Sx \&Fd Ta \&No Ta \&No Ta >0
820: .It Sx \&Fl Ta Yes Ta Yes Ta n
821: .It Sx \&Fn Ta Yes Ta Yes Ta >0
822: .It Sx \&Fr Ta \&No Ta \&No Ta n
823: .It Sx \&Ft Ta Yes Ta Yes Ta n
824: .It Sx \&Fx Ta Yes Ta Yes Ta n
825: .It Sx \&Hf Ta \&No Ta \&No Ta n
826: .It Sx \&Ic Ta Yes Ta Yes Ta >0
827: .It Sx \&In Ta \&No Ta \&No Ta n
828: .It Sx \&Lb Ta \&No Ta \&No Ta 1
829: .It Sx \&Li Ta Yes Ta Yes Ta n
830: .It Sx \&Lk Ta Yes Ta Yes Ta n
831: .It Sx \&Lp Ta \&No Ta \&No Ta 0
832: .It Sx \&Ms Ta Yes Ta Yes Ta >0
833: .It Sx \&Mt Ta Yes Ta Yes Ta >0
834: .It Sx \&Nm Ta Yes Ta Yes Ta n
835: .It Sx \&No Ta Yes Ta Yes Ta 0
836: .It Sx \&Ns Ta Yes Ta Yes Ta 0
837: .It Sx \&Nx Ta Yes Ta Yes Ta n
838: .It Sx \&Os Ta \&No Ta \&No Ta n
839: .It Sx \&Ot Ta \&No Ta \&No Ta n
840: .It Sx \&Ox Ta Yes Ta Yes Ta n
841: .It Sx \&Pa Ta Yes Ta Yes Ta n
1.88 kristaps 842: .It Sx \&Pf Ta Yes Ta Yes Ta 1
1.64 kristaps 843: .It Sx \&Pp Ta \&No Ta \&No Ta 0
844: .It Sx \&Rv Ta \&No Ta \&No Ta n
845: .It Sx \&Sm Ta \&No Ta \&No Ta 1
846: .It Sx \&St Ta \&No Ta Yes Ta 1
847: .It Sx \&Sx Ta Yes Ta Yes Ta >0
848: .It Sx \&Sy Ta Yes Ta Yes Ta >0
849: .It Sx \&Tn Ta Yes Ta Yes Ta >0
850: .It Sx \&Ud Ta \&No Ta \&No Ta 0
851: .It Sx \&Ux Ta Yes Ta Yes Ta n
852: .It Sx \&Va Ta Yes Ta Yes Ta n
853: .It Sx \&Vt Ta Yes Ta Yes Ta >0
1.84 kristaps 854: .It Sx \&Xr Ta Yes Ta Yes Ta >0
1.64 kristaps 855: .It Sx \&br Ta \&No Ta \&No Ta 0
856: .It Sx \&sp Ta \&No Ta \&No Ta 1
1.82 kristaps 857: .El
1.63 kristaps 858: .Sh REFERENCE
859: This section is a canonical reference of all macros, arranged
1.100 kristaps 860: alphabetically.
861: For the scoping of individual macros, see
1.63 kristaps 862: .Sx MACRO SYNTAX .
863: .Ss \&%A
864: Author name of an
865: .Sx \&Rs
1.138 kristaps 866: block.
867: Multiple authors should each be accorded their own
1.64 kristaps 868: .Sx \%%A
1.138 kristaps 869: line.
870: Author names should be ordered with full or abbreviated forename(s)
871: first, then full surname.
1.63 kristaps 872: .Ss \&%B
873: Book title of an
874: .Sx \&Rs
1.138 kristaps 875: block.
876: This macro may also be used in a non-bibliographic context when
1.63 kristaps 877: referring to book titles.
878: .Ss \&%C
879: Publication city or location of an
880: .Sx \&Rs
881: block.
882: .Ss \&%D
883: Publication date of an
884: .Sx \&Rs
1.138 kristaps 885: block.
886: This should follow the reduced or canonical form syntax described in
1.63 kristaps 887: .Sx Dates .
888: .Ss \&%I
889: Publisher or issuer name of an
890: .Sx \&Rs
891: block.
892: .Ss \&%J
893: Journal name of an
894: .Sx \&Rs
895: block.
896: .Ss \&%N
897: Issue number (usually for journals) of an
898: .Sx \&Rs
899: block.
900: .Ss \&%O
901: Optional information of an
902: .Sx \&Rs
903: block.
904: .Ss \&%P
905: Book or journal page number of an
906: .Sx \&Rs
907: block.
908: .Ss \&%Q
909: Institutional author (school, government, etc.) of an
910: .Sx \&Rs
1.138 kristaps 911: block.
912: Multiple institutional authors should each be accorded their own
1.64 kristaps 913: .Sx \&%Q
1.63 kristaps 914: line.
915: .Ss \&%R
916: Technical report name of an
917: .Sx \&Rs
918: block.
919: .Ss \&%T
920: Article title of an
921: .Sx \&Rs
1.138 kristaps 922: block.
923: This macro may also be used in a non-bibliographical context when
924: referring to article titles.
1.69 kristaps 925: .Ss \&%U
1.70 kristaps 926: URI of reference document.
1.63 kristaps 927: .Ss \&%V
928: Volume number of an
929: .Sx \&Rs
930: block.
931: .Ss \&Ac
1.141 kristaps 932: Close an
1.63 kristaps 933: .Sx \&Ao
1.138 kristaps 934: block.
935: Does not have any tail arguments.
1.63 kristaps 936: .Ss \&Ad
1.141 kristaps 937: Memory address.
938: Do not use this for postal addresses.
1.63 kristaps 939: .Pp
1.64 kristaps 940: Examples:
1.91 kristaps 941: .D1 \&.Ad [0,$]
942: .D1 \&.Ad 0x00000000
1.63 kristaps 943: .Ss \&An
1.100 kristaps 944: Author name.
1.141 kristaps 945: Requires either the name of an author or one of the following arguments:
1.140 kristaps 946: .Pp
947: .Bl -tag -width "-nosplitX" -offset indent -compact
1.64 kristaps 948: .It Fl split
1.141 kristaps 949: Start a new output line before each subsequent invocation of
950: .Sx \&An .
1.64 kristaps 951: .It Fl nosplit
952: The opposite of
953: .Fl split .
954: .El
955: .Pp
1.141 kristaps 956: The default is
957: .Fl nosplit .
958: The effect of selecting either of the
959: .Fl split
960: modes ends at the beginning of the
961: .Em AUTHORS
962: section.
1.140 kristaps 963: In the
964: .Em AUTHORS
1.141 kristaps 965: section, the default is
966: .Fl nosplit
967: for the first author listing and
1.64 kristaps 968: .Fl split
1.141 kristaps 969: for all other author listings.
1.64 kristaps 970: .Pp
971: Examples:
1.91 kristaps 972: .D1 \&.An -nosplit
1.141 kristaps 973: .D1 \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv
1.63 kristaps 974: .Ss \&Ao
1.141 kristaps 975: Begin a block enclosed by angle brackets.
1.100 kristaps 976: Does not have any head arguments.
1.63 kristaps 977: .Pp
1.64 kristaps 978: Examples:
1.91 kristaps 979: .D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
1.63 kristaps 980: .Pp
1.64 kristaps 981: See also
982: .Sx \&Aq .
1.63 kristaps 983: .Ss \&Ap
1.138 kristaps 984: Inserts an apostrophe without any surrounding whitespace.
1.124 kristaps 985: This is generally used as a grammatical device when referring to the verb
1.140 kristaps 986: form of a function.
987: .Pp
988: Examples:
989: .D1 \&.Fn execve \&Ap d
1.63 kristaps 990: .Ss \&Aq
1.141 kristaps 991: Encloses its arguments in angle brackets.
1.64 kristaps 992: .Pp
993: Examples:
1.91 kristaps 994: .D1 \&.Fl -key= \&Ns \&Aq \&Ar val
1.64 kristaps 995: .Pp
996: .Em Remarks :
997: this macro is often abused for rendering URIs, which should instead use
998: .Sx \&Lk
999: or
1000: .Sx \&Mt ,
1001: or to note pre-processor
1002: .Dq Li #include
1003: statements, which should use
1004: .Sx \&In .
1005: .Pp
1006: See also
1007: .Sx \&Ao .
1.63 kristaps 1008: .Ss \&Ar
1.100 kristaps 1009: Command arguments.
1010: If an argument is not provided, the string
1.141 kristaps 1011: .Dq file ...\&
1.66 kristaps 1012: is used as a default.
1.64 kristaps 1013: .Pp
1014: Examples:
1.91 kristaps 1015: .D1 \&.Fl o \&Ns \&Ar file1
1016: .D1 \&.Ar
1017: .D1 \&.Ar arg1 , arg2 .
1.63 kristaps 1018: .Ss \&At
1.100 kristaps 1019: Formats an AT&T version.
1.141 kristaps 1020: Accepts one optional argument:
1.140 kristaps 1021: .Pp
1022: .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
1.64 kristaps 1023: .It Cm v[1-7] | 32v
1024: A version of
1025: .At .
1026: .It Cm V[.[1-4]]?
1.141 kristaps 1027: A version of
1028: .At V .
1.64 kristaps 1029: .El
1030: .Pp
1.141 kristaps 1031: Note that these arguments do not begin with a hyphen.
1.64 kristaps 1032: .Pp
1033: Examples:
1.91 kristaps 1034: .D1 \&.At
1035: .D1 \&.At V.1
1.65 kristaps 1036: .Pp
1037: See also
1.66 kristaps 1038: .Sx \&Bsx ,
1.65 kristaps 1039: .Sx \&Bx ,
1.66 kristaps 1040: .Sx \&Dx ,
1.65 kristaps 1041: .Sx \&Fx ,
1042: .Sx \&Nx ,
1043: .Sx \&Ox ,
1044: and
1045: .Sx \&Ux .
1.63 kristaps 1046: .Ss \&Bc
1.141 kristaps 1047: Close a
1.64 kristaps 1048: .Sx \&Bo
1.138 kristaps 1049: block.
1050: Does not have any tail arguments.
1.63 kristaps 1051: .Ss \&Bd
1.141 kristaps 1052: Begin a display block.
1.131 kristaps 1053: Its syntax is as follows:
1054: .Bd -ragged -offset indent
1055: .Pf \. Sx \&Bd
1.141 kristaps 1056: .Fl Ns Ar type
1.131 kristaps 1057: .Op Fl offset Ar width
1058: .Op Fl compact
1059: .Ed
1060: .Pp
1.141 kristaps 1061: Display blocks are used to select a different indentation and
1062: justification than the one used by the surrounding text.
1063: They may contain both macro lines and free-form text lines.
1064: By default, a display block is preceded by a vertical space.
1.64 kristaps 1065: .Pp
1.141 kristaps 1066: The
1067: .Ar type
1068: must be one of the following:
1069: .Bl -tag -width 13n -offset indent
1070: .It Fl centered
1071: Centre-justify each line.
1072: Using this display type is not recommended; many
1073: .Nm
1074: implementations render it poorly.
1075: .It Fl filled
1076: Left- and right-justify the block.
1077: .It Fl literal
1078: Do not justify the block at all.
1.161 kristaps 1079: Preserve white space and newlines as they appear in the input, including
1080: if it follows a macro.
1.64 kristaps 1081: .It Fl ragged
1082: Only left-justify the block.
1083: .It Fl unfilled
1.141 kristaps 1084: An alias for
1085: .Fl literal .
1.64 kristaps 1086: .El
1087: .Pp
1.141 kristaps 1088: The
1089: .Ar type
1090: must be provided first.
1091: Additional arguments may follow:
1092: .Bl -tag -width 13n -offset indent
1093: .It Fl offset Ar width
1094: Indent the display by the
1095: .Ar width ,
1096: which may be one of the following:
1.64 kristaps 1097: .Bl -item
1098: .It
1.141 kristaps 1099: One of the pre-defined strings
1100: .Cm indent ,
1.64 kristaps 1101: the width of standard indentation;
1.141 kristaps 1102: .Cm indent-two ,
1.64 kristaps 1103: twice
1.141 kristaps 1104: .Cm indent ;
1105: .Cm left ,
1.131 kristaps 1106: which has no effect;
1.141 kristaps 1107: .Cm right ,
1108: which justifies to the right margin; or
1109: .Cm center ,
1.64 kristaps 1110: which aligns around an imagined centre axis.
1111: .It
1.141 kristaps 1112: A macro invocation, which selects a predefined width
1113: associated with that macro.
1.100 kristaps 1114: The most popular is the imaginary macro
1.67 kristaps 1115: .Ar \&Ds ,
1.64 kristaps 1116: which resolves to
1.141 kristaps 1117: .Sy 6n .
1.64 kristaps 1118: .It
1.141 kristaps 1119: A width using the syntax described in
1.64 kristaps 1120: .Sx Scaling Widths .
1121: .It
1.141 kristaps 1122: An arbitrary string, which indents by the length of this string.
1.64 kristaps 1123: .El
1124: .Pp
1.141 kristaps 1125: When the argument is missing,
1126: .Fl offset
1127: is ignored.
1.64 kristaps 1128: .It Fl compact
1.141 kristaps 1129: Do not assert vertical space before the display.
1.64 kristaps 1130: .El
1131: .Pp
1132: Examples:
1133: .Bd -literal -offset indent
1.141 kristaps 1134: \&.Bd \-literal \-offset indent \-compact
1.65 kristaps 1135: Hello world.
1.64 kristaps 1136: \&.Ed
1137: .Ed
1.66 kristaps 1138: .Pp
1139: See also
1140: .Sx \&D1
1141: and
1142: .Sx \&Dl .
1.63 kristaps 1143: .Ss \&Bf
1.129 kristaps 1144: Change the font mode for a scoped block of text.
1145: Its syntax is as follows:
1146: .Bd -ragged -offset indent
1147: .Pf \. Sx \&Bf
1148: .Oo
1149: .Fl emphasis | literal | symbolic |
1150: .Cm \&Em | \&Li | \&Sy
1151: .Oc
1152: .Ed
1153: .Pp
1154: The
1155: .Fl emphasis
1156: and
1157: .Cm \&Em
1158: argument are equivalent, as are
1159: .Fl symbolic
1160: and
1.144 schwarze 1161: .Cm \&Sy ,
1.129 kristaps 1162: and
1163: .Fl literal
1164: and
1165: .Cm \&Li .
1166: Without an argument, this macro does nothing.
1167: The font mode continues until broken by a new font mode in a nested
1168: scope or
1169: .Sx \&Ef
1170: is encountered.
1171: .Pp
1172: See also
1173: .Sx \&Li ,
1174: .Sx \&Ef ,
1.141 kristaps 1175: .Sx \&Em ,
1.129 kristaps 1176: and
1177: .Sx \&Sy .
1.63 kristaps 1178: .Ss \&Bk
1.141 kristaps 1179: Keep the output generated from each macro input line together
1180: on one single output line.
1181: Line breaks in free-form text lines are unaffected.
1182: The syntax is as follows:
1.131 kristaps 1183: .Pp
1184: .D1 Pf \. Sx \&Bk Fl words
1185: .Pp
1.133 kristaps 1186: The
1187: .Fl words
1.141 kristaps 1188: argument is required; additional arguments are ignored.
1.127 schwarze 1189: .Pp
1.141 kristaps 1190: The following example will not break within each
1.133 kristaps 1191: .Sx \&Op
1192: macro line:
1.127 schwarze 1193: .Bd -literal -offset indent
1194: \&.Bk \-words
1.133 kristaps 1195: \&.Op Fl f Ar flags
1196: \&.Op Fl o Ar output
1.127 schwarze 1197: \&.Ek
1198: .Ed
1.129 kristaps 1199: .Pp
1.133 kristaps 1200: Be careful in using over-long lines within a keep block!
1201: Doing so will clobber the right margin.
1.63 kristaps 1202: .Ss \&Bl
1.141 kristaps 1203: Begin a list.
1204: Lists consist of items started by the
1205: .Sx \&It
1206: macro, containing a head or a body or both.
1207: The list syntax is as follows:
1.131 kristaps 1208: .Bd -ragged -offset indent
1209: .Pf \. Sx \&Bl
1.141 kristaps 1210: .Fl Ns Ar type
1.131 kristaps 1211: .Op Fl width Ar val
1212: .Op Fl offset Ar val
1213: .Op Fl compact
1214: .Op HEAD ...
1215: .Ed
1216: .Pp
1.141 kristaps 1217: The list
1218: .Ar type
1219: is mandatory and must be specified first.
1220: The
1221: .Fl width
1222: and
1223: .Fl offset
1224: arguments accept
1.104 kristaps 1225: .Sx Scaling Widths
1.141 kristaps 1226: or use the length of the given string.
1227: The
1228: .Fl offset
1229: is a global indentation for the whole list, affecting both item heads
1230: and bodies.
1231: For those list types supporting it, the
1232: .Fl width
1233: argument requests an additional indentation of item bodies,
1234: to be added to the
1235: .Fl offset .
1236: Unless the
1237: .Fl compact
1238: argument is specified, list entries are separated by vertical space.
1239: .Pp
1.103 kristaps 1240: A list must specify one of the following list types:
1241: .Bl -tag -width 12n -offset indent
1242: .It Fl bullet
1.141 kristaps 1243: No item heads can be specified, but a bullet will be printed at the head
1244: of each item.
1245: Item bodies start on the same output line as the bullet
1246: and are indented according to the
1.104 kristaps 1247: .Fl width
1.141 kristaps 1248: argument.
1.103 kristaps 1249: .It Fl column
1250: A columnated list.
1.104 kristaps 1251: The
1252: .Fl width
1.141 kristaps 1253: argument has no effect; instead, each argument specifies the width
1254: of one column, using either the
1.103 kristaps 1255: .Sx Scaling Widths
1.141 kristaps 1256: syntax or the string length of the argument.
1257: If the first line of the body of a
1.114 kristaps 1258: .Fl column
1259: list is not an
1260: .Sx \&It
1.141 kristaps 1261: macro line,
1262: .Sx \&It
1263: contexts spanning one input line each are implied until an
1.114 kristaps 1264: .Sx \&It
1.141 kristaps 1265: macro line is encountered, at which point items start being interpreted as
1.114 kristaps 1266: described in the
1267: .Sx \&It
1268: documentation.
1.103 kristaps 1269: .It Fl dash
1.141 kristaps 1270: Like
1271: .Fl bullet ,
1272: except that dashes are used in place of bullets.
1.103 kristaps 1273: .It Fl diag
1274: Like
1275: .Fl inset ,
1.141 kristaps 1276: except that item heads are not parsed for macro invocations.
1277: .\" but with additional formatting to the head.
1.103 kristaps 1278: .It Fl enum
1.141 kristaps 1279: A numbered list.
1280: Formatted like
1281: .Fl bullet ,
1282: except that cardinal numbers are used in place of bullets,
1283: starting at 1.
1.103 kristaps 1284: .It Fl hang
1285: Like
1286: .Fl tag ,
1.141 kristaps 1287: except that the first lines of item bodies are not indented, but follow
1288: the item heads like in
1289: .Fl inset
1290: lists.
1.103 kristaps 1291: .It Fl hyphen
1292: Synonym for
1293: .Fl dash .
1294: .It Fl inset
1.141 kristaps 1295: Item bodies follow items heads on the same line, using normal inter-word
1296: spacing.
1297: Bodies are not indented, and the
1.104 kristaps 1298: .Fl width
1299: argument is ignored.
1.103 kristaps 1300: .It Fl item
1.141 kristaps 1301: No item heads can be specified, and none are printed.
1302: Bodies are not indented, and the
1.104 kristaps 1303: .Fl width
1304: argument is ignored.
1.103 kristaps 1305: .It Fl ohang
1.141 kristaps 1306: Item bodies start on the line following item heads and are not indented.
1.104 kristaps 1307: The
1308: .Fl width
1309: argument is ignored.
1.103 kristaps 1310: .It Fl tag
1.141 kristaps 1311: Item bodies are indented according to the
1.103 kristaps 1312: .Fl width
1313: argument.
1.141 kristaps 1314: When an item head fits inside the indentation, the item body follows
1315: this head on the same output line.
1316: Otherwise, the body starts on the output line following the head.
1.103 kristaps 1317: .El
1.114 kristaps 1318: .Pp
1319: See also
1.141 kristaps 1320: .Sx \&El
1321: and
1.114 kristaps 1322: .Sx \&It .
1.63 kristaps 1323: .Ss \&Bo
1.141 kristaps 1324: Begin a block enclosed by square brackets.
1.100 kristaps 1325: Does not have any head arguments.
1.65 kristaps 1326: .Pp
1327: Examples:
1.140 kristaps 1328: .Bd -literal -offset indent -compact
1.65 kristaps 1329: \&.Bo 1 ,
1.91 kristaps 1330: \&.Dv BUFSIZ \&Bc
1.65 kristaps 1331: .Ed
1332: .Pp
1333: See also
1334: .Sx \&Bq .
1.63 kristaps 1335: .Ss \&Bq
1.82 kristaps 1336: Encloses its arguments in square brackets.
1.65 kristaps 1337: .Pp
1338: Examples:
1.91 kristaps 1339: .D1 \&.Bq 1 , \&Dv BUFSIZ
1.65 kristaps 1340: .Pp
1341: .Em Remarks :
1342: this macro is sometimes abused to emulate optional arguments for
1343: commands; the correct macros to use for this purpose are
1344: .Sx \&Op ,
1345: .Sx \&Oo ,
1346: and
1347: .Sx \&Oc .
1348: .Pp
1349: See also
1350: .Sx \&Bo .
1.63 kristaps 1351: .Ss \&Brc
1.141 kristaps 1352: Close a
1.65 kristaps 1353: .Sx \&Bro
1.138 kristaps 1354: block.
1355: Does not have any tail arguments.
1.63 kristaps 1356: .Ss \&Bro
1.141 kristaps 1357: Begin a block enclosed by curly braces.
1.100 kristaps 1358: Does not have any head arguments.
1.65 kristaps 1359: .Pp
1360: Examples:
1.140 kristaps 1361: .Bd -literal -offset indent -compact
1.65 kristaps 1362: \&.Bro 1 , ... ,
1.91 kristaps 1363: \&.Va n \&Brc
1.65 kristaps 1364: .Ed
1365: .Pp
1366: See also
1367: .Sx \&Brq .
1.63 kristaps 1368: .Ss \&Brq
1.65 kristaps 1369: Encloses its arguments in curly braces.
1370: .Pp
1371: Examples:
1.91 kristaps 1372: .D1 \&.Brq 1 , ... , \&Va n
1.65 kristaps 1373: .Pp
1374: See also
1375: .Sx \&Bro .
1.63 kristaps 1376: .Ss \&Bsx
1.65 kristaps 1377: Format the BSD/OS version provided as an argument, or a default value if
1378: no argument is provided.
1379: .Pp
1380: Examples:
1.91 kristaps 1381: .D1 \&.Bsx 1.0
1382: .D1 \&.Bsx
1.65 kristaps 1383: .Pp
1384: See also
1385: .Sx \&At ,
1386: .Sx \&Bx ,
1.66 kristaps 1387: .Sx \&Dx ,
1.65 kristaps 1388: .Sx \&Fx ,
1389: .Sx \&Nx ,
1390: .Sx \&Ox ,
1391: and
1392: .Sx \&Ux .
1.63 kristaps 1393: .Ss \&Bt
1.66 kristaps 1394: Prints
1.144 schwarze 1395: .Dq is currently in beta test .
1.63 kristaps 1396: .Ss \&Bx
1.65 kristaps 1397: Format the BSD version provided as an argument, or a default value if no
1398: argument is provided.
1399: .Pp
1400: Examples:
1.91 kristaps 1401: .D1 \&.Bx 4.4
1402: .D1 \&.Bx
1.65 kristaps 1403: .Pp
1404: See also
1405: .Sx \&At ,
1406: .Sx \&Bsx ,
1.66 kristaps 1407: .Sx \&Dx ,
1.65 kristaps 1408: .Sx \&Fx ,
1409: .Sx \&Nx ,
1410: .Sx \&Ox ,
1411: and
1412: .Sx \&Ux .
1.63 kristaps 1413: .Ss \&Cd
1.141 kristaps 1414: Kernel configuration declaration.
1.100 kristaps 1415: This denotes strings accepted by
1.66 kristaps 1416: .Xr config 8 .
1417: .Pp
1418: Examples:
1.91 kristaps 1419: .D1 \&.Cd device le0 at scode?
1.66 kristaps 1420: .Pp
1421: .Em Remarks :
1422: this macro is commonly abused by using quoted literals to retain
1.138 kristaps 1423: whitespace and align consecutive
1.66 kristaps 1424: .Sx \&Cd
1.100 kristaps 1425: declarations.
1426: This practise is discouraged.
1.63 kristaps 1427: .Ss \&Cm
1.100 kristaps 1428: Command modifiers.
1429: Useful when specifying configuration options or keys.
1.66 kristaps 1430: .Pp
1431: Examples:
1.91 kristaps 1432: .D1 \&.Cm ControlPath
1433: .D1 \&.Cm ControlMaster
1.66 kristaps 1434: .Pp
1435: See also
1436: .Sx \&Fl .
1.63 kristaps 1437: .Ss \&D1
1.100 kristaps 1438: One-line indented display.
1439: This is formatted by the default rules and is useful for simple indented
1440: statements.
1441: It is followed by a newline.
1.66 kristaps 1442: .Pp
1443: Examples:
1.91 kristaps 1444: .D1 \&.D1 \&Fl abcdefgh
1.66 kristaps 1445: .Pp
1446: See also
1447: .Sx \&Bd
1448: and
1449: .Sx \&Dl .
1.63 kristaps 1450: .Ss \&Db
1.141 kristaps 1451: Switch debugging mode.
1.120 kristaps 1452: Its syntax is as follows:
1.117 kristaps 1453: .Pp
1.120 kristaps 1454: .D1 Pf \. Sx \&Db Cm on | off
1.141 kristaps 1455: .Pp
1456: This macro is ignored by
1457: .Xr mandoc 1 .
1.63 kristaps 1458: .Ss \&Dc
1.141 kristaps 1459: Close a
1.66 kristaps 1460: .Sx \&Do
1.138 kristaps 1461: block.
1462: Does not have any tail arguments.
1.63 kristaps 1463: .Ss \&Dd
1.100 kristaps 1464: Document date.
1465: This is the mandatory first macro of any
1.66 kristaps 1466: .Nm
1.100 kristaps 1467: manual.
1.120 kristaps 1468: Its syntax is as follows:
1.66 kristaps 1469: .Pp
1.142 kristaps 1470: .D1 Pf \. Sx \&Dd Op Ar date
1.66 kristaps 1471: .Pp
1.82 kristaps 1472: The
1.141 kristaps 1473: .Ar date
1474: may be either
1.66 kristaps 1475: .Ar $\&Mdocdate$ ,
1476: which signifies the current manual revision date dictated by
1.72 kristaps 1477: .Xr cvs 1 ,
1.66 kristaps 1478: or instead a valid canonical date as specified by
1479: .Sx Dates .
1.142 kristaps 1480: If a date does not conform or is empty, the current date is used.
1.66 kristaps 1481: .Pp
1482: Examples:
1.91 kristaps 1483: .D1 \&.Dd $\&Mdocdate$
1484: .D1 \&.Dd $\&Mdocdate: July 21 2007$
1485: .D1 \&.Dd July 21, 2007
1.66 kristaps 1486: .Pp
1487: See also
1488: .Sx \&Dt
1489: and
1490: .Sx \&Os .
1.63 kristaps 1491: .Ss \&Dl
1.100 kristaps 1492: One-line intended display.
1493: This is formatted as literal text and is useful for commands and
1494: invocations.
1495: It is followed by a newline.
1.66 kristaps 1496: .Pp
1497: Examples:
1.140 kristaps 1498: .D1 \&.Dl % mandoc mdoc.7 \e(ba less
1.66 kristaps 1499: .Pp
1500: See also
1501: .Sx \&Bd
1502: and
1503: .Sx \&D1 .
1.63 kristaps 1504: .Ss \&Do
1.141 kristaps 1505: Begin a block enclosed by double quotes.
1.138 kristaps 1506: Does not have any head arguments.
1.66 kristaps 1507: .Pp
1508: Examples:
1.140 kristaps 1509: .Bd -literal -offset indent -compact
1510: \&.Do
1511: April is the cruellest month
1512: \&.Dc
1513: \e(em T.S. Eliot
1514: .Ed
1.66 kristaps 1515: .Pp
1516: See also
1517: .Sx \&Dq .
1.63 kristaps 1518: .Ss \&Dq
1.138 kristaps 1519: Encloses its arguments in
1520: .Dq typographic
1521: double-quotes.
1.66 kristaps 1522: .Pp
1523: Examples:
1.91 kristaps 1524: .Bd -literal -offset indent -compact
1.66 kristaps 1525: \&.Dq April is the cruellest month
1526: \e(em T.S. Eliot
1527: .Ed
1528: .Pp
1529: See also
1.139 kristaps 1530: .Sx \&Qq ,
1531: .Sx \&Sq ,
1.138 kristaps 1532: and
1.66 kristaps 1533: .Sx \&Do .
1.139 kristaps 1534: .Ss \&Dt
1.100 kristaps 1535: Document title.
1536: This is the mandatory second macro of any
1.66 kristaps 1537: .Nm
1.100 kristaps 1538: file.
1.120 kristaps 1539: Its syntax is as follows:
1540: .Bd -ragged -offset indent
1541: .Pf \. Sx \&Dt
1542: .Oo
1.141 kristaps 1543: .Ar title
1.120 kristaps 1544: .Oo
1.141 kristaps 1545: .Ar section
1546: .Op Ar volume | arch
1.120 kristaps 1547: .Oc
1548: .Oc
1549: .Ed
1.66 kristaps 1550: .Pp
1551: Its arguments are as follows:
1552: .Bl -tag -width Ds -offset Ds
1.141 kristaps 1553: .It Ar title
1.111 kristaps 1554: The document's title (name), defaulting to
1.138 kristaps 1555: .Dq UNKNOWN
1.111 kristaps 1556: if unspecified.
1557: It should be capitalised.
1.141 kristaps 1558: .It Ar section
1.100 kristaps 1559: The manual section.
1560: This may be one of
1.66 kristaps 1561: .Ar 1
1562: .Pq utilities ,
1563: .Ar 2
1564: .Pq system calls ,
1565: .Ar 3
1566: .Pq libraries ,
1567: .Ar 3p
1568: .Pq Perl libraries ,
1569: .Ar 4
1570: .Pq devices ,
1571: .Ar 5
1572: .Pq file formats ,
1573: .Ar 6
1574: .Pq games ,
1575: .Ar 7
1576: .Pq miscellaneous ,
1577: .Ar 8
1578: .Pq system utilities ,
1579: .Ar 9
1580: .Pq kernel functions ,
1581: .Ar X11
1582: .Pq X Window System ,
1583: .Ar X11R6
1584: .Pq X Window System ,
1585: .Ar unass
1586: .Pq unassociated ,
1587: .Ar local
1588: .Pq local system ,
1589: .Ar draft
1590: .Pq draft manual ,
1591: or
1592: .Ar paper
1593: .Pq paper .
1.111 kristaps 1594: It should correspond to the manual's filename suffix and defaults to
1.138 kristaps 1595: .Dq 1
1.111 kristaps 1596: if unspecified.
1.141 kristaps 1597: .It Ar volume
1.66 kristaps 1598: This overrides the volume inferred from
1599: .Ar section .
1600: This field is optional, and if specified, must be one of
1601: .Ar USD
1602: .Pq users' supplementary documents ,
1603: .Ar PS1
1604: .Pq programmers' supplementary documents ,
1605: .Ar AMD
1606: .Pq administrators' supplementary documents ,
1607: .Ar SMM
1608: .Pq system managers' manuals ,
1609: .Ar URM
1610: .Pq users' reference manuals ,
1611: .Ar PRM
1612: .Pq programmers' reference manuals ,
1613: .Ar KM
1614: .Pq kernel manuals ,
1615: .Ar IND
1616: .Pq master index ,
1617: .Ar MMI
1618: .Pq master index ,
1619: .Ar LOCAL
1620: .Pq local manuals ,
1621: .Ar LOC
1622: .Pq local manuals ,
1623: or
1624: .Ar CON
1625: .Pq contributed manuals .
1.141 kristaps 1626: .It Ar arch
1.100 kristaps 1627: This specifies a specific relevant architecture.
1628: If
1.141 kristaps 1629: .Ar volume
1.66 kristaps 1630: is not provided, it may be used in its place, else it may be used
1.100 kristaps 1631: subsequent that.
1632: It, too, is optional.
1633: It must be one of
1.66 kristaps 1634: .Ar alpha ,
1635: .Ar amd64 ,
1636: .Ar amiga ,
1637: .Ar arc ,
1638: .Ar arm ,
1639: .Ar armish ,
1640: .Ar aviion ,
1641: .Ar hp300 ,
1642: .Ar hppa ,
1643: .Ar hppa64 ,
1644: .Ar i386 ,
1645: .Ar landisk ,
1.86 kristaps 1646: .Ar loongson ,
1.66 kristaps 1647: .Ar luna88k ,
1648: .Ar mac68k ,
1649: .Ar macppc ,
1.160 kristaps 1650: .Ar mips64 ,
1.66 kristaps 1651: .Ar mvme68k ,
1652: .Ar mvme88k ,
1653: .Ar mvmeppc ,
1654: .Ar pmax ,
1655: .Ar sgi ,
1656: .Ar socppc ,
1657: .Ar sparc ,
1658: .Ar sparc64 ,
1659: .Ar sun3 ,
1660: .Ar vax ,
1661: or
1662: .Ar zaurus .
1663: .El
1664: .Pp
1665: Examples:
1.91 kristaps 1666: .D1 \&.Dt FOO 1
1667: .D1 \&.Dt FOO 4 KM
1668: .D1 \&.Dt FOO 9 i386
1.66 kristaps 1669: .Pp
1670: See also
1671: .Sx \&Dd
1672: and
1673: .Sx \&Os .
1.63 kristaps 1674: .Ss \&Dv
1.66 kristaps 1675: Defined variables such as preprocessor constants.
1676: .Pp
1677: Examples:
1.91 kristaps 1678: .D1 \&.Dv BUFSIZ
1679: .D1 \&.Dv STDOUT_FILENO
1.66 kristaps 1680: .Pp
1681: See also
1682: .Sx \&Er .
1.63 kristaps 1683: .Ss \&Dx
1.71 kristaps 1684: Format the DragonFly BSD version provided as an argument, or a default
1.66 kristaps 1685: value if no argument is provided.
1686: .Pp
1687: Examples:
1.91 kristaps 1688: .D1 \&.Dx 2.4.1
1689: .D1 \&.Dx
1.66 kristaps 1690: .Pp
1691: See also
1692: .Sx \&At ,
1693: .Sx \&Bsx ,
1694: .Sx \&Bx ,
1695: .Sx \&Fx ,
1696: .Sx \&Nx ,
1697: .Sx \&Ox ,
1698: and
1699: .Sx \&Ux .
1.63 kristaps 1700: .Ss \&Ec
1.131 kristaps 1701: Close a scope started by
1702: .Sx \&Eo .
1703: Its syntax is as follows:
1704: .Pp
1.141 kristaps 1705: .D1 Pf \. Sx \&Ec Op Ar TERM
1.131 kristaps 1706: .Pp
1707: The
1.141 kristaps 1708: .Ar TERM
1.131 kristaps 1709: argument is used as the enclosure tail, for example, specifying \e(rq
1710: will emulate
1711: .Sx \&Dc .
1.63 kristaps 1712: .Ss \&Ed
1.131 kristaps 1713: End a display context started by
1714: .Sx \&Bd .
1.63 kristaps 1715: .Ss \&Ef
1.141 kristaps 1716: End a font mode context started by
1.129 kristaps 1717: .Sx \&Bf .
1.63 kristaps 1718: .Ss \&Ek
1.141 kristaps 1719: End a keep context started by
1.127 schwarze 1720: .Sx \&Bk .
1.63 kristaps 1721: .Ss \&El
1.141 kristaps 1722: End a list context started by
1.117 kristaps 1723: .Sx \&Bl .
1724: .Pp
1725: See also
1726: .Sx \&Bl
1727: and
1728: .Sx \&It .
1.63 kristaps 1729: .Ss \&Em
1.100 kristaps 1730: Denotes text that should be emphasised.
1731: Note that this is a presentation term and should not be used for
1732: stylistically decorating technical terms.
1.66 kristaps 1733: .Pp
1734: Examples:
1.91 kristaps 1735: .D1 \&.Em Warnings!
1736: .D1 \&.Em Remarks :
1.138 kristaps 1737: .Pp
1738: See also
1739: .Sx \&Bf ,
1740: .Sx \&Sy ,
1741: and
1742: .Sx \&Li .
1.63 kristaps 1743: .Ss \&En
1.141 kristaps 1744: This macro is obsolete and not implemented in
1745: .Xr mandoc 1 .
1.63 kristaps 1746: .Ss \&Eo
1.131 kristaps 1747: An arbitrary enclosure.
1748: Its syntax is as follows:
1749: .Pp
1.141 kristaps 1750: .D1 Pf \. Sx \&Eo Op Ar TERM
1.131 kristaps 1751: .Pp
1752: The
1.141 kristaps 1753: .Ar TERM
1.131 kristaps 1754: argument is used as the enclosure head, for example, specifying \e(lq
1755: will emulate
1756: .Sx \&Do .
1.63 kristaps 1757: .Ss \&Er
1.90 kristaps 1758: Display error constants.
1.66 kristaps 1759: .Pp
1760: Examples:
1.91 kristaps 1761: .D1 \&.Er EPERM
1762: .D1 \&.Er ENOENT
1.66 kristaps 1763: .Pp
1764: See also
1765: .Sx \&Dv .
1.63 kristaps 1766: .Ss \&Es
1.132 kristaps 1767: This macro is obsolete and not implemented.
1.63 kristaps 1768: .Ss \&Ev
1.66 kristaps 1769: Environmental variables such as those specified in
1770: .Xr environ 7 .
1771: .Pp
1772: Examples:
1.91 kristaps 1773: .D1 \&.Ev DISPLAY
1774: .D1 \&.Ev PATH
1.63 kristaps 1775: .Ss \&Ex
1.141 kristaps 1776: Insert a standard sentence regarding exit values.
1777: Its syntax is as follows:
1778: .Pp
1779: .D1 Pf \. Sx \&Ex Fl std Op Ar utility
1780: .Pp
1781: When
1.66 kristaps 1782: .Ar utility
1.141 kristaps 1783: is not specified, the document's name set by
1.66 kristaps 1784: .Sx \&Nm
1.141 kristaps 1785: is used.
1.139 kristaps 1786: .Pp
1787: See also
1788: .Sx \&Rv .
1.63 kristaps 1789: .Ss \&Fa
1.117 kristaps 1790: Function argument.
1.120 kristaps 1791: Its syntax is as follows:
1792: .Bd -ragged -offset indent
1793: .Pf \. Sx \&Fa
1794: .Op Cm argtype
1795: .Cm argname
1796: .Ed
1797: .Pp
1.117 kristaps 1798: This may be invoked for names with or without the corresponding type.
1799: It is also used to specify the field name of a structure.
1800: Most often, the
1801: .Sx \&Fa
1802: macro is used in the
1803: .Em SYNOPSIS
1.120 kristaps 1804: within
1805: .Sx \&Fo
1.117 kristaps 1806: section when documenting multi-line function prototypes.
1807: If invoked with multiple arguments, the arguments are separated by a
1808: comma.
1809: Furthermore, if the following macro is another
1810: .Sx \&Fa ,
1811: the last argument will also have a trailing comma.
1812: .Pp
1813: Examples:
1814: .D1 \&.Fa \(dqconst char *p\(dq
1815: .D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
1816: .D1 \&.Fa foo
1.120 kristaps 1817: .Pp
1818: See also
1819: .Sx \&Fo .
1.63 kristaps 1820: .Ss \&Fc
1.141 kristaps 1821: End a function context started by
1.131 kristaps 1822: .Sx \&Fo .
1.63 kristaps 1823: .Ss \&Fd
1.117 kristaps 1824: Historically used to document include files.
1825: This usage has been deprecated in favour of
1826: .Sx \&In .
1827: Do not use this macro.
1828: .Pp
1829: See also
1.122 kristaps 1830: .Sx MANUAL STRUCTURE
1831: and
1.117 kristaps 1832: .Sx \&In .
1.63 kristaps 1833: .Ss \&Fl
1.100 kristaps 1834: Command-line flag.
1835: Used when listing arguments to command-line utilities.
1836: Prints a fixed-width hyphen
1.79 kristaps 1837: .Sq \-
1.100 kristaps 1838: directly followed by each argument.
1839: If no arguments are provided, a hyphen is printed followed by a space.
1840: If the argument is a macro, a hyphen is prefixed to the subsequent macro
1841: output.
1.79 kristaps 1842: .Pp
1843: Examples:
1.91 kristaps 1844: .D1 \&.Fl a b c
1845: .D1 \&.Fl \&Pf a b
1846: .D1 \&.Fl
1847: .D1 \&.Op \&Fl o \&Ns \&Ar file
1.79 kristaps 1848: .Pp
1849: See also
1850: .Sx \&Cm .
1.63 kristaps 1851: .Ss \&Fn
1.119 kristaps 1852: A function name.
1.120 kristaps 1853: Its syntax is as follows:
1.119 kristaps 1854: .Bd -ragged -offset indent
1855: .Pf \. Ns Sx \&Fn
1856: .Op Cm functype
1857: .Cm funcname
1858: .Op Oo Cm argtype Oc Cm argname
1859: .Ed
1.120 kristaps 1860: .Pp
1.122 kristaps 1861: Function arguments are surrounded in parenthesis and
1.119 kristaps 1862: are delimited by commas.
1863: If no arguments are specified, blank parenthesis are output.
1864: .Pp
1865: Examples:
1866: .D1 \&.Fn "int funcname" "int arg0" "int arg1"
1867: .D1 \&.Fn funcname "int arg0"
1868: .D1 \&.Fn funcname arg0
1.120 kristaps 1869: .Bd -literal -offset indent -compact
1870: \&.Ft functype
1871: \&.Fn funcname
1872: .Ed
1.119 kristaps 1873: .Pp
1.163 schwarze 1874: When referring to a function documented in another manual page, use
1.162 schwarze 1875: .Sx \&Xr
1.163 schwarze 1876: instead.
1.119 kristaps 1877: See also
1.122 kristaps 1878: .Sx MANUAL STRUCTURE
1.119 kristaps 1879: and
1880: .Sx \&Ft .
1.63 kristaps 1881: .Ss \&Fo
1.120 kristaps 1882: Begin a function block.
1883: This is a multi-line version of
1884: .Sx \&Fn .
1885: Its syntax is as follows:
1886: .Pp
1887: .D1 Pf \. Sx \&Fo Cm funcname
1888: .Pp
1889: Invocations usually occur in the following context:
1890: .Bd -ragged -offset indent
1891: .Pf \. Sx \&Ft Cm functype
1892: .br
1893: .Pf \. Sx \&Fo Cm funcname
1894: .br
1895: .Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname
1896: .br
1897: \.\.\.
1898: .br
1899: .Pf \. Sx \&Fc
1900: .Ed
1901: .Pp
1902: A
1903: .Sx \&Fo
1904: scope is closed by
1905: .Pp
1906: See also
1.122 kristaps 1907: .Sx MANUAL STRUCTURE ,
1.120 kristaps 1908: .Sx \&Fa ,
1909: .Sx \&Fc ,
1910: and
1.139 kristaps 1911: .Sx \&Ft .
1.63 kristaps 1912: .Ss \&Ft
1.120 kristaps 1913: A function type.
1914: Its syntax is as follows:
1915: .Pp
1916: .D1 Pf \. Sx \&Ft Cm functype
1917: .Pp
1918: Examples:
1919: .D1 \&.Ft int
1920: .Bd -literal -offset indent -compact
1921: \&.Ft functype
1922: \&.Fn funcname
1923: .Ed
1924: .Pp
1925: See also
1.122 kristaps 1926: .Sx MANUAL STRUCTURE ,
1927: .Sx \&Fn ,
1.120 kristaps 1928: and
1.122 kristaps 1929: .Sx \&Fo .
1.63 kristaps 1930: .Ss \&Fx
1.144 schwarze 1931: Format the
1932: .Fx
1933: version provided as an argument, or a default value
1.65 kristaps 1934: if no argument is provided.
1935: .Pp
1936: Examples:
1.91 kristaps 1937: .D1 \&.Fx 7.1
1938: .D1 \&.Fx
1.65 kristaps 1939: .Pp
1940: See also
1941: .Sx \&At ,
1.66 kristaps 1942: .Sx \&Bsx ,
1.65 kristaps 1943: .Sx \&Bx ,
1.66 kristaps 1944: .Sx \&Dx ,
1.65 kristaps 1945: .Sx \&Nx ,
1946: .Sx \&Ox ,
1947: and
1948: .Sx \&Ux .
1.63 kristaps 1949: .Ss \&Hf
1.132 kristaps 1950: This macro is obsolete and not implemented.
1.63 kristaps 1951: .Ss \&Ic
1.132 kristaps 1952: Designate an internal or interactive command.
1953: This is similar to
1954: .Sx \&Cm
1955: but used for instructions rather than values.
1956: .Pp
1957: Examples:
1958: .D1 \&.Ic hash
1959: .D1 \&.Ic alias
1960: .Pp
1961: Note that using
1.144 schwarze 1962: .Sx \&Bd Fl literal
1.132 kristaps 1963: or
1964: .Sx \&D1
1965: is preferred for displaying code; the
1966: .Sx \&Ic
1967: macro is used when referring to specific instructions.
1.63 kristaps 1968: .Ss \&In
1.118 kristaps 1969: An
1.138 kristaps 1970: .Dq include
1.118 kristaps 1971: file.
1972: In the
1973: .Em SYNOPSIS
1974: section (only if invoked as the line macro), the first argument is
1975: preceded by
1.138 kristaps 1976: .Dq #include ,
1.141 kristaps 1977: the arguments is enclosed in angle brackets.
1.118 kristaps 1978: .Pp
1.122 kristaps 1979: Examples:
1.118 kristaps 1980: .D1 \&.In sys/types
1.122 kristaps 1981: .Pp
1982: See also
1983: .Sx MANUAL STRUCTURE .
1.63 kristaps 1984: .Ss \&It
1.120 kristaps 1985: A list item.
1986: The syntax of this macro depends on the list type.
1.114 kristaps 1987: .Pp
1988: Lists
1989: of type
1990: .Fl hang ,
1991: .Fl ohang ,
1992: .Fl inset ,
1993: and
1994: .Fl diag
1.120 kristaps 1995: have the following syntax:
1.114 kristaps 1996: .Pp
1.120 kristaps 1997: .D1 Pf \. Sx \&It Cm args
1.114 kristaps 1998: .Pp
1999: Lists of type
2000: .Fl bullet ,
2001: .Fl dash ,
2002: .Fl enum ,
2003: .Fl hyphen
2004: and
2005: .Fl item
1.120 kristaps 2006: have the following syntax:
1.114 kristaps 2007: .Pp
1.120 kristaps 2008: .D1 Pf \. Sx \&It
1.114 kristaps 2009: .Pp
2010: with subsequent lines interpreted within the scope of the
2011: .Sx \&It
2012: until either a closing
2013: .Sx \&El
2014: or another
2015: .Sx \&It .
2016: .Pp
2017: The
2018: .Fl tag
1.120 kristaps 2019: list has the following syntax:
1.114 kristaps 2020: .Pp
1.120 kristaps 2021: .D1 Pf \. Sx \&It Op Cm args
1.114 kristaps 2022: .Pp
1.120 kristaps 2023: Subsequent lines are interpreted as with
1.114 kristaps 2024: .Fl bullet
2025: and family.
2026: The line arguments correspond to the list's left-hand side; body
2027: arguments correspond to the list's contents.
2028: .Pp
2029: The
2030: .Fl column
2031: list is the most complicated.
1.120 kristaps 2032: Its syntax is as follows:
1.114 kristaps 2033: .Pp
1.120 kristaps 2034: .D1 Pf \. Sx \&It Op Cm args
1.114 kristaps 2035: .Pp
1.120 kristaps 2036: The
1.114 kristaps 2037: .Cm args
2038: are phrases, a mix of macros and text corresponding to a line column,
2039: delimited by tabs or the special
2040: .Sq \&Ta
2041: pseudo-macro.
2042: Lines subsequent the
2043: .Sx \&It
2044: are interpreted within the scope of the last phrase.
2045: Calling the pseudo-macro
2046: .Sq \&Ta
2047: will open a new phrase scope (this must occur on a macro line to be
1.138 kristaps 2048: interpreted as a macro).
2049: Note that the tab phrase delimiter may only be used within the
1.114 kristaps 2050: .Sx \&It
2051: line itself.
2052: Subsequent this, only the
2053: .Sq \&Ta
2054: pseudo-macro may be used to delimit phrases.
1.124 kristaps 2055: Furthermore, note that quoted sections propagate over tab-delimited
1.114 kristaps 2056: phrases on an
2057: .Sx \&It ,
2058: for example,
2059: .Pp
1.121 kristaps 2060: .D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
1.114 kristaps 2061: .Pp
2062: will preserve the semicolon whitespace except for the last.
2063: .Pp
2064: See also
2065: .Sx \&Bl .
1.63 kristaps 2066: .Ss \&Lb
1.109 kristaps 2067: Specify a library.
1.120 kristaps 2068: The syntax is as follows:
1.109 kristaps 2069: .Pp
1.120 kristaps 2070: .D1 Pf \. Sx \&Lb Cm library
1.109 kristaps 2071: .Pp
2072: The
2073: .Cm library
2074: parameter may be a system library, such as
2075: .Cm libz
2076: or
2077: .Cm libpam ,
2078: in which case a small library description is printed next to the linker
2079: invocation; or a custom library, in which case the library name is
2080: printed in quotes.
2081: This is most commonly used in the
2082: .Em SYNOPSIS
2083: section as described in
2084: .Sx MANUAL STRUCTURE .
2085: .Pp
2086: Examples:
2087: .D1 \&.Lb libz
2088: .D1 \&.Lb mdoc
1.63 kristaps 2089: .Ss \&Li
1.131 kristaps 2090: Denotes text that should be in a literal font mode.
2091: Note that this is a presentation term and should not be used for
2092: stylistically decorating technical terms.
1.138 kristaps 2093: .Pp
2094: See also
2095: .Sx \&Bf ,
2096: .Sx \&Sy ,
2097: and
2098: .Sx \&Em .
1.63 kristaps 2099: .Ss \&Lk
1.100 kristaps 2100: Format a hyperlink.
1.120 kristaps 2101: Its syntax is as follows:
1.70 kristaps 2102: .Pp
1.120 kristaps 2103: .D1 Pf \. Sx \&Lk Cm uri Op Cm name
1.70 kristaps 2104: .Pp
2105: Examples:
1.149 kristaps 2106: .D1 \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q
1.91 kristaps 2107: .D1 \&.Lk http://bsd.lv
1.70 kristaps 2108: .Pp
2109: See also
2110: .Sx \&Mt .
1.63 kristaps 2111: .Ss \&Lp
1.132 kristaps 2112: Synonym for
2113: .Sx \&Pp .
1.63 kristaps 2114: .Ss \&Ms
1.138 kristaps 2115: Display a mathematical symbol.
1.140 kristaps 2116: Its syntax is as follows:
2117: .Pp
2118: .D1 Pf \. Sx \&Ms Cm symbol
1.138 kristaps 2119: .Pp
2120: Examples:
2121: .D1 \&.Ms sigma
2122: .D1 \&.Ms aleph
1.63 kristaps 2123: .Ss \&Mt
1.116 kristaps 2124: Format a
1.138 kristaps 2125: .Dq mailto:
1.116 kristaps 2126: hyperlink.
1.164 kristaps 2127: If an argument is not provided, the string
2128: .Dq \(ti
2129: is used as a default.
1.120 kristaps 2130: Its syntax is as follows:
1.116 kristaps 2131: .Pp
1.120 kristaps 2132: .D1 Pf \. Sx \&Mt Cm address
1.116 kristaps 2133: .Pp
2134: Examples:
2135: .D1 \&.Mt discuss@manpages.bsd.lv
1.63 kristaps 2136: .Ss \&Nd
1.144 schwarze 2137: A one line description of the manual's content.
1.132 kristaps 2138: This may only be invoked in the
2139: .Em SYNOPSIS
2140: section subsequent the
2141: .Sx \&Nm
2142: macro.
2143: .Pp
2144: Examples:
2145: .D1 \&.Sx \&Nd mdoc language reference
2146: .D1 \&.Sx \&Nd format and display UNIX manuals
2147: .Pp
2148: The
2149: .Sx \&Nd
2150: macro technically accepts child macros and terminates with a subsequent
2151: .Sx \&Sh
2152: invocation.
2153: Do not assume this behaviour: some
2154: .Xr whatis 1
2155: database generators are not smart enough to parse more than the line
2156: arguments and will display macros verbatim.
2157: .Pp
2158: See also
2159: .Sx \&Nm .
1.63 kristaps 2160: .Ss \&Nm
1.128 schwarze 2161: The name of the manual page, or \(em in particular in section 1, 6,
2162: and 8 pages \(em of an additional command or feature documented in
2163: the manual page.
2164: When first invoked, the
2165: .Sx \&Nm
2166: macro expects a single argument, the name of the manual page.
2167: Usually, the first invocation happens in the
2168: .Em NAME
2169: section of the page.
2170: The specified name will be remembered and used whenever the macro is
2171: called again without arguments later in the page.
2172: The
2173: .Sx \&Nm
2174: macro uses
2175: .Sx Block full-implicit
2176: semantics when invoked as the first macro on an input line in the
2177: .Em SYNOPSIS
2178: section; otherwise, it uses ordinary
2179: .Sx In-line
2180: semantics.
2181: .Pp
2182: Examples:
2183: .Bd -literal -offset indent
2184: \&.Sh SYNOPSIS
2185: \&.Nm cat
2186: \&.Op Fl benstuv
2187: \&.Op Ar
2188: .Ed
2189: .Pp
2190: In the
2191: .Em SYNOPSIS
2192: of section 2, 3 and 9 manual pages, use the
2193: .Sx \&Fn
2194: macro rather than
2195: .Sx \&Nm
2196: to mark up the name of the manual page.
1.63 kristaps 2197: .Ss \&No
1.132 kristaps 2198: A
1.138 kristaps 2199: .Dq noop
1.132 kristaps 2200: macro used to terminate prior macro contexts.
2201: .Pp
2202: Examples:
2203: .D1 \&.Sx \&Fl ab \&No cd \&Fl ef
1.63 kristaps 2204: .Ss \&Ns
1.138 kristaps 2205: Suppress a space.
2206: Following invocation, text is interpreted as free-form text until a
2207: macro is encountered.
2208: .Pp
2209: Examples:
2210: .D1 \&.Fl o \&Ns \&Ar output
2211: .Pp
2212: See also
2213: .Sx \&No
2214: and
2215: .Sx \&Sm .
1.63 kristaps 2216: .Ss \&Nx
1.144 schwarze 2217: Format the
2218: .Nx
2219: version provided as an argument, or a default value if
1.65 kristaps 2220: no argument is provided.
2221: .Pp
2222: Examples:
1.91 kristaps 2223: .D1 \&.Nx 5.01
2224: .D1 \&.Nx
1.65 kristaps 2225: .Pp
2226: See also
2227: .Sx \&At ,
1.66 kristaps 2228: .Sx \&Bsx ,
1.65 kristaps 2229: .Sx \&Bx ,
1.66 kristaps 2230: .Sx \&Dx ,
1.65 kristaps 2231: .Sx \&Fx ,
2232: .Sx \&Ox ,
2233: and
2234: .Sx \&Ux .
1.63 kristaps 2235: .Ss \&Oc
1.141 kristaps 2236: Close multi-line
1.132 kristaps 2237: .Sx \&Oo
2238: context.
1.63 kristaps 2239: .Ss \&Oo
1.132 kristaps 2240: Multi-line version of
2241: .Sx \&Op .
2242: .Pp
2243: Examples:
1.138 kristaps 2244: .Bd -literal -offset indent -compact
1.132 kristaps 2245: \&.Oo
2246: \&.Op Fl flag Ns Ar value
2247: \&.Oc
2248: .Ed
1.63 kristaps 2249: .Ss \&Op
1.132 kristaps 2250: Command-line option.
2251: Used when listing options to command-line utilities.
2252: Prints the argument(s) in brackets.
2253: .Pp
2254: Examples:
2255: .D1 \&.Op \&Fl a \&Ar b
2256: .D1 \&.Op \&Ar a | b
2257: .Pp
2258: See also
2259: .Sx \&Oo .
1.63 kristaps 2260: .Ss \&Os
1.100 kristaps 2261: Document operating system version.
2262: This is the mandatory third macro of
1.66 kristaps 2263: any
2264: .Nm
1.120 kristaps 2265: file.
2266: Its syntax is as follows:
1.66 kristaps 2267: .Pp
1.143 schwarze 2268: .D1 Pf \. Sx \&Os Op Cm system Op Cm version
1.66 kristaps 2269: .Pp
2270: The optional
2271: .Cm system
1.100 kristaps 2272: parameter specifies the relevant operating system or environment.
2273: Left unspecified, it defaults to the local operating system version.
2274: This is the suggested form.
1.66 kristaps 2275: .Pp
2276: Examples:
1.91 kristaps 2277: .D1 \&.Os
2278: .D1 \&.Os KTH/CSC/TCS
2279: .D1 \&.Os BSD 4.3
1.66 kristaps 2280: .Pp
2281: See also
2282: .Sx \&Dd
2283: and
2284: .Sx \&Dt .
1.63 kristaps 2285: .Ss \&Ot
1.66 kristaps 2286: Unknown usage.
2287: .Pp
2288: .Em Remarks :
2289: this macro has been deprecated.
1.63 kristaps 2290: .Ss \&Ox
1.144 schwarze 2291: Format the
2292: .Ox
2293: version provided as an argument, or a default value
1.65 kristaps 2294: if no argument is provided.
2295: .Pp
2296: Examples:
1.91 kristaps 2297: .D1 \&.Ox 4.5
2298: .D1 \&.Ox
1.65 kristaps 2299: .Pp
2300: See also
2301: .Sx \&At ,
2302: .Sx \&Bsx ,
2303: .Sx \&Bx ,
1.66 kristaps 2304: .Sx \&Dx ,
1.65 kristaps 2305: .Sx \&Fx ,
2306: .Sx \&Nx ,
2307: and
2308: .Sx \&Ux .
1.63 kristaps 2309: .Ss \&Pa
1.132 kristaps 2310: A file-system path.
1.165 ! kristaps 2311: If an argument is not provided, the string
! 2312: .Dq \(ti
! 2313: is used as a default.
1.132 kristaps 2314: .Pp
2315: Examples:
2316: .D1 \&.Pa /usr/bin/mandoc
2317: .D1 \&.Pa /usr/share/man/man7/mdoc.7
2318: .Pp
2319: See also
2320: .Sx \&Lk .
1.63 kristaps 2321: .Ss \&Pc
1.132 kristaps 2322: Close parenthesised context opened by
2323: .Sx \&Po .
1.63 kristaps 2324: .Ss \&Pf
1.132 kristaps 2325: Removes the space
1.138 kristaps 2326: .Pq Dq prefix
1.132 kristaps 2327: between its arguments.
2328: Its syntax is as follows:
2329: .Pp
2330: .D1 Pf \. \&Pf Cm prefix suffix
2331: .Pp
2332: The
2333: .Cm suffix
2334: argument may be a macro.
2335: .Pp
2336: Examples:
2337: .D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix
1.63 kristaps 2338: .Ss \&Po
1.132 kristaps 2339: Multi-line version of
2340: .Sx \&Pq .
1.63 kristaps 2341: .Ss \&Pp
1.132 kristaps 2342: Break a paragraph.
2343: This will assert vertical space between prior and subsequent macros
2344: and/or text.
1.63 kristaps 2345: .Ss \&Pq
1.132 kristaps 2346: Parenthesised enclosure.
2347: .Pp
2348: See also
2349: .Sx \&Po .
1.63 kristaps 2350: .Ss \&Qc
1.138 kristaps 2351: Close quoted context opened by
2352: .Sx \&Qo .
1.63 kristaps 2353: .Ss \&Ql
1.138 kristaps 2354: Format a single-quoted literal.
2355: See also
2356: .Sx \&Qq
2357: and
2358: .Sx \&Sq .
1.63 kristaps 2359: .Ss \&Qo
1.138 kristaps 2360: Multi-line version of
2361: .Sx \&Qq .
1.63 kristaps 2362: .Ss \&Qq
1.138 kristaps 2363: Encloses its arguments in
2364: .Dq typewriter
2365: double-quotes.
2366: Consider using
2367: .Sx \&Dq .
2368: .Pp
2369: See also
2370: .Sx \&Dq ,
2371: .Sx \&Sq ,
2372: and
2373: .Sx \&Qo .
1.63 kristaps 2374: .Ss \&Re
1.141 kristaps 2375: Close an
1.63 kristaps 2376: .Sx \&Rs
1.100 kristaps 2377: block.
2378: Does not have any tail arguments.
1.63 kristaps 2379: .Ss \&Rs
1.141 kristaps 2380: Begin a bibliographic
1.63 kristaps 2381: .Pq Dq reference
1.100 kristaps 2382: block.
2383: Does not have any head arguments.
2384: The block macro may only contain
1.63 kristaps 2385: .Sx \&%A ,
2386: .Sx \&%B ,
2387: .Sx \&%C ,
2388: .Sx \&%D ,
2389: .Sx \&%I ,
2390: .Sx \&%J ,
2391: .Sx \&%N ,
2392: .Sx \&%O ,
2393: .Sx \&%P ,
2394: .Sx \&%Q ,
2395: .Sx \&%R ,
2396: .Sx \&%T ,
1.120 kristaps 2397: .Sx \&%U ,
1.63 kristaps 2398: and
2399: .Sx \&%V
2400: child macros (at least one must be specified).
2401: .Pp
1.64 kristaps 2402: Examples:
1.91 kristaps 2403: .Bd -literal -offset indent -compact
1.63 kristaps 2404: \&.Rs
2405: \&.%A J. E. Hopcroft
2406: \&.%A J. D. Ullman
2407: \&.%B Introduction to Automata Theory, Languages, and Computation
2408: \&.%I Addison-Wesley
2409: \&.%C Reading, Massachusettes
2410: \&.%D 1979
2411: \&.Re
2412: .Ed
2413: .Pp
2414: If an
2415: .Sx \&Rs
2416: block is used within a SEE ALSO section, a vertical space is asserted
2417: before the rendered output, else the block continues on the current
2418: line.
2419: .Ss \&Rv
1.139 kristaps 2420: Inserts text regarding a function call's return value.
2421: This macro must consist of the
2422: .Fl std
2423: argument followed by an optional
2424: .Ar function .
2425: If
2426: .Ar function
2427: is not provided, the document's name as stipulated by the first
2428: .Sx \&Nm
2429: is provided.
2430: .Pp
2431: See also
2432: .Sx \&Ex .
1.63 kristaps 2433: .Ss \&Sc
1.138 kristaps 2434: Close single-quoted context opened by
2435: .Sx \&So .
1.63 kristaps 2436: .Ss \&Sh
1.138 kristaps 2437: Begin a new section.
2438: For a list of conventional manual sections, see
2439: .Sx MANUAL STRUCTURE .
2440: These sections should be used unless it's absolutely necessary that
2441: custom sections be used.
2442: .Pp
2443: Section names should be unique so that they may be keyed by
2444: .Sx \&Sx .
2445: .Pp
2446: See also
2447: .Sx \&Pp ,
2448: .Sx \&Ss ,
2449: and
2450: .Sx \&Sx .
1.63 kristaps 2451: .Ss \&Sm
1.134 schwarze 2452: Switches the spacing mode for output generated from macros.
2453: Its syntax is as follows:
2454: .Pp
2455: .D1 Pf \. Sx \&Sm Cm on | off
2456: .Pp
2457: By default, spacing is
2458: .Cm on .
2459: When switched
2460: .Cm off ,
2461: no white space is inserted between macro arguments and between the
2462: output generated from adjacent macros, but free-form text lines
2463: still get normal spacing between words and sentences.
1.63 kristaps 2464: .Ss \&So
1.138 kristaps 2465: Multi-line version of
2466: .Sx \&Sq .
1.63 kristaps 2467: .Ss \&Sq
1.138 kristaps 2468: Encloses its arguments in
2469: .Dq typewriter
2470: single-quotes.
2471: .Pp
2472: See also
2473: .Sx \&Dq ,
2474: .Sx \&Qq ,
2475: and
2476: .Sx \&So .
1.63 kristaps 2477: .Ss \&Ss
1.138 kristaps 2478: Begin a new sub-section.
2479: Unlike with
2480: .Sx \&Sh ,
2481: there's no convention for sub-sections.
2482: Conventional sections, as described in
2483: .Sx MANUAL STRUCTURE ,
2484: rarely have sub-sections.
2485: .Pp
2486: Sub-section names should be unique so that they may be keyed by
2487: .Sx \&Sx .
2488: .Pp
2489: See also
2490: .Sx \&Pp ,
2491: .Sx \&Sh ,
2492: and
2493: .Sx \&Sx .
1.63 kristaps 2494: .Ss \&St
1.139 kristaps 2495: Replace an abbreviation for a standard with the full form.
2496: The following standards are recognised:
2497: .Pp
2498: .Bl -tag -width "-p1003.1g-2000X" -compact
2499: .It \-p1003.1-88
2500: .St -p1003.1-88
2501: .It \-p1003.1-90
2502: .St -p1003.1-90
2503: .It \-p1003.1-96
2504: .St -p1003.1-96
2505: .It \-p1003.1-2001
2506: .St -p1003.1-2001
2507: .It \-p1003.1-2004
2508: .St -p1003.1-2004
2509: .It \-p1003.1-2008
2510: .St -p1003.1-2008
2511: .It \-p1003.1
2512: .St -p1003.1
2513: .It \-p1003.1b
2514: .St -p1003.1b
2515: .It \-p1003.1b-93
2516: .St -p1003.1b-93
2517: .It \-p1003.1c-95
2518: .St -p1003.1c-95
2519: .It \-p1003.1g-2000
2520: .St -p1003.1g-2000
2521: .It \-p1003.1i-95
2522: .St -p1003.1i-95
2523: .It \-p1003.2-92
2524: .St -p1003.2-92
2525: .It \-p1003.2a-92
2526: .St -p1003.2a-92
2527: .It \-p1387.2-95
2528: .St -p1387.2-95
2529: .It \-p1003.2
2530: .St -p1003.2
2531: .It \-p1387.2
2532: .St -p1387.2
2533: .It \-isoC
2534: .St -isoC
2535: .It \-isoC-90
2536: .St -isoC-90
2537: .It \-isoC-amd1
2538: .St -isoC-amd1
2539: .It \-isoC-tcor1
2540: .St -isoC-tcor1
2541: .It \-isoC-tcor2
2542: .St -isoC-tcor2
2543: .It \-isoC-99
2544: .St -isoC-99
2545: .It \-iso9945-1-90
2546: .St -iso9945-1-90
2547: .It \-iso9945-1-96
2548: .St -iso9945-1-96
2549: .It \-iso9945-2-93
2550: .St -iso9945-2-93
2551: .It \-ansiC
2552: .St -ansiC
2553: .It \-ansiC-89
2554: .St -ansiC-89
2555: .It \-ansiC-99
2556: .St -ansiC-99
2557: .It \-ieee754
2558: .St -ieee754
2559: .It \-iso8802-3
2560: .St -iso8802-3
2561: .It \-ieee1275-94
2562: .St -ieee1275-94
2563: .It \-xpg3
2564: .St -xpg3
2565: .It \-xpg4
2566: .St -xpg4
2567: .It \-xpg4.2
2568: .St -xpg4.2
2569: .St -xpg4.3
2570: .It \-xbd5
2571: .St -xbd5
2572: .It \-xcu5
2573: .St -xcu5
2574: .It \-xsh5
2575: .St -xsh5
2576: .It \-xns5
2577: .St -xns5
2578: .It \-xns5.2
2579: .St -xns5.2
2580: .It \-xns5.2d2.0
2581: .St -xns5.2d2.0
2582: .It \-xcurses4.2
2583: .St -xcurses4.2
2584: .It \-susv2
2585: .St -susv2
2586: .It \-susv3
2587: .St -susv3
2588: .It \-svid4
2589: .St -svid4
2590: .El
1.63 kristaps 2591: .Ss \&Sx
1.138 kristaps 2592: Reference a section or sub-section.
2593: The referenced section or sub-section name must be identical to the
2594: enclosed argument, including whitespace.
2595: .Pp
2596: Examples:
2597: .D1 \&.Sx MANUAL STRUCTURE
1.63 kristaps 2598: .Ss \&Sy
1.138 kristaps 2599: Format enclosed arguments in symbolic
2600: .Pq Dq boldface .
2601: Note that this is a presentation term and should not be used for
2602: stylistically decorating technical terms.
2603: .Pp
2604: See also
2605: .Sx \&Bf ,
2606: .Sx \&Li ,
2607: and
2608: .Sx \&Em .
1.63 kristaps 2609: .Ss \&Tn
1.138 kristaps 2610: Format a tradename.
2611: .Pp
2612: Examples:
1.139 kristaps 2613: .D1 \&.Tn IBM
1.63 kristaps 2614: .Ss \&Ud
1.110 kristaps 2615: Prints out
1.144 schwarze 2616: .Dq currently under development .
1.63 kristaps 2617: .Ss \&Ux
1.100 kristaps 2618: Format the UNIX name.
2619: Accepts no argument.
1.65 kristaps 2620: .Pp
2621: Examples:
1.91 kristaps 2622: .D1 \&.Ux
1.65 kristaps 2623: .Pp
2624: See also
2625: .Sx \&At ,
1.66 kristaps 2626: .Sx \&Bsx ,
1.65 kristaps 2627: .Sx \&Bx ,
1.66 kristaps 2628: .Sx \&Dx ,
1.65 kristaps 2629: .Sx \&Fx ,
2630: .Sx \&Nx ,
2631: and
2632: .Sx \&Ox .
1.63 kristaps 2633: .Ss \&Va
1.132 kristaps 2634: A variable name.
2635: .Pp
2636: Examples:
2637: .D1 \&.Va foo
2638: .D1 \&.Va const char *bar ;
1.63 kristaps 2639: .Ss \&Vt
1.100 kristaps 2640: A variable type.
1.122 kristaps 2641: This is also used for indicating global variables in the
2642: .Em SYNOPSIS
1.100 kristaps 2643: section, in which case a variable name is also specified.
2644: Note that it accepts
1.83 kristaps 2645: .Sx Block partial-implicit
1.123 kristaps 2646: syntax when invoked as the first macro in the
1.122 kristaps 2647: .Em SYNOPSIS
2648: section, else it accepts ordinary
1.83 kristaps 2649: .Sx In-line
2650: syntax.
2651: .Pp
2652: Note that this should not be confused with
2653: .Sx \&Ft ,
2654: which is used for function return types.
2655: .Pp
2656: Examples:
1.91 kristaps 2657: .D1 \&.Vt unsigned char
1.121 kristaps 2658: .D1 \&.Vt extern const char * const sys_signame[] \&;
1.83 kristaps 2659: .Pp
2660: See also
1.122 kristaps 2661: .Sx MANUAL STRUCTURE
1.83 kristaps 2662: and
2663: .Sx \&Va .
1.84 kristaps 2664: .Ss \&Xc
1.87 kristaps 2665: Close a scope opened by
2666: .Sx \&Xo .
1.84 kristaps 2667: .Ss \&Xo
1.100 kristaps 2668: Open an extension scope.
2669: This macro originally existed to extend the 9-argument limit of troff;
2670: since this limit has been lifted, the macro has been deprecated.
1.84 kristaps 2671: .Ss \&Xr
2672: Link to another manual
2673: .Pq Qq cross-reference .
1.120 kristaps 2674: Its syntax is as follows:
1.84 kristaps 2675: .Pp
1.120 kristaps 2676: .D1 Pf \. Sx \&Xr Cm name section
1.84 kristaps 2677: .Pp
2678: The
2679: .Cm name
2680: and
2681: .Cm section
1.100 kristaps 2682: are the name and section of the linked manual.
2683: If
1.84 kristaps 2684: .Cm section
2685: is followed by non-punctuation, an
2686: .Sx \&Ns
1.100 kristaps 2687: is inserted into the token stream.
2688: This behaviour is for compatibility with
1.148 kristaps 2689: GNU troff.
1.84 kristaps 2690: .Pp
2691: Examples:
1.91 kristaps 2692: .D1 \&.Xr mandoc 1
1.121 kristaps 2693: .D1 \&.Xr mandoc 1 \&;
1.91 kristaps 2694: .D1 \&.Xr mandoc 1 \&Ns s behaviour
1.84 kristaps 2695: .Ss \&br
1.140 kristaps 2696: Emits a line-break.
2697: This macro should not be used; it is implemented for compatibility with
2698: historical manuals.
2699: .Pp
2700: Consider using
2701: .Sx \&Pp
2702: in the event of natural paragraph breaks.
1.84 kristaps 2703: .Ss \&sp
1.140 kristaps 2704: Emits vertical space.
2705: This macro should not be used; it is implemented for compatibility with
2706: historical manuals.
2707: Its syntax is as follows:
2708: .Pp
2709: .D1 Pf \. Sx \&sp Op Cm height
2710: .Pp
2711: The
2712: .Cm height
2713: argument must be formatted as described in
2714: .Sx Scaling Widths .
2715: If unspecified,
2716: .Sx \&sp
2717: asserts a single vertical space.
1.4 kristaps 2718: .Sh COMPATIBILITY
1.93 kristaps 2719: This section documents compatibility between mandoc and other other
2720: troff implementations, at this time limited to GNU troff
2721: .Pq Qq groff .
1.50 kristaps 2722: The term
1.57 kristaps 2723: .Qq historic groff
1.93 kristaps 2724: refers to groff versions before the
1.57 kristaps 2725: .Pa doc.tmac
1.50 kristaps 2726: file re-write
1.57 kristaps 2727: .Pq somewhere between 1.15 and 1.19 .
2728: .Pp
1.93 kristaps 2729: Heirloom troff, the other significant troff implementation accepting
2730: \-mdoc, is similar to historic groff.
2731: .Pp
1.150 kristaps 2732: The following problematic behaviour is found in groff:
2733: .ds hist (Historic groff only.)
2734: .Pp
1.57 kristaps 2735: .Bl -dash -compact
1.147 kristaps 2736: .It
1.150 kristaps 2737: .Sx \&At
2738: with unknown arguments produces no output at all.
2739: \*[hist]
2740: Newer groff and mandoc print
2741: .Qq AT&T UNIX
2742: and the arguments.
1.149 kristaps 2743: .It
1.150 kristaps 2744: .Sx \&Bd Fl column
2745: does not recognize trailing punctuation characters when they immediately
2746: precede tabulator characters, but treats them as normal text and
2747: outputs a space before them.
2748: .It
2749: .Sx \&Bd Fl ragged compact
2750: does not start a new line.
2751: \*[hist]
1.142 kristaps 2752: .It
1.150 kristaps 2753: .Sx \&Dd
2754: without an argument prints
1.142 kristaps 2755: .Dq Epoch .
2756: In mandoc, it resolves to the current date.
1.125 kristaps 2757: .It
1.150 kristaps 2758: .Sx \&Fl
2759: does not print a dash for an empty argument.
2760: \*[hist]
1.137 kristaps 2761: .It
1.150 kristaps 2762: .Sx \&Fn
2763: does not start a new line unless invoked as the line macro in the
2764: .Em SYNOPSIS
2765: section.
2766: \*[hist]
1.119 kristaps 2767: .It
1.150 kristaps 2768: .Sx \&Fo
2769: with
1.120 kristaps 2770: .Pf non- Sx \&Fa
1.150 kristaps 2771: children causes inconsistent spacing between arguments.
2772: In mandoc, a single space is always inserted between arguments.
1.120 kristaps 2773: .It
2774: .Sx \&Ft
2775: in the
1.150 kristaps 2776: .Em SYNOPSIS
2777: causes inconsistent vertical spacing, depending on whether a prior
1.120 kristaps 2778: .Sx \&Fn
2779: has been invoked.
2780: See
2781: .Sx \&Ft
2782: and
2783: .Sx \&Fn
1.150 kristaps 2784: for the normalised behaviour in mandoc.
1.120 kristaps 2785: .It
1.150 kristaps 2786: .Sx \&In
2787: ignores additional arguments and is not treated specially in the
2788: .Em SYNOPSIS .
2789: \*[hist]
1.118 kristaps 2790: .It
1.150 kristaps 2791: .Sx \&It
2792: sometimes requires a
2793: .Fl nested
2794: flag.
2795: \*[hist]
2796: In new groff and mandoc, any list may be nested by default and
2797: .Fl enum
2798: lists will restart the sequence only for the sub-list.
1.115 kristaps 2799: .It
1.150 kristaps 2800: .Sx \&Li
2801: followed by a reserved character is incorrectly used in some manuals
2802: instead of properly quoting that character, which sometimes works with
2803: historic groff.
1.57 kristaps 2804: .It
1.150 kristaps 2805: .Sx \&Lk
2806: only accepts a single link-name argument; the remainder is misformatted.
1.81 kristaps 2807: .It
1.80 kristaps 2808: .Sx \&Pa
1.150 kristaps 2809: does not format its arguments when used in the FILES section under
1.100 kristaps 2810: certain list types.
1.80 kristaps 2811: .It
1.150 kristaps 2812: .Sx \&Ta
2813: can only be called by other macros, but not at the beginning of a line.
2814: .It
2815: .Sx \&%C
2816: is not implemented.
2817: .It
2818: Historic groff has many un-callable macros.
2819: Most of these (excluding some block-level macros) are callable
2820: in new groff and mandoc.
2821: .It
2822: .Sq \(ba
2823: (vertical bar) is not fully supported as a delimiter.
2824: \*[hist]
1.79 kristaps 2825: .It
1.77 kristaps 2826: .Sq \ef
1.150 kristaps 2827: .Pq font face
2828: and
2829: .Sq \ef
2830: .Pq font family face
1.93 kristaps 2831: .Sx Text Decoration
1.150 kristaps 2832: escapes behave irregularly when specified within line-macro scopes.
1.77 kristaps 2833: .It
1.150 kristaps 2834: Negative scaling units return to prior lines.
2835: Instead, mandoc truncates them to zero.
2836: .El
2837: .Pp
2838: The following features are unimplemented in mandoc:
2839: .Pp
2840: .Bl -dash -compact
1.61 kristaps 2841: .It
1.150 kristaps 2842: .Sx \&Bd
2843: .Fl file Ar file .
1.57 kristaps 2844: .It
1.78 kristaps 2845: .Sx \&Bd
1.126 kristaps 2846: .Fl offset Ar center
1.64 kristaps 2847: and
1.150 kristaps 2848: .Fl offset Ar right .
2849: Groff does not implement centered and flush-right rendering either,
2850: but produces large indentations.
2851: .It
2852: The
2853: .Sq \eh
2854: .Pq horizontal position ,
2855: .Sq \ev
2856: .Pq vertical position ,
2857: .Sq \em
2858: .Pq text colour ,
2859: .Sq \eM
2860: .Pq text filling colour ,
1.152 kristaps 2861: .Sq \ez
2862: .Pq zero-length character ,
1.153 kristaps 2863: .Sq \ew
2864: .Pq string length ,
1.154 kristaps 2865: .Sq \ek
2866: .Pq horizontal position marker ,
1.157 kristaps 2867: .Sq \eo
2868: .Pq text overstrike ,
1.64 kristaps 2869: and
1.150 kristaps 2870: .Sq \es
2871: .Pq text size
1.153 kristaps 2872: escape sequences are all discarded in mandoc.
1.57 kristaps 2873: .It
1.150 kristaps 2874: The
2875: .Sq \ef
2876: scaling unit is accepted by mandoc, but rendered as the default unit.
1.57 kristaps 2877: .It
1.150 kristaps 2878: In quoted literals, groff allows pairwise double-quotes to produce a
2879: standalone double-quote in formatted output.
2880: This is not supported by mandoc.
1.57 kristaps 2881: .El
1.2 kristaps 2882: .Sh SEE ALSO
1.159 schwarze 2883: .Xr man 1 ,
1.57 kristaps 2884: .Xr mandoc 1 ,
2885: .Xr mandoc_char 7
1.151 kristaps 2886: .Sh HISTORY
2887: The
2888: .Nm
2889: language first appeared as a troff macro package in
2890: .Bx 4.4 .
2891: It was later significantly updated by Werner Lemberg and Ruslan Ermilov
1.155 kristaps 2892: in groff-1.17.
1.151 kristaps 2893: The standalone implementation that is part of the
2894: .Xr mandoc 1
2895: utility written by Kristaps Dzonsons appeared in
2896: .Ox 4.6 .
1.2 kristaps 2897: .Sh AUTHORS
2898: The
1.57 kristaps 2899: .Nm
1.50 kristaps 2900: reference was written by
1.94 kristaps 2901: .An Kristaps Dzonsons Aq kristaps@bsd.lv .
CVSweb