Annotation of mandoc/mdoc.7, Revision 1.73
1.73 ! kristaps 1: .\" $Id: mdoc.7,v 1.72 2009/11/02 06:22:45 kristaps Exp $
1.1 kristaps 2: .\"
1.23 kristaps 3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
1.22 kristaps 6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: .\"
1.22 kristaps 9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.50 kristaps 16: .\"
1.1 kristaps 17: .Dd $Mdocdate$
1.20 kristaps 18: .Dt MDOC 7
1.1 kristaps 19: .Os
1.56 kristaps 20: .
21: .
1.1 kristaps 22: .Sh NAME
1.57 kristaps 23: .Nm mdoc
24: .Nd mdoc language reference
1.56 kristaps 25: .
26: .
1.1 kristaps 27: .Sh DESCRIPTION
28: The
1.57 kristaps 29: .Nm mdoc
1.50 kristaps 30: language is used to format
1.57 kristaps 31: .Bx
32: .Ux
1.43 kristaps 33: manuals. In this reference document, we describe its syntax, structure,
34: and usage. Our reference implementation is
1.57 kristaps 35: .Xr mandoc 1 .
1.28 kristaps 36: The
1.57 kristaps 37: .Sx COMPATIBILITY
1.50 kristaps 38: section describes compatibility with
1.57 kristaps 39: .Xr groff 1 .
40: .
41: .Pp
1.13 kristaps 42: An
1.57 kristaps 43: .Nm
1.1 kristaps 44: document follows simple rules: lines beginning with the control
1.50 kristaps 45: character
1.57 kristaps 46: .Sq \.
1.1 kristaps 47: are parsed for macros. Other lines are interpreted within the scope of
1.13 kristaps 48: prior macros:
1.57 kristaps 49: .Bd -literal -offset indent
1.13 kristaps 50: \&.Sh Macro lines change control state.
51: Other lines are interpreted within the current state.
1.57 kristaps 52: .Ed
1.56 kristaps 53: .
54: .
1.46 kristaps 55: .Sh LANGUAGE SYNTAX
1.57 kristaps 56: .Nm
1.13 kristaps 57: documents may contain only graphable 7-bit ASCII characters, the space
1.43 kristaps 58: character, and, in certain circumstances, the tab character. All
59: manuals must have
1.57 kristaps 60: .Ux
1.50 kristaps 61: line terminators.
1.56 kristaps 62: .
63: .
1.57 kristaps 64: .Ss Comments
1.43 kristaps 65: Text following a
1.57 kristaps 66: .Sq \e" ,
1.43 kristaps 67: whether in a macro or free-form text line, is ignored to the end of
68: line. A macro line with only a control character and comment escape,
1.57 kristaps 69: .Sq \&.\e" ,
1.58 kristaps 70: is also ignored. Macro lines with only a control charater and optionally
71: whitespace are stripped from input.
1.56 kristaps 72: .
73: .
1.57 kristaps 74: .Ss Reserved Characters
1.2 kristaps 75: Within a macro line, the following characters are reserved:
1.61 kristaps 76: .Pp
1.57 kristaps 77: .Bl -tag -width Ds -offset indent -compact
78: .It \&.
79: .Pq period
80: .It \&,
81: .Pq comma
82: .It \&:
83: .Pq colon
84: .It \&;
85: .Pq semicolon
86: .It \&(
87: .Pq left-parenthesis
88: .It \&)
89: .Pq right-parenthesis
90: .It \&[
91: .Pq left-bracket
92: .It \&]
93: .Pq right-bracket
94: .It \&?
95: .Pq question
96: .It \&!
97: .Pq exclamation
98: .It \&|
99: .Pq vertical bar
100: .El
101: .
102: .Pp
1.5 kristaps 103: Use of reserved characters is described in
1.57 kristaps 104: .Sx MACRO SYNTAX .
1.43 kristaps 105: For general use in macro lines, these characters must either be escaped
106: with a non-breaking space
1.57 kristaps 107: .Pq Sq \e&
1.50 kristaps 108: or, if applicable, an appropriate escape sequence used.
1.56 kristaps 109: .
110: .
1.57 kristaps 111: .Ss Special Characters
1.43 kristaps 112: Special characters may occur in both macro and free-form lines.
113: Sequences begin with the escape character
1.57 kristaps 114: .Sq \e
1.50 kristaps 115: followed by either an open-parenthesis
1.57 kristaps 116: .Sq \&(
1.1 kristaps 117: for two-character sequences; an open-bracket
1.57 kristaps 118: .Sq \&[
1.1 kristaps 119: for n-character sequences (terminated at a close-bracket
1.57 kristaps 120: .Sq \&] ) ;
1.43 kristaps 121: or a single one-character sequence. See
1.57 kristaps 122: .Xr mandoc_char 7
1.50 kristaps 123: for a complete list. Examples include
1.57 kristaps 124: .Sq \e(em
125: .Pq em-dash
1.50 kristaps 126: and
1.57 kristaps 127: .Sq \ee
128: .Pq back-slash .
1.56 kristaps 129: .
130: .
1.57 kristaps 131: .Ss Text Decoration
1.54 kristaps 132: Terms may be text-decorated using the
1.57 kristaps 133: .Sq \ef
1.43 kristaps 134: escape followed by an indicator: B (bold), I, (italic), or P and R
1.54 kristaps 135: (Roman, or reset). This form is not recommended for
1.57 kristaps 136: .Nm ,
1.54 kristaps 137: which encourages semantic, not presentation, annotation.
1.56 kristaps 138: .
139: .
1.57 kristaps 140: .Ss Predefined Strings
1.54 kristaps 141: Historically,
1.57 kristaps 142: .Xr groff 1
1.54 kristaps 143: also defined a set of package-specific
1.57 kristaps 144: .Dq predefined strings ,
1.54 kristaps 145: which, like
1.57 kristaps 146: .Sx Special Characters ,
1.54 kristaps 147: demark special output characters and strings by way of input codes.
148: Predefined strings are escaped with the slash-asterisk,
1.57 kristaps 149: .Sq \e* :
1.54 kristaps 150: single-character
1.57 kristaps 151: .Sq \e*X ,
1.54 kristaps 152: two-character
1.57 kristaps 153: .Sq \e*(XX ,
1.54 kristaps 154: and N-character
1.57 kristaps 155: .Sq \e*[N] .
1.54 kristaps 156: See
1.57 kristaps 157: .Xr mandoc_char 7
1.54 kristaps 158: for a complete list. Examples include
1.57 kristaps 159: .Sq \e*(Am
160: .Pq ampersand
1.54 kristaps 161: and
1.57 kristaps 162: .Sq \e*(Ba
163: .Pq vertical bar .
1.56 kristaps 164: .
165: .
1.57 kristaps 166: .Ss Whitespace
1.46 kristaps 167: In non-literal free-form lines, consecutive blocks of whitespace are
168: pruned from input and added later in the output filter, if applicable:
1.57 kristaps 169: .Bd -literal -offset indent
1.46 kristaps 170: These spaces are pruned from input.
1.50 kristaps 171: \&.Bd \-literal
1.46 kristaps 172: These are not.
173: \&.Ed
1.57 kristaps 174: .Ed
175: .
176: .Pp
1.46 kristaps 177: In macro lines, whitespace delimits arguments and is discarded. If
1.47 kristaps 178: arguments are quoted, whitespace within the quotes is retained.
1.57 kristaps 179: .
180: .Pp
1.46 kristaps 181: Blank lines are only permitted within literal contexts, as are lines
182: containing only whitespace. Tab characters are only acceptable when
1.50 kristaps 183: delimiting
1.57 kristaps 184: .Sq \&Bl \-column
1.46 kristaps 185: or when in a literal context.
1.56 kristaps 186: .
187: .
1.57 kristaps 188: .Ss Quotation
1.46 kristaps 189: Macro arguments may be quoted with a double-quote to group
190: space-delimited terms or to retain blocks of whitespace. A quoted
191: argument begins with a double-quote preceded by whitespace. The next
1.48 kristaps 192: double-quote not pair-wise adjacent to another double-quote terminates
1.50 kristaps 193: the literal, regardless of surrounding whitespace.
1.57 kristaps 194: .
195: .Pp
1.50 kristaps 196: This produces tokens
1.57 kristaps 197: .Sq a" ,
198: .Sq b c ,
199: .Sq de ,
1.47 kristaps 200: and
1.57 kristaps 201: .Sq fg" .
1.47 kristaps 202: Note that any quoted term, be it argument or macro, is indiscriminately
1.50 kristaps 203: considered literal text. Thus, the following produces
1.57 kristaps 204: .Sq \&Em a :
205: .Bd -literal -offset indent
1.47 kristaps 206: \&.Em "Em a"
1.57 kristaps 207: .Ed
208: .
209: .Pp
1.46 kristaps 210: In free-form mode, quotes are regarded as opaque text.
1.56 kristaps 211: .
1.63 kristaps 212: .Ss Dates
1.66 kristaps 213: There are several macros in
214: .Nm
1.72 kristaps 215: that require a date argument. The canonical form for dates is the
216: American format:
1.66 kristaps 217: .Pp
218: .D1 Cm Month Day , Year
219: .Pp
220: The
221: .Cm Day
222: value is an optionally zero-padded numeral. The
223: .Cm Month
224: value is the full month name. The
225: .Cm Year
226: value is the full four-digit year.
227: .Pp
1.72 kristaps 228: Reduced form dates are broken-down canonical form dates:
1.66 kristaps 229: .Pp
1.72 kristaps 230: .D1 Cm Month , Year
231: .D1 Cm Year
1.66 kristaps 232: .Pp
233: Some examples of valid dates follow:
234: .Pp
235: .D1 "May, 2009" Pq reduced form
236: .D1 "2009" Pq reduced form
237: .D1 "May 20, 2009" Pq canonical form
1.63 kristaps 238: .
1.61 kristaps 239: .Ss Scaling Widths
240: Many macros support scaled widths for their arguments, such as
241: stipulating a two-inch list indentation with the following:
242: .Bd -literal -offset indent
243: \&.Bl -tag -width 2i
244: .Ed
245: .
246: .Pp
247: The syntax for scaled widths is
1.62 kristaps 248: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
1.61 kristaps 249: where a decimal must be preceded or proceeded by at least one digit.
250: Negative numbers, while accepted, are truncated to zero. The following
251: scaling units are accepted:
252: .Pp
253: .Bl -tag -width Ds -offset indent -compact
254: .It c
255: centimetre
256: .It i
257: inch
258: .It P
259: pica (~1/6 inch)
260: .It p
261: point (~1/72 inch)
262: .It f
263: synonym for
264: .Sq u
265: .It v
266: default vertical span
267: .It m
268: width of rendered
269: .Sq m
270: .Pq em
271: character
272: .It n
273: width of rendered
274: .Sq n
275: .Pq en
276: character
277: .It u
278: default horizontal span
279: .It M
280: mini-em (~1/100 em)
281: .El
282: .Pp
283: Using anything other than
284: .Sq m ,
285: .Sq n ,
286: .Sq u ,
287: or
288: .Sq v
289: is necessarily non-portable across output media. See
290: .Sx COMPATIBILITY .
291: .
1.56 kristaps 292: .
1.43 kristaps 293: .Sh MANUAL STRUCTURE
1.66 kristaps 294: A well-formed
1.57 kristaps 295: .Nm
1.66 kristaps 296: document consists of a document prologue followed by one or more
297: sections.
298: .Pp
299: The prologue, which consists of (in order) the
1.64 kristaps 300: .Sx \&Dd ,
301: .Sx \&Dt ,
1.33 kristaps 302: and
1.66 kristaps 303: .Sx \&Os
304: macros, is required for every document.
305: .Pp
306: The first section (sections are denoted by
307: .Sx \&Sh )
308: must be the NAME section, consisting of at least one
1.64 kristaps 309: .Sx \&Nm
1.50 kristaps 310: followed by
1.66 kristaps 311: .Sx \&Nd .
312: .Pp
313: Following that, convention dictates specifying at least the SYNOPSIS and
314: DESCRIPTION sections, although this varies between manual sections.
315: .Pp
316: The following is a well-formed skeleton
317: .Nm
318: file:
1.57 kristaps 319: .Bd -literal -offset indent
1.43 kristaps 320: \&.Dd $\&Mdocdate$
321: \&.Dt mdoc 7
322: \&.Os
1.58 kristaps 323: \&.
1.43 kristaps 324: \&.Sh NAME
1.58 kristaps 325: \&.Nm foo
326: \&.Nd a description goes here
327: \&.\e\*q The next is for sections 2 & 3 only.
328: \&.\e\*q .Sh LIBRARY
329: \&.
330: \&.Sh SYNOPSIS
331: \&.Nm foo
332: \&.Op Fl options
333: \&.Ar
334: \&.
335: \&.Sh DESCRIPTION
336: The
337: \&.Nm
338: utility processes files ...
1.59 kristaps 339: \&.\e\*q .Sh IMPLEMENTATION NOTES
1.58 kristaps 340: \&.\e\*q The next is for sections 1 & 8 only.
341: \&.\e\*q .Sh EXIT STATUS
342: \&.\e\*q The next is for sections 2, 3, & 9 only.
343: \&.\e\*q .Sh RETURN VALUES
344: \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
345: \&.\e\*q .Sh ENVIRONMENT
346: \&.\e\*q .Sh FILES
347: \&.\e\*q .Sh EXAMPLES
348: \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
349: \&.\e\*q .Sh DIAGNOSTICS
350: \&.\e\*q The next is for sections 2, 3, & 9 only.
351: \&.\e\*q .Sh ERRORS
352: \&.\e\*q .Sh SEE ALSO
353: \&.\e\*q .Xr foobar 1
354: \&.\e\*q .Sh STANDARDS
355: \&.\e\*q .Sh HISTORY
356: \&.\e\*q .Sh AUTHORS
357: \&.\e\*q .Sh CAVEATS
358: \&.\e\*q .Sh BUGS
359: \&.\e\*q .Sh SECURITY CONSIDERATIONS
1.57 kristaps 360: .Ed
361: .Pp
1.66 kristaps 362: The sections in a
363: .Nm
364: document are conventionally ordered as they appear above. Sections
365: should be composed as follows:
1.73 ! kristaps 366: .Bl -ohang -offset Ds
! 367: .It Em NAME
! 368: The name(s) and a short description of the documented material. The
! 369: syntax for this as follows:
! 370: .Bd -literal -offset indent
! 371: \&.Nm name0
! 372: \&.Nm name1
! 373: \&.Nm name2
! 374: \&.Nd a short description
! 375: .Ed
! 376: .Pp
! 377: The
1.66 kristaps 378: .Sx \&Nm
1.73 ! kristaps 379: macro(s) must precede the
! 380: .Sx \&Nd
! 381: macro.
! 382: .
! 383: .It Em LIBRARY
! 384: The name of the library containing the documented material, which is
! 385: assumed to be a function in a section 2 or 3 manual. The syntax for
! 386: this is as follows:
! 387: .Bd -literal -offset indent
! 388: \&.Lb libarm
! 389: .Ed
! 390: .Pp
! 391: See
! 392: .Sx \&Lb
! 393: for details.
! 394: .
! 395: .It Em SYNOPSIS
! 396: Documents the utility invocation syntax, function call syntax, or device
! 397: configuration.
! 398: .Pp
! 399: For the first, utilities (sections 1, 6, and 8), this is
! 400: generally structured as follows:
! 401: .Bd -literal -offset indent
! 402: \&.Nm foo
! 403: \&.Op Fl v
! 404: \&.Op Fl o Ar file
! 405: \&.Op Ar
! 406: \&.Nm bar
! 407: \&.Op Fl v
! 408: \&.Op Fl o Ar file
! 409: \&.Op Ar
! 410: .Ed
! 411: .Pp
! 412: For the second, function calls (sections 2, 3, 9):
! 413: .Bd -literal -offset indent
! 414: \&.Vt extern const char *global;
! 415: \&.In header.h
! 416: \&.Ft "char *"
! 417: \&.Fn foo "const char *src"
! 418: \&.Ft "char *"
! 419: \&.Fn bar "const char *src"
! 420: .Ed
! 421: .Pp
! 422: And for the third, configurations (section 4):
! 423: .Bd -literal -offset indent
! 424: \&.Cd \*qit* at isa? port 0x2e\*q
! 425: \&.Cd \*qit* at isa? port 0x4e\*q
! 426: .Ed
! 427: .Pp
! 428: Manuals not in these sections generally don't need a
! 429: .Em SYNOPSIS .
! 430: .
! 431: .It Em DESCRIPTION
! 432: This expands upon the brief, one-line description in
! 433: .Em NAME .
! 434: It usually contains a break-down of the options (if documenting a
! 435: command), such as:
! 436: .Bd -literal -offset indent
! 437: The arguments are as follows:
! 438: \&.Bl \-tag \-width Ds
! 439: \&.It Fl v
! 440: Print verbose information.
! 441: \&.El
! 442: .Ed
! 443: Manuals not documenting a command won't include the above fragment.
! 444: .
! 445: .It Em IMPLEMENTATION NOTES
! 446: Implementation-specific notes should be kept here. This is useful when
! 447: implementing standard functions that may have side effects or notable
! 448: algorithmic implications.
! 449: .
! 450: .It Em EXIT STATUS
! 451: Command exit status for section 1, 6, and 8 manuals. This section is
! 452: the dual of
! 453: .Em RETURN VALUES ,
! 454: which is used for functions. Historically, this information was
! 455: described in
! 456: .Em DIAGNOSTICS ,
! 457: a practise that is now discouraged.
! 458: .Pp
! 459: See
! 460: .Sx \&Ex .
! 461: .
! 462: .It Em RETURN VALUES
! 463: This section is the dual of
! 464: .Em EXIT STATUS ,
! 465: which is used for commands. It documents the return values of functions
! 466: in sections 2, 3, and 9.
! 467: .Pp
! 468: See
! 469: .Sx \&Rv .
! 470: .
! 471: .It Em ENVIRONMENT
! 472: Documents any usages of environment variables, e.g.,
! 473: .Xr environ 7 .
! 474: .Pp
! 475: See
! 476: .Sx \&Ev .
! 477: .
! 478: .It Em FILES
! 479: Documents files used. It's helpful to document both the file and a
! 480: short description of how the file is used (created, modified, etc.).
! 481: .Pp
! 482: See
! 483: .Sx \&Pa .
! 484: .
! 485: .It Em EXAMPLES
! 486: Example usages. This often contains snippets of well-formed,
! 487: well-tested invocations. Make doubly sure that your examples work
! 488: properly!
! 489: .
! 490: .It Em DIAGNOSTICS
! 491: Documents error conditions. This is most useful in section 4 manuals.
! 492: Historically, this section was used in place of
! 493: .Em EXIT STATUS
! 494: for manuals in sections 1, 6, and 8; however, this practise is
! 495: discouraged.
! 496: .Pp
! 497: See
! 498: .Sx \&Bl No \-diag .
! 499: .
! 500: .It Em ERRORS
! 501: Documents error handling in sections 2, 3, and 9.
! 502: .Pp
! 503: See
! 504: .Sx \&Er .
! 505: .
! 506: .It Em SEE ALSO
! 507: References other manuals with related topics. This section should exist
! 508: for most manuals. Cross-references should conventionally be ordered
! 509: first by section, then alphabetically.
! 510: .Pp
! 511: See
! 512: .Sx \&Xr .
! 513: .
! 514: .It Em STANDARDS
! 515: References any standards implemented or used. If not adhering to any
! 516: standards, the
! 517: .Em HISTORY
! 518: section should be used instead.
! 519: .Pp
! 520: See
! 521: .Sx \&St .
! 522: .
! 523: .It Em HISTORY
! 524: The history of any manual without a
! 525: .Em STANDARDS
! 526: section should be described in this section.
! 527: .
! 528: .It Em AUTHORS
! 529: Credits to authors, if applicable, should appear in this section.
! 530: Authors should generally be noted by both name and an e-mail address.
! 531: .Pp
! 532: See
! 533: .Sx \&An .
! 534: .
! 535: .It Em CAVEATS
! 536: Explanations of common misuses and misunderstandings should be explained
! 537: in this section.
! 538: .
! 539: .It Em BUGS
! 540: Extant bugs should be described in this section.
! 541: .
! 542: .It Em SECURITY CONSIDERATIONS
! 543: Documents any security precautions that operators should consider.
! 544: .
1.66 kristaps 545: .El
1.56 kristaps 546: .
547: .
1.43 kristaps 548: .Sh MACRO SYNTAX
1.56 kristaps 549: Macros are one to three three characters in length and begin with a
550: control character ,
1.57 kristaps 551: .Sq \&. ,
1.56 kristaps 552: at the beginning of the line. An arbitrary amount of whitespace may
1.64 kristaps 553: sit between the control character and the macro name. Thus, the
554: following are equivalent:
555: .Bd -literal -offset indent
556: \&.Pp
557: \&.\ \ \ \&Pp
558: .Ed
1.57 kristaps 559: .
560: .Pp
1.46 kristaps 561: The syntax of a macro depends on its classification. In this section,
1.57 kristaps 562: .Sq \-arg
1.43 kristaps 563: refers to macro arguments, which may be followed by zero or more
1.57 kristaps 564: .Sq parm
1.43 kristaps 565: parameters;
1.57 kristaps 566: .Sq \&Yo
1.43 kristaps 567: opens the scope of a macro; and if specified,
1.57 kristaps 568: .Sq \&Yc
1.43 kristaps 569: closes it out.
1.57 kristaps 570: .
571: .Pp
1.43 kristaps 572: The
1.57 kristaps 573: .Em Callable
1.43 kristaps 574: column indicates that the macro may be called subsequent to the initial
1.55 kristaps 575: line-macro. If a macro is not callable, then its invocation after the
576: initial line macro is interpreted as opaque text, such that
1.60 kristaps 577: .Sq \&.Fl \&Sh
1.55 kristaps 578: produces
1.60 kristaps 579: .Sq Fl \&Sh .
1.57 kristaps 580: .
581: .Pp
1.55 kristaps 582: The
1.57 kristaps 583: .Em Parsable
1.43 kristaps 584: column indicates whether the macro may be followed by further
1.55 kristaps 585: (ostensibly callable) macros. If a macro is not parsable, subsequent
586: macro invocations on the line will be interpreted as opaque text.
1.57 kristaps 587: .
588: .Pp
1.55 kristaps 589: The
1.57 kristaps 590: .Em Scope
1.43 kristaps 591: column, if applicable, describes closure rules.
1.56 kristaps 592: .
593: .
1.57 kristaps 594: .Ss Block full-explicit
1.43 kristaps 595: Multi-line scope closed by an explicit closing macro. All macros
596: contains bodies; only
1.64 kristaps 597: .Sx \&Bf
1.43 kristaps 598: contains a head.
1.57 kristaps 599: .Bd -literal -offset indent
1.50 kristaps 600: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
601: \(lBbody...\(rB
1.43 kristaps 602: \&.Yc
1.57 kristaps 603: .Ed
604: .
605: .Pp
606: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
607: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
1.64 kristaps 608: .It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed
609: .It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef
610: .It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek
611: .It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El
612: .It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd
613: .It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf
614: .It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk
615: .It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl
1.57 kristaps 616: .El
1.56 kristaps 617: .
618: .
1.57 kristaps 619: .Ss Block full-implicit
1.43 kristaps 620: Multi-line scope closed by end-of-file or implicitly by another macro.
1.50 kristaps 621: All macros have bodies; some
1.57 kristaps 622: .Po
1.64 kristaps 623: .Sx \&It Fl bullet ,
624: .Fl hyphen ,
625: .Fl dash ,
626: .Fl enum ,
627: .Fl item
1.57 kristaps 628: .Pc
1.64 kristaps 629: don't have heads; only one
630: .Po
631: .Sx \&It Fl column
632: .Pc
633: has multiple heads.
1.57 kristaps 634: .Bd -literal -offset indent
1.50 kristaps 635: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
636: \(lBbody...\(rB
1.57 kristaps 637: .Ed
1.56 kristaps 638: .
1.57 kristaps 639: .Pp
640: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
641: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
1.64 kristaps 642: .It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El
643: .It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh
644: .It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh
645: .It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss
1.57 kristaps 646: .El
1.56 kristaps 647: .
1.57 kristaps 648: .
649: .Ss Block partial-explicit
1.43 kristaps 650: Like block full-explicit, but also with single-line scope. Each
1.50 kristaps 651: has at least a body and, in limited circumstances, a head
1.64 kristaps 652: .Po
653: .Sx \&Fo ,
654: .Sx \&Eo
655: .Pc
1.50 kristaps 656: and/or tail
1.64 kristaps 657: .Pq Sx \&Ec .
1.57 kristaps 658: .Bd -literal -offset indent
1.50 kristaps 659: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
660: \(lBbody...\(rB
661: \&.Yc \(lBtail...\(rB
1.2 kristaps 662:
1.43 kristaps 663: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
1.50 kristaps 664: \(lBbody...\(rB \&Yc \(lBtail...\(rB
1.57 kristaps 665: .Ed
666: .
667: .Pp
668: .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
669: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
1.64 kristaps 670: .It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao
1.63 kristaps 671: .It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac
1.64 kristaps 672: .It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo
673: .It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc
674: .It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro
675: .It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc
676: .It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do
677: .It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc
678: .It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo
679: .It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec
680: .It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo
681: .It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc
682: .It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo
683: .It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc
684: .It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po
685: .It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc
686: .It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo
687: .It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc
1.63 kristaps 688: .It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs
689: .It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re
1.64 kristaps 690: .It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So
691: .It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc
692: .It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo
693: .It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc
1.57 kristaps 694: .El
1.56 kristaps 695: .
696: .
1.57 kristaps 697: .Ss Block partial-implicit
1.50 kristaps 698: Like block full-implicit, but with single-line scope closed by
1.57 kristaps 699: .Sx Reserved Characters
1.43 kristaps 700: or end of line.
1.57 kristaps 701: .Bd -literal -offset indent
1.43 kristaps 702: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
1.57 kristaps 703: .Ed
1.56 kristaps 704: .
1.57 kristaps 705: .Pp
706: .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
707: .It Em Macro Ta Em Callable Ta Em Parsable
1.64 kristaps 708: .It Sx \&Aq Ta Yes Ta Yes
709: .It Sx \&Bq Ta Yes Ta Yes
710: .It Sx \&Brq Ta Yes Ta Yes
711: .It Sx \&D1 Ta \&No Ta \&Yes
712: .It Sx \&Dl Ta \&No Ta Yes
713: .It Sx \&Dq Ta Yes Ta Yes
714: .It Sx \&Op Ta Yes Ta Yes
715: .It Sx \&Pq Ta Yes Ta Yes
716: .It Sx \&Ql Ta Yes Ta Yes
717: .It Sx \&Qq Ta Yes Ta Yes
718: .It Sx \&Sq Ta Yes Ta Yes
1.57 kristaps 719: .El
1.56 kristaps 720: .
1.57 kristaps 721: .
722: .Ss In-line
1.50 kristaps 723: Closed by
1.57 kristaps 724: .Sx Reserved Characters ,
1.43 kristaps 725: end of line, fixed argument lengths, and/or subsequent macros. In-line
726: macros have only text children. If a number (or inequality) of
1.3 kristaps 727: arguments is
1.57 kristaps 728: .Pq n ,
1.3 kristaps 729: then the macro accepts an arbitrary number of arguments.
1.57 kristaps 730: .Bd -literal -offset indent
1.43 kristaps 731: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
732:
733: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
734:
735: \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
1.57 kristaps 736: .Ed
737: .
738: .Pp
739: .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
740: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
1.63 kristaps 741: .It Sx \&%A Ta \&No Ta \&No Ta >0
742: .It Sx \&%B Ta \&No Ta \&No Ta >0
743: .It Sx \&%C Ta \&No Ta \&No Ta >0
744: .It Sx \&%D Ta \&No Ta \&No Ta >0
745: .It Sx \&%I Ta \&No Ta \&No Ta >0
746: .It Sx \&%J Ta \&No Ta \&No Ta >0
747: .It Sx \&%N Ta \&No Ta \&No Ta >0
748: .It Sx \&%O Ta \&No Ta \&No Ta >0
749: .It Sx \&%P Ta \&No Ta \&No Ta >0
1.69 kristaps 750: .It Sx \&%Q Ta \&No Ta \&No Ta >0
1.63 kristaps 751: .It Sx \&%R Ta \&No Ta \&No Ta >0
752: .It Sx \&%T Ta \&No Ta \&No Ta >0
1.69 kristaps 753: .It Sx \&%U Ta \&No Ta \&No Ta >0
1.63 kristaps 754: .It Sx \&%V Ta \&No Ta \&No Ta >0
1.64 kristaps 755: .It Sx \&Ad Ta Yes Ta Yes Ta n
756: .It Sx \&An Ta Yes Ta Yes Ta n
757: .It Sx \&Ap Ta Yes Ta Yes Ta 0
758: .It Sx \&Ar Ta Yes Ta Yes Ta n
759: .It Sx \&At Ta Yes Ta Yes Ta 1
760: .It Sx \&Bsx Ta Yes Ta Yes Ta n
761: .It Sx \&Bt Ta \&No Ta \&No Ta 0
762: .It Sx \&Bx Ta Yes Ta Yes Ta n
763: .It Sx \&Cd Ta Yes Ta Yes Ta >0
764: .It Sx \&Cm Ta Yes Ta Yes Ta n
765: .It Sx \&Db Ta \&No Ta \&No Ta 1
766: .It Sx \&Dd Ta \&No Ta \&No Ta >0
767: .It Sx \&Dt Ta \&No Ta \&No Ta n
768: .It Sx \&Dv Ta Yes Ta Yes Ta n
769: .It Sx \&Dx Ta Yes Ta Yes Ta n
770: .It Sx \&Em Ta Yes Ta Yes Ta >0
771: .It Sx \&En Ta \&No Ta \&No Ta 0
772: .It Sx \&Er Ta Yes Ta Yes Ta >0
773: .It Sx \&Es Ta \&No Ta \&No Ta 0
774: .It Sx \&Ev Ta Yes Ta Yes Ta n
775: .It Sx \&Ex Ta \&No Ta \&No Ta n
776: .It Sx \&Fa Ta Yes Ta Yes Ta n
777: .It Sx \&Fd Ta \&No Ta \&No Ta >0
778: .It Sx \&Fl Ta Yes Ta Yes Ta n
779: .It Sx \&Fn Ta Yes Ta Yes Ta >0
780: .It Sx \&Fr Ta \&No Ta \&No Ta n
781: .It Sx \&Ft Ta Yes Ta Yes Ta n
782: .It Sx \&Fx Ta Yes Ta Yes Ta n
783: .It Sx \&Hf Ta \&No Ta \&No Ta n
784: .It Sx \&Ic Ta Yes Ta Yes Ta >0
785: .It Sx \&In Ta \&No Ta \&No Ta n
786: .It Sx \&Lb Ta \&No Ta \&No Ta 1
787: .It Sx \&Li Ta Yes Ta Yes Ta n
788: .It Sx \&Lk Ta Yes Ta Yes Ta n
789: .It Sx \&Lp Ta \&No Ta \&No Ta 0
790: .It Sx \&Ms Ta Yes Ta Yes Ta >0
791: .It Sx \&Mt Ta Yes Ta Yes Ta >0
792: .It Sx \&Nm Ta Yes Ta Yes Ta n
793: .It Sx \&No Ta Yes Ta Yes Ta 0
794: .It Sx \&Ns Ta Yes Ta Yes Ta 0
795: .It Sx \&Nx Ta Yes Ta Yes Ta n
796: .It Sx \&Os Ta \&No Ta \&No Ta n
797: .It Sx \&Ot Ta \&No Ta \&No Ta n
798: .It Sx \&Ox Ta Yes Ta Yes Ta n
799: .It Sx \&Pa Ta Yes Ta Yes Ta n
800: .It Sx \&Pf Ta \&No Ta Yes Ta 1
801: .It Sx \&Pp Ta \&No Ta \&No Ta 0
802: .It Sx \&Rv Ta \&No Ta \&No Ta n
803: .It Sx \&Sm Ta \&No Ta \&No Ta 1
804: .It Sx \&St Ta \&No Ta Yes Ta 1
805: .It Sx \&Sx Ta Yes Ta Yes Ta >0
806: .It Sx \&Sy Ta Yes Ta Yes Ta >0
807: .It Sx \&Tn Ta Yes Ta Yes Ta >0
808: .It Sx \&Ud Ta \&No Ta \&No Ta 0
809: .It Sx \&Ux Ta Yes Ta Yes Ta n
810: .It Sx \&Va Ta Yes Ta Yes Ta n
811: .It Sx \&Vt Ta Yes Ta Yes Ta >0
812: .It Sx \&Xr Ta Yes Ta Yes Ta >0, <3
813: .It Sx \&br Ta \&No Ta \&No Ta 0
814: .It Sx \&sp Ta \&No Ta \&No Ta 1
1.57 kristaps 815: .El
1.56 kristaps 816: .
817: .
1.63 kristaps 818: .Sh REFERENCE
819: This section is a canonical reference of all macros, arranged
820: alphabetically. For the scoping of individual macros, see
821: .Sx MACRO SYNTAX .
822: .
823: .Ss \&%A
824: Author name of an
825: .Sx \&Rs
826: block. Multiple authors should each be accorded their own
1.64 kristaps 827: .Sx \%%A
1.66 kristaps 828: line. Author names should be ordered with full or abbreviated
829: forename(s) first, then full surname.
1.64 kristaps 830: .
1.63 kristaps 831: .Ss \&%B
832: Book title of an
833: .Sx \&Rs
834: block. This macro may also be used in a non-bibliographic context when
835: referring to book titles.
1.64 kristaps 836: .
1.63 kristaps 837: .Ss \&%C
838: Publication city or location of an
839: .Sx \&Rs
840: block.
841: .Pp
1.65 kristaps 842: .Em Remarks :
1.63 kristaps 843: this macro is not implemented in
844: .Xr groff 1 .
1.64 kristaps 845: .
1.63 kristaps 846: .Ss \&%D
847: Publication date of an
848: .Sx \&Rs
1.72 kristaps 849: block. This should follow the reduced or canonical form syntax
850: described in
1.63 kristaps 851: .Sx Dates .
1.64 kristaps 852: .
1.63 kristaps 853: .Ss \&%I
854: Publisher or issuer name of an
855: .Sx \&Rs
856: block.
1.64 kristaps 857: .
1.63 kristaps 858: .Ss \&%J
859: Journal name of an
860: .Sx \&Rs
861: block.
1.64 kristaps 862: .
1.63 kristaps 863: .Ss \&%N
864: Issue number (usually for journals) of an
865: .Sx \&Rs
866: block.
1.64 kristaps 867: .
1.63 kristaps 868: .Ss \&%O
869: Optional information of an
870: .Sx \&Rs
871: block.
1.64 kristaps 872: .
1.63 kristaps 873: .Ss \&%P
874: Book or journal page number of an
875: .Sx \&Rs
876: block.
1.64 kristaps 877: .
1.63 kristaps 878: .Ss \&%Q
879: Institutional author (school, government, etc.) of an
880: .Sx \&Rs
881: block. Multiple institutional authors should each be accorded their own
1.64 kristaps 882: .Sx \&%Q
1.63 kristaps 883: line.
1.64 kristaps 884: .
1.63 kristaps 885: .Ss \&%R
886: Technical report name of an
887: .Sx \&Rs
888: block.
1.64 kristaps 889: .
1.63 kristaps 890: .Ss \&%T
891: Article title of an
892: .Sx \&Rs
893: block. This macro may also be used in a non-bibliographical context
894: when referring to article titles.
1.64 kristaps 895: .
1.69 kristaps 896: .Ss \&%U
1.70 kristaps 897: URI of reference document.
1.69 kristaps 898: .
1.63 kristaps 899: .Ss \&%V
900: Volume number of an
901: .Sx \&Rs
902: block.
1.64 kristaps 903: .
1.63 kristaps 904: .Ss \&Ac
905: Closes an
906: .Sx \&Ao
907: block. Does not have any tail arguments.
1.64 kristaps 908: .
1.63 kristaps 909: .Ss \&Ad
910: Address construct: usually in the context of an computational address in
911: memory, not a physical (post) address.
912: .Pp
1.64 kristaps 913: Examples:
1.63 kristaps 914: .Bd -literal -offset indent
915: \&.Ad [0,$]
916: \&.Ad 0x00000000
917: .Ed
1.64 kristaps 918: .
1.63 kristaps 919: .Ss \&An
1.64 kristaps 920: Author name. This macro may alternatively accepts the following
921: arguments, although these may not be specified along with a parameter:
922: .Bl -tag -width 12n -offset indent
923: .It Fl split
1.66 kristaps 924: Renders a line break before each author listing.
1.64 kristaps 925: .It Fl nosplit
926: The opposite of
927: .Fl split .
928: .El
929: .Pp
930: In the AUTHORS section, the default is not to split the first author
931: listing, but all subsequent author listings, whether or not they're
932: interspersed by other macros or text, are split. Thus, specifying
933: .Fl split
934: will cause the first listing also to be split. If not in the AUTHORS
935: section, the default is not to split.
936: .Pp
937: Examples:
938: .Bd -literal -offset indent
939: \&.An -nosplit
940: \&.An J. E. Hopcraft ,
941: \&.An J. D. Ullman .
942: .Ed
943: .Pp
944: .Em Remarks :
945: the effects of
946: .Fl split
947: or
948: .Fl nosplit
949: are re-set when entering the AUTHORS section, so if one specifies
950: .Sx \&An Fl nosplit
951: in the general document body, it must be re-specified in the AUTHORS
952: section.
953: .
1.63 kristaps 954: .Ss \&Ao
955: Begins a block enclosed by angled brackets. Does not have any head
956: arguments.
957: .Pp
1.64 kristaps 958: Examples:
1.63 kristaps 959: .Bd -literal -offset indent
960: \&.Fl -key= Ns Ao Ar val Ac
961: .Ed
962: .Pp
1.64 kristaps 963: See also
964: .Sx \&Aq .
965: .
1.63 kristaps 966: .Ss \&Ap
1.64 kristaps 967: Inserts an apostrophe without any surrounding white-space. This is
968: generally used as a grammatic device when referring to the verb form of
969: a function:
970: .Bd -literal -offset indent
971: \&.Fn execve Ap d
972: .Ed
973: .
1.63 kristaps 974: .Ss \&Aq
1.64 kristaps 975: Encloses its arguments in angled brackets.
976: .Pp
977: Examples:
978: .Bd -literal -offset indent
979: \&.Fl -key= Ns Aq Ar val
980: .Ed
981: .Pp
982: .Em Remarks :
983: this macro is often abused for rendering URIs, which should instead use
984: .Sx \&Lk
985: or
986: .Sx \&Mt ,
987: or to note pre-processor
988: .Dq Li #include
989: statements, which should use
990: .Sx \&In .
991: .Pp
992: See also
993: .Sx \&Ao .
994: .
1.63 kristaps 995: .Ss \&Ar
1.66 kristaps 996: Command arguments. If an argument is not provided, the string
1.64 kristaps 997: .Dq file ...
1.66 kristaps 998: is used as a default.
1.64 kristaps 999: .Pp
1000: Examples:
1001: .Bd -literal -offset indent
1002: \&.Fl o Ns Ar file1
1003: \&.Ar
1004: \&.Ar arg1 , arg2 .
1005: .Ed
1006: .
1.63 kristaps 1007: .Ss \&At
1.64 kristaps 1008: Formats an AT&T version. Accepts at most one parameter:
1009: .Bl -tag -width 12n -offset indent
1010: .It Cm v[1-7] | 32v
1011: A version of
1012: .At .
1013: .It Cm V[.[1-4]]?
1014: A system version of
1015: .At .
1016: .El
1017: .Pp
1018: Note that these parameters do not begin with a hyphen.
1019: .Pp
1020: Examples:
1021: .Bd -literal -offset indent
1022: \&.At
1023: \&.At V.1
1024: .Ed
1.65 kristaps 1025: .Pp
1026: See also
1.66 kristaps 1027: .Sx \&Bsx ,
1.65 kristaps 1028: .Sx \&Bx ,
1.66 kristaps 1029: .Sx \&Dx ,
1.65 kristaps 1030: .Sx \&Fx ,
1031: .Sx \&Nx ,
1032: .Sx \&Ox ,
1033: and
1034: .Sx \&Ux .
1.64 kristaps 1035: .
1.63 kristaps 1036: .Ss \&Bc
1.64 kristaps 1037: Closes a
1038: .Sx \&Bo
1039: block. Does not have any tail arguments.
1040: .
1.63 kristaps 1041: .Ss \&Bd
1.64 kristaps 1042: Begins a display block. A display is collection of macros or text which
1043: may be collectively offset or justified in a manner different from that
1044: of the enclosing context. By default, the block is preceded by a
1045: vertical space.
1046: .Pp
1047: Each display is associated with a type, which must be one of the
1048: following arguments:
1049: .Bl -tag -width 12n -offset indent
1050: .It Fl ragged
1051: Only left-justify the block.
1052: .It Fl unfilled
1053: Do not justify the block at all.
1054: .It Fl filled
1055: Left- and right-justify the block.
1056: .It Fl literal
1057: Alias for
1058: .Fl unfilled .
1059: .It Fl centered
1060: Centre-justify each line.
1061: .El
1062: .Pp
1063: The type must be provided first. Secondary arguments are as follows:
1064: .Bl -tag -width 12n -offset indent
1065: .It Fl offset Ar width
1066: Offset by the value of
1067: .Ar width ,
1068: which is interpreted as one of the following, specified in order:
1069: .Bl -item
1070: .It
1071: As one of the pre-defined strings
1072: .Ar indent ,
1073: the width of standard indentation;
1074: .Ar indent-two ,
1075: twice
1076: .Ar indent ;
1077: .Ar left ,
1078: which has no effect ;
1079: .Ar right ,
1080: which justifies to the right margin; and
1081: .Ar center ,
1082: which aligns around an imagined centre axis.
1083: .It
1084: As a precalculated width for a named macro. The most popular is the
1085: imaginary macro
1.67 kristaps 1086: .Ar \&Ds ,
1.64 kristaps 1087: which resolves to
1088: .Ar 6n .
1089: .It
1090: As a scaling unit following the syntax described in
1091: .Sx Scaling Widths .
1092: .It
1093: As the calculated string length of the opaque string.
1094: .El
1095: .Pp
1096: If unset, it will revert to the value of
1097: .Ar 8n
1098: as described in
1099: .Sx Scaling Widths .
1100: .It Fl compact
1101: Do not assert a vertical space before the block.
1102: .It Fl file Ar file
1103: Prepend the file
1104: .Ar file
1105: before any text or macros within the block.
1106: .El
1107: .Pp
1108: Examples:
1109: .Bd -literal -offset indent
1110: \&.Bd \-unfilled \-offset two-indent \-compact
1.65 kristaps 1111: Hello world.
1.64 kristaps 1112: \&.Ed
1113: .Ed
1.66 kristaps 1114: .Pp
1115: See also
1116: .Sx \&D1
1117: and
1118: .Sx \&Dl .
1.64 kristaps 1119: .
1.63 kristaps 1120: .Ss \&Bf
1121: .Ss \&Bk
1122: .Ss \&Bl
1.65 kristaps 1123: .
1.63 kristaps 1124: .Ss \&Bo
1.65 kristaps 1125: Begins a block enclosed by square brackets. Does not have any head
1126: arguments.
1127: .Pp
1128: Examples:
1129: .Bd -literal -offset indent
1130: \&.Bo 1 ,
1131: \&.Dv BUFSIZ Bc
1132: .Ed
1133: .Pp
1134: See also
1135: .Sx \&Bq .
1136: .
1.63 kristaps 1137: .Ss \&Bq
1.65 kristaps 1138: Encloses its arguments in square brackets.
1139: .Pp
1140: Examples:
1141: .Bd -literal -offset indent
1142: \&.Bq 1 , Dv BUFSIZ
1143: .Ed
1144: .Pp
1145: .Em Remarks :
1146: this macro is sometimes abused to emulate optional arguments for
1147: commands; the correct macros to use for this purpose are
1148: .Sx \&Op ,
1149: .Sx \&Oo ,
1150: and
1151: .Sx \&Oc .
1152: .Pp
1153: See also
1154: .Sx \&Bo .
1155: .
1.63 kristaps 1156: .Ss \&Brc
1.65 kristaps 1157: Closes a
1158: .Sx \&Bro
1159: block. Does not have any tail arguments.
1160: .
1.63 kristaps 1161: .Ss \&Bro
1.65 kristaps 1162: Begins a block enclosed by curly braces. Does not have any head
1163: arguments.
1164: .Pp
1165: Examples:
1166: .Bd -literal -offset indent
1167: \&.Bro 1 , ... ,
1168: \&.Va n Brc
1169: .Ed
1170: .Pp
1171: See also
1172: .Sx \&Brq .
1173: .
1.63 kristaps 1174: .Ss \&Brq
1.65 kristaps 1175: Encloses its arguments in curly braces.
1176: .Pp
1177: Examples:
1178: .Bd -literal -offset indent
1179: \&.Brq 1 , ... , Va n
1180: .Ed
1181: .Pp
1182: See also
1183: .Sx \&Bro .
1184: .
1.63 kristaps 1185: .Ss \&Bsx
1.65 kristaps 1186: Format the BSD/OS version provided as an argument, or a default value if
1187: no argument is provided.
1188: .Pp
1189: Examples:
1190: .Bd -literal -offset indent
1191: \&.Bsx 1.0
1192: \&.Bsx
1193: .Ed
1194: .Pp
1195: See also
1196: .Sx \&At ,
1197: .Sx \&Bx ,
1.66 kristaps 1198: .Sx \&Dx ,
1.65 kristaps 1199: .Sx \&Fx ,
1200: .Sx \&Nx ,
1201: .Sx \&Ox ,
1202: and
1203: .Sx \&Ux .
1204: .
1.63 kristaps 1205: .Ss \&Bt
1.66 kristaps 1206: Prints
1207: .Dq is currently in beta test.
1208: .
1.63 kristaps 1209: .Ss \&Bx
1.65 kristaps 1210: Format the BSD version provided as an argument, or a default value if no
1211: argument is provided.
1212: .Pp
1213: Examples:
1214: .Bd -literal -offset indent
1215: \&.Bx 4.4
1216: \&.Bx
1217: .Ed
1218: .Pp
1219: See also
1220: .Sx \&At ,
1221: .Sx \&Bsx ,
1.66 kristaps 1222: .Sx \&Dx ,
1.65 kristaps 1223: .Sx \&Fx ,
1224: .Sx \&Nx ,
1225: .Sx \&Ox ,
1226: and
1227: .Sx \&Ux .
1228: .
1.63 kristaps 1229: .Ss \&Cd
1.66 kristaps 1230: Configuration declaration (suggested for use only in section four
1231: manuals). This denotes strings accepted by
1232: .Xr config 8 .
1233: .Pp
1234: Examples:
1235: .Bd -literal -offset indent
1236: \&.Cd device le0 at scode?
1237: .Ed
1238: .Pp
1239: .Em Remarks :
1240: this macro is commonly abused by using quoted literals to retain
1241: white-space and align consecutive
1242: .Sx \&Cd
1243: declarations. This practise is discouraged.
1244: .
1.63 kristaps 1245: .Ss \&Cm
1.66 kristaps 1246: Command modifiers. Useful when specifying configuration options or
1247: keys.
1248: .Pp
1249: Examples:
1250: .Bd -literal -offset indent
1251: \&.Cm ControlPath
1252: \&.Cm ControlMaster
1253: .Ed
1254: .Pp
1255: See also
1256: .Sx \&Fl .
1257: .
1.63 kristaps 1258: .Ss \&D1
1.66 kristaps 1259: One-line indented display. This is formatted by the default rules and
1260: is useful for simple indented statements. It is followed by a newline.
1261: .Pp
1262: Examples:
1263: .Bd -literal -offset indent
1264: \&.D1 Fl abcdefgh
1265: .Ed
1266: .Pp
1267: See also
1268: .Sx \&Bd
1269: and
1270: .Sx \&Dl .
1271: .
1.63 kristaps 1272: .Ss \&Db
1273: .Ss \&Dc
1.66 kristaps 1274: Closes a
1275: .Sx \&Do
1276: block. Does not have any tail arguments.
1277: .
1.63 kristaps 1278: .Ss \&Dd
1.66 kristaps 1279: Document date. This is the mandatory first macro of any
1280: .Nm
1281: manual. Its calling syntax is as follows:
1282: .Pp
1283: .D1 \. Ns Sx \&Dd Cm date
1284: .Pp
1285: The
1286: .Cm date
1287: field may be either
1288: .Ar $\&Mdocdate$ ,
1289: which signifies the current manual revision date dictated by
1.72 kristaps 1290: .Xr cvs 1 ,
1.66 kristaps 1291: or instead a valid canonical date as specified by
1292: .Sx Dates .
1.72 kristaps 1293: If a date does not conform, the current date is used instead.
1.66 kristaps 1294: .Pp
1295: Examples:
1296: .Bd -literal -offset indent
1297: \&.Dd $\&Mdocdate$
1298: \&.Dd $\&Mdocdate: July 21 2007$
1299: \&.Dd July 21, 2007
1300: .Ed
1301: .Pp
1302: See also
1303: .Sx \&Dt
1304: and
1305: .Sx \&Os .
1306: .
1.63 kristaps 1307: .Ss \&Dl
1.66 kristaps 1308: One-line intended display. This is formatted as literal text and is
1309: useful for commands and invocations. It is followed by a newline.
1310: .Pp
1311: Examples:
1312: .Bd -literal -offset indent
1313: \&.Dl % mandoc mdoc.7 | less
1314: .Ed
1315: .Pp
1316: See also
1317: .Sx \&Bd
1318: and
1319: .Sx \&D1 .
1320: .
1.63 kristaps 1321: .Ss \&Do
1.66 kristaps 1322: Begins a block enclosed by double quotes. Does not have any head
1323: arguments.
1324: .Pp
1325: Examples:
1326: .Bd -literal -offset indent
1327: \&.D1 Do April is the cruellest month Dc \e(em T.S. Eliot
1328: .Ed
1329: .Pp
1330: See also
1331: .Sx \&Dq .
1332: .
1.63 kristaps 1333: .Ss \&Dq
1.66 kristaps 1334: Encloses its arguments in double quotes.
1335: .Pp
1336: Examples:
1337: .Bd -literal -offset indent
1338: \&.Dq April is the cruellest month
1339: \e(em T.S. Eliot
1340: .Ed
1341: .Pp
1342: See also
1343: .Sx \&Do .
1344: .
1.63 kristaps 1345: .Ss \&Dt
1.66 kristaps 1346: Document title. This is the mandatory second macro of any
1347: .Nm
1348: file. Its calling syntax is as follows:
1349: .Pp
1350: .D1 \. Ns Sx \&Dt Cm title section Op Cm volume | arch
1351: .Pp
1352: Its arguments are as follows:
1353: .Bl -tag -width Ds -offset Ds
1354: .It Cm title
1355: The document's title (name). This should be capitalised and is
1356: required.
1357: .It Cm section
1358: The manual section. This may be one of
1359: .Ar 1
1360: .Pq utilities ,
1361: .Ar 2
1362: .Pq system calls ,
1363: .Ar 3
1364: .Pq libraries ,
1365: .Ar 3p
1366: .Pq Perl libraries ,
1367: .Ar 4
1368: .Pq devices ,
1369: .Ar 5
1370: .Pq file formats ,
1371: .Ar 6
1372: .Pq games ,
1373: .Ar 7
1374: .Pq miscellaneous ,
1375: .Ar 8
1376: .Pq system utilities ,
1377: .Ar 9
1378: .Pq kernel functions ,
1379: .Ar X11
1380: .Pq X Window System ,
1381: .Ar X11R6
1382: .Pq X Window System ,
1383: .Ar unass
1384: .Pq unassociated ,
1385: .Ar local
1386: .Pq local system ,
1387: .Ar draft
1388: .Pq draft manual ,
1389: or
1390: .Ar paper
1391: .Pq paper .
1392: It is also required and should correspond to the manual's filename
1393: suffix.
1394: .It Cm volume
1395: This overrides the volume inferred from
1396: .Ar section .
1397: This field is optional, and if specified, must be one of
1398: .Ar USD
1399: .Pq users' supplementary documents ,
1400: .Ar PS1
1401: .Pq programmers' supplementary documents ,
1402: .Ar AMD
1403: .Pq administrators' supplementary documents ,
1404: .Ar SMM
1405: .Pq system managers' manuals ,
1406: .Ar URM
1407: .Pq users' reference manuals ,
1408: .Ar PRM
1409: .Pq programmers' reference manuals ,
1410: .Ar KM
1411: .Pq kernel manuals ,
1412: .Ar IND
1413: .Pq master index ,
1414: .Ar MMI
1415: .Pq master index ,
1416: .Ar LOCAL
1417: .Pq local manuals ,
1418: .Ar LOC
1419: .Pq local manuals ,
1420: or
1421: .Ar CON
1422: .Pq contributed manuals .
1423: .It Cm arch
1424: This specifies a specific relevant architecture. If
1425: .Cm volume
1426: is not provided, it may be used in its place, else it may be used
1427: subsequent that. It, too, is optional. It must be one of
1428: .Ar alpha ,
1429: .Ar amd64 ,
1430: .Ar amiga ,
1431: .Ar arc ,
1432: .Ar arm ,
1433: .Ar armish ,
1434: .Ar aviion ,
1435: .Ar hp300 ,
1436: .Ar hppa ,
1437: .Ar hppa64 ,
1438: .Ar i386 ,
1439: .Ar landisk ,
1440: .Ar luna88k ,
1441: .Ar mac68k ,
1442: .Ar macppc ,
1443: .Ar mvme68k ,
1444: .Ar mvme88k ,
1445: .Ar mvmeppc ,
1446: .Ar pmax ,
1447: .Ar sgi ,
1448: .Ar socppc ,
1449: .Ar sparc ,
1450: .Ar sparc64 ,
1451: .Ar sun3 ,
1452: .Ar vax ,
1453: or
1454: .Ar zaurus .
1455: .El
1456: .Pp
1457: Examples:
1458: .Bd -literal -offset indent
1459: \&.Dt FOO 1
1460: \&.Dt FOO 4 KM
1461: \&.Dt FOO 9 i386
1462: \&.Dt FOO 9 KM i386
1463: .Ed
1464: .Pp
1465: See also
1466: .Sx \&Dd
1467: and
1468: .Sx \&Os .
1469: .
1.63 kristaps 1470: .Ss \&Dv
1.66 kristaps 1471: Defined variables such as preprocessor constants.
1472: .Pp
1473: Examples:
1474: .Bd -literal -offset indent
1475: \&.Dv BUFSIZ
1476: \&.Dv STDOUT_FILENO
1477: .Ed
1478: .Pp
1479: See also
1480: .Sx \&Er .
1481: .
1.63 kristaps 1482: .Ss \&Dx
1.71 kristaps 1483: Format the DragonFly BSD version provided as an argument, or a default
1.66 kristaps 1484: value if no argument is provided.
1485: .Pp
1486: Examples:
1487: .Bd -literal -offset indent
1488: \&.Dx 2.4.1
1489: \&.Dx
1490: .Ed
1491: .Pp
1492: See also
1493: .Sx \&At ,
1494: .Sx \&Bsx ,
1495: .Sx \&Bx ,
1496: .Sx \&Fx ,
1497: .Sx \&Nx ,
1498: .Sx \&Ox ,
1499: and
1500: .Sx \&Ux .
1501: .
1.63 kristaps 1502: .Ss \&Ec
1503: .Ss \&Ed
1504: .Ss \&Ef
1505: .Ss \&Ek
1506: .Ss \&El
1507: .Ss \&Em
1.66 kristaps 1508: Denotes text that should be emphasised. Note that this is a
1509: presentation term and should not be used for stylistically decorating
1510: technical terms.
1511: .Pp
1512: Examples:
1513: .Bd -literal -offset indent
1514: \&.Ed Warnings!
1515: \&.Ed Remarks :
1516: .Ed
1517: .
1.63 kristaps 1518: .Ss \&En
1519: .Ss \&Eo
1520: .Ss \&Er
1.66 kristaps 1521: Error constants (suggested for use only in section two manuals).
1522: .Pp
1523: Examples:
1524: .Bd -literal -offset indent
1525: \&.Er EPERM
1526: \&.Er ENOENT
1527: .Ed
1528: .Pp
1529: See also
1530: .Sx \&Dv .
1531: .
1.63 kristaps 1532: .Ss \&Es
1.66 kristaps 1533: .
1.63 kristaps 1534: .Ss \&Ev
1.66 kristaps 1535: Environmental variables such as those specified in
1536: .Xr environ 7 .
1537: .Pp
1538: Examples:
1539: .Bd -literal -offset indent
1540: \&.Ev DISPLAY
1541: \&.Ev PATH
1542: .Ed
1543: .
1.63 kristaps 1544: .Ss \&Ex
1.66 kristaps 1545: Inserts text regarding a utility's exit values. This macro must have
1546: first the
1547: .Fl std
1548: argument specified, then an optional
1549: .Ar utility .
1550: If
1551: .Ar utility
1552: is not provided, the document's name as stipulated in
1553: .Sx \&Nm
1554: is provided.
1.63 kristaps 1555: .Ss \&Fa
1556: .Ss \&Fc
1557: .Ss \&Fd
1558: .Ss \&Fl
1559: .Ss \&Fn
1560: .Ss \&Fo
1561: .Ss \&Fr
1562: .Ss \&Ft
1563: .Ss \&Fx
1.65 kristaps 1564: Format the FreeBSD version provided as an argument, or a default value
1565: if no argument is provided.
1566: .Pp
1567: Examples:
1568: .Bd -literal -offset indent
1569: \&.Fx 7.1
1570: \&.Fx
1571: .Ed
1572: .Pp
1573: See also
1574: .Sx \&At ,
1.66 kristaps 1575: .Sx \&Bsx ,
1.65 kristaps 1576: .Sx \&Bx ,
1.66 kristaps 1577: .Sx \&Dx ,
1.65 kristaps 1578: .Sx \&Nx ,
1579: .Sx \&Ox ,
1580: and
1581: .Sx \&Ux .
1582: .
1.63 kristaps 1583: .Ss \&Hf
1584: .Ss \&Ic
1585: .Ss \&In
1586: .Ss \&It
1587: .Ss \&Lb
1588: .Ss \&Li
1589: .Ss \&Lk
1.70 kristaps 1590: Format a hyperlink. The calling syntax is as follows:
1591: .Pp
1592: .D1 \. Ns Sx \&Lk Cm uri Op Cm name
1593: .Pp
1594: Examples:
1595: .Bd -literal -offset indent
1596: \&.Lk http://bsd.lv "The BSD.lv Project"
1597: \&.Lk http://bsd.lv
1598: .Ed
1599: .Pp
1600: See also
1601: .Sx \&Mt .
1602: .
1.63 kristaps 1603: .Ss \&Lp
1604: .Ss \&Ms
1605: .Ss \&Mt
1606: .Ss \&Nd
1607: .Ss \&Nm
1608: .Ss \&No
1609: .Ss \&Ns
1610: .Ss \&Nx
1.65 kristaps 1611: Format the NetBSD version provided as an argument, or a default value if
1612: no argument is provided.
1613: .Pp
1614: Examples:
1615: .Bd -literal -offset indent
1616: \&.Nx 5.01
1617: \&.Nx
1618: .Ed
1619: .Pp
1620: See also
1621: .Sx \&At ,
1.66 kristaps 1622: .Sx \&Bsx ,
1.65 kristaps 1623: .Sx \&Bx ,
1.66 kristaps 1624: .Sx \&Dx ,
1.65 kristaps 1625: .Sx \&Fx ,
1626: .Sx \&Ox ,
1627: and
1628: .Sx \&Ux .
1629: .
1.63 kristaps 1630: .Ss \&Oc
1631: .Ss \&Oo
1632: .Ss \&Op
1633: .Ss \&Os
1.66 kristaps 1634: Document operating system version. This is the mandatory third macro of
1635: any
1636: .Nm
1637: file. Its calling syntax is as follows:
1638: .Pp
1639: .D1 \. Ns Sx \&Os Op Cm system
1640: .Pp
1641: The optional
1642: .Cm system
1643: parameter specifies the relevant operating system or environment. Left
1644: unspecified, it defaults to the local operating system version. This is
1645: the suggested form.
1646: .Pp
1647: Examples:
1648: .Bd -literal -offset indent
1649: \&.Os
1650: \&.Os KTH/CSC/TCS
1651: \&.Os BSD 4.3
1652: .Ed
1653: .Pp
1654: See also
1655: .Sx \&Dd
1656: and
1657: .Sx \&Dt .
1658: .
1.63 kristaps 1659: .Ss \&Ot
1.66 kristaps 1660: Unknown usage.
1661: .Pp
1662: .Em Remarks :
1663: this macro has been deprecated.
1664: .
1.63 kristaps 1665: .Ss \&Ox
1.65 kristaps 1666: Format the OpenBSD version provided as an argument, or a default value
1667: if no argument is provided.
1668: .Pp
1669: Examples:
1670: .Bd -literal -offset indent
1671: \&.Ox 4.5
1672: \&.Ox
1673: .Ed
1674: .Pp
1675: See also
1676: .Sx \&At ,
1677: .Sx \&Bsx ,
1678: .Sx \&Bx ,
1.66 kristaps 1679: .Sx \&Dx ,
1.65 kristaps 1680: .Sx \&Fx ,
1681: .Sx \&Nx ,
1682: and
1683: .Sx \&Ux .
1684: .
1.63 kristaps 1685: .Ss \&Pa
1686: .Ss \&Pc
1687: .Ss \&Pf
1688: .Ss \&Po
1689: .Ss \&Pp
1690: .Ss \&Pq
1691: .Ss \&Qc
1692: .Ss \&Ql
1693: .Ss \&Qo
1694: .Ss \&Qq
1.64 kristaps 1695: .
1.63 kristaps 1696: .Ss \&Re
1697: Closes a
1698: .Sx \&Rs
1699: block. Does not have any tail arguments.
1.64 kristaps 1700: .
1.63 kristaps 1701: .Ss \&Rs
1702: Begins a bibliographic
1703: .Pq Dq reference
1.68 kristaps 1704: block. Does not have any head arguments. The block macro may only
1.63 kristaps 1705: contain
1706: .Sx \&%A ,
1707: .Sx \&%B ,
1708: .Sx \&%C ,
1709: .Sx \&%D ,
1710: .Sx \&%I ,
1711: .Sx \&%J ,
1712: .Sx \&%N ,
1713: .Sx \&%O ,
1714: .Sx \&%P ,
1715: .Sx \&%Q ,
1716: .Sx \&%R ,
1717: .Sx \&%T ,
1718: and
1719: .Sx \&%V
1720: child macros (at least one must be specified).
1721: .Pp
1.64 kristaps 1722: Examples:
1.63 kristaps 1723: .Bd -literal -offset indent
1724: \&.Rs
1725: \&.%A J. E. Hopcroft
1726: \&.%A J. D. Ullman
1727: \&.%B Introduction to Automata Theory, Languages, and Computation
1728: \&.%I Addison-Wesley
1729: \&.%C Reading, Massachusettes
1730: \&.%D 1979
1731: \&.Re
1732: .Ed
1733: .Pp
1734: If an
1735: .Sx \&Rs
1736: block is used within a SEE ALSO section, a vertical space is asserted
1737: before the rendered output, else the block continues on the current
1738: line.
1.64 kristaps 1739: .
1.63 kristaps 1740: .Ss \&Rv
1741: .Ss \&Sc
1742: .Ss \&Sh
1743: .Ss \&Sm
1744: .Ss \&So
1745: .Ss \&Sq
1746: .Ss \&Ss
1747: .Ss \&St
1748: .Ss \&Sx
1749: .Ss \&Sy
1750: .Ss \&Tn
1751: .Ss \&Ud
1752: .Ss \&Ux
1.65 kristaps 1753: Format the UNIX name. Accepts no argument.
1754: .Pp
1755: Examples:
1756: .Bd -literal -offset indent
1757: \&.Ux
1758: .Ed
1759: .Pp
1760: See also
1761: .Sx \&At ,
1.66 kristaps 1762: .Sx \&Bsx ,
1.65 kristaps 1763: .Sx \&Bx ,
1.66 kristaps 1764: .Sx \&Dx ,
1.65 kristaps 1765: .Sx \&Fx ,
1766: .Sx \&Nx ,
1767: and
1768: .Sx \&Ox .
1769: .
1.63 kristaps 1770: .Ss \&Va
1771: .Ss \&Vt
1772: .Ss \&Xc
1773: .Ss \&Xo
1774: .Ss \&Xr
1775: .Ss \&br
1776: .Ss \&sp
1777: .
1778: .
1.4 kristaps 1779: .Sh COMPATIBILITY
1.28 kristaps 1780: This section documents compatibility with other roff implementations, at
1.50 kristaps 1781: this time limited to
1.57 kristaps 1782: .Xr groff 1 .
1.50 kristaps 1783: The term
1.57 kristaps 1784: .Qq historic groff
1.50 kristaps 1785: refers to those versions before the
1.57 kristaps 1786: .Pa doc.tmac
1.50 kristaps 1787: file re-write
1.57 kristaps 1788: .Pq somewhere between 1.15 and 1.19 .
1789: .
1790: .Pp
1791: .Bl -dash -compact
1792: .It
1.61 kristaps 1793: Negative scaling units are now truncated to zero instead of creating
1794: interesting conditions, such as with
1795: .Sq \&sp -1i .
1796: Furthermore, the
1797: .Sq f
1798: scaling unit, while accepted, is rendered as the default unit.
1799: .It
1.48 kristaps 1800: In quoted literals, groff allowed pair-wise double-quotes to produce a
1801: standalone double-quote in formatted output. This idiosyncratic
1802: behaviour is no longer applicable.
1.57 kristaps 1803: .It
1.64 kristaps 1804: Display types
1805: .Sx \&Bd Fl center
1806: and
1807: .Fl right
1808: are aliases for
1809: .Fl left .
1.50 kristaps 1810: The
1.64 kristaps 1811: .Fl file Ar file
1812: argument is ignored. Since text is not right-justified,
1813: .Fl ragged
1814: and
1815: .Fl filled
1816: are aliases, as are
1817: .Fl literal
1818: and
1819: .Fl unfilled .
1.57 kristaps 1820: .It
1.35 kristaps 1821: Blocks of whitespace are stripped from both macro and free-form text
1822: lines (except when in literal mode), while groff would retain whitespace
1823: in free-form text lines.
1.57 kristaps 1824: .It
1.28 kristaps 1825: Historic groff has many un-callable macros. Most of these (excluding
1826: some block-level macros) are now callable, conforming to the
1827: non-historic groff version.
1.57 kristaps 1828: .It
1.50 kristaps 1829: The vertical bar
1.57 kristaps 1830: .Sq \(ba
1.28 kristaps 1831: made historic groff
1.57 kristaps 1832: .Qq go orbital
1.28 kristaps 1833: but is a proper delimiter in this implementation.
1.57 kristaps 1834: .It
1.64 kristaps 1835: .Sx \&It Fl nested
1.28 kristaps 1836: is assumed for all lists (it wasn't in historic groff): any list may be
1837: nested and
1.64 kristaps 1838: .Fl enum
1.4 kristaps 1839: lists will restart the sequence only for the sub-list.
1.57 kristaps 1840: .It
1.4 kristaps 1841: Some manuals use
1.64 kristaps 1842: .Sx \&Li
1.4 kristaps 1843: incorrectly by following it with a reserved character and expecting the
1844: delimiter to render. This is not supported.
1.57 kristaps 1845: .It
1.50 kristaps 1846: In groff, the
1.64 kristaps 1847: .Sx \&Fo
1.41 kristaps 1848: macro only produces the first parameter. This is no longer the case.
1.57 kristaps 1849: .El
1.56 kristaps 1850: .
1851: .
1.2 kristaps 1852: .Sh SEE ALSO
1.57 kristaps 1853: .Xr mandoc 1 ,
1854: .Xr mandoc_char 7
1.56 kristaps 1855: .
1856: .
1.2 kristaps 1857: .Sh AUTHORS
1858: The
1.57 kristaps 1859: .Nm
1.50 kristaps 1860: reference was written by
1.57 kristaps 1861: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.64 kristaps 1862: .\"
1863: .\" XXX: this really isn't the place for these caveats.
1864: .\" .
1865: .\" .
1866: .\" .Sh CAVEATS
1867: .\" There are many ambiguous parts of mdoc.
1868: .\" .
1869: .\" .Pp
1870: .\" .Bl -dash -compact
1871: .\" .It
1872: .\" .Sq \&Fa
1873: .\" should be
1874: .\" .Sq \&Va
1875: .\" as function arguments are variables.
1876: .\" .It
1877: .\" .Sq \&Ft
1878: .\" should be
1879: .\" .Sq \&Vt
1880: .\" as function return types are still types. Furthermore, the
1881: .\" .Sq \&Ft
1882: .\" should be removed and
1883: .\" .Sq \&Fo ,
1884: .\" which ostensibly follows it, should follow the same convention as
1885: .\" .Sq \&Va .
1886: .\" .It
1887: .\" .Sq \&Va
1888: .\" should formalise that only one or two arguments are acceptable: a
1889: .\" variable name and optional, preceding type.
1890: .\" .It
1891: .\" .Sq \&Fd
1892: .\" is ambiguous. It's commonly used to indicate an include file in the
1893: .\" synopsis section.
1894: .\" .Sq \&In
1895: .\" should be used, instead.
1896: .\" .It
1897: .\" Only the
1898: .\" .Sq \-literal
1899: .\" argument to
1900: .\" .Sq \&Bd
1901: .\" makes sense. The remaining ones should be removed.
1902: .\" .It
1903: .\" The
1904: .\" .Sq \&Xo
1905: .\" and
1906: .\" .Sq \&Xc
1907: .\" macros should be deprecated.
1908: .\" .It
1909: .\" The
1910: .\" .Sq \&Dt
1911: .\" macro lacks clarity. It should be absolutely clear which title will
1912: .\" render when formatting the manual page.
1913: .\" .It
1914: .\" A
1915: .\" .Sq \&Lx
1916: .\" should be provided for Linux (\(`a la
1917: .\" .Sq \&Ox ,
1918: .\" .Sq \&Nx
1919: .\" etc.).
1920: .\" .It
1921: .\" There's no way to refer to references in
1922: .\" .Sq \&Rs/Re
1923: .\" blocks.
1924: .\" .It
1925: .\" The \-split and \-nosplit dictates via
1926: .\" .Sq \&An
1927: .\" are re-set when entering and leaving the AUTHORS section.
1928: .\" .El
1929: .\" .
CVSweb