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