Annotation of mandoc/mdoc.7, Revision 1.127
1.127 ! schwarze 1: .\" $Id: mdoc.7,v 1.126 2010/06/12 11:41:50 kristaps Exp $
1.1 kristaps 2: .\"
1.94 kristaps 3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>
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.126 kristaps 17: .Dd $Mdocdate: June 12 2010 $
1.20 kristaps 18: .Dt MDOC 7
1.1 kristaps 19: .Os
20: .Sh NAME
1.57 kristaps 21: .Nm mdoc
22: .Nd mdoc language reference
1.1 kristaps 23: .Sh DESCRIPTION
24: The
1.57 kristaps 25: .Nm mdoc
1.50 kristaps 26: language is used to format
1.57 kristaps 27: .Bx
28: .Ux
1.43 kristaps 29: manuals. In this reference document, we describe its syntax, structure,
1.93 kristaps 30: and usage. Our reference implementation is mandoc; the
1.57 kristaps 31: .Sx COMPATIBILITY
1.93 kristaps 32: section describes compatibility with other troff \-mdoc implementations.
1.57 kristaps 33: .Pp
1.13 kristaps 34: An
1.57 kristaps 35: .Nm
1.118 kristaps 36: document follows simple rules: lines beginning with the control
1.50 kristaps 37: character
1.57 kristaps 38: .Sq \.
1.1 kristaps 39: are parsed for macros. Other lines are interpreted within the scope of
1.13 kristaps 40: prior macros:
1.57 kristaps 41: .Bd -literal -offset indent
1.13 kristaps 42: \&.Sh Macro lines change control state.
43: Other lines are interpreted within the current state.
1.57 kristaps 44: .Ed
1.46 kristaps 45: .Sh LANGUAGE SYNTAX
1.57 kristaps 46: .Nm
1.13 kristaps 47: documents may contain only graphable 7-bit ASCII characters, the space
1.43 kristaps 48: character, and, in certain circumstances, the tab character. All
49: manuals must have
1.57 kristaps 50: .Ux
1.50 kristaps 51: line terminators.
1.57 kristaps 52: .Ss Comments
1.43 kristaps 53: Text following a
1.57 kristaps 54: .Sq \e" ,
1.43 kristaps 55: whether in a macro or free-form text line, is ignored to the end of
56: line. A macro line with only a control character and comment escape,
1.57 kristaps 57: .Sq \&.\e" ,
1.124 kristaps 58: is also ignored. Macro lines with only a control character and optionally
1.58 kristaps 59: whitespace are stripped from input.
1.57 kristaps 60: .Ss Reserved Characters
1.2 kristaps 61: Within a macro line, the following characters are reserved:
1.61 kristaps 62: .Pp
1.57 kristaps 63: .Bl -tag -width Ds -offset indent -compact
64: .It \&.
65: .Pq period
66: .It \&,
67: .Pq comma
68: .It \&:
69: .Pq colon
70: .It \&;
71: .Pq semicolon
72: .It \&(
73: .Pq left-parenthesis
74: .It \&)
75: .Pq right-parenthesis
76: .It \&[
77: .Pq left-bracket
78: .It \&]
79: .Pq right-bracket
80: .It \&?
81: .Pq question
82: .It \&!
83: .Pq exclamation
84: .It \&|
85: .Pq vertical bar
86: .El
87: .Pp
1.5 kristaps 88: Use of reserved characters is described in
1.57 kristaps 89: .Sx MACRO SYNTAX .
1.43 kristaps 90: For general use in macro lines, these characters must either be escaped
91: with a non-breaking space
1.57 kristaps 92: .Pq Sq \e&
1.50 kristaps 93: or, if applicable, an appropriate escape sequence used.
1.57 kristaps 94: .Ss Special Characters
1.43 kristaps 95: Special characters may occur in both macro and free-form lines.
96: Sequences begin with the escape character
1.57 kristaps 97: .Sq \e
1.50 kristaps 98: followed by either an open-parenthesis
1.57 kristaps 99: .Sq \&(
1.1 kristaps 100: for two-character sequences; an open-bracket
1.57 kristaps 101: .Sq \&[
1.1 kristaps 102: for n-character sequences (terminated at a close-bracket
1.57 kristaps 103: .Sq \&] ) ;
1.100 kristaps 104: or a single one-character sequence.
105: See
1.57 kristaps 106: .Xr mandoc_char 7
1.100 kristaps 107: for a complete list.
108: Examples include
1.57 kristaps 109: .Sq \e(em
110: .Pq em-dash
1.50 kristaps 111: and
1.57 kristaps 112: .Sq \ee
113: .Pq back-slash .
114: .Ss Text Decoration
1.54 kristaps 115: Terms may be text-decorated using the
1.57 kristaps 116: .Sq \ef
1.74 kristaps 117: escape followed by an indicator: B (bold), I, (italic), R (Roman), or P
1.82 kristaps 118: (revert to previous mode):
1.75 kristaps 119: .Pp
1.76 kristaps 120: .D1 \efBbold\efR \efIitalic\efP
121: .Pp
122: A numerical representation 3, 2, or 1 (bold, italic, and Roman,
1.100 kristaps 123: respectively) may be used instead.
124: A text decoration is valid within
1.118 kristaps 125: the current font scope only: if a macro opens a font scope alongside
1.77 kristaps 126: its own scope, such as
1.78 kristaps 127: .Sx \&Bf
1.77 kristaps 128: .Cm \&Sy ,
129: in-scope invocations of
130: .Sq \ef
1.100 kristaps 131: are only valid within the font scope of the macro.
132: If
1.77 kristaps 133: .Sq \ef
134: is specified outside of any font scope, such as in unenclosed, free-form
135: text, it will affect the remainder of the document.
1.76 kristaps 136: .Pp
137: Text may also be sized with the
138: .Sq \es
139: escape, whose syntax is one of
140: .Sq \es+-n
141: for one-digit numerals;
142: .Sq \es(+-nn
143: or
144: .Sq \es+-(nn
145: for two-digit numerals; and
146: .Sq \es[+-N] ,
147: .Sq \es+-[N] ,
148: .Sq \es'+-N' ,
149: or
150: .Sq \es+-'N'
151: for arbitrary-digit numerals:
152: .Pp
153: .D1 \es+1bigger\es-1
154: .D1 \es[+10]much bigger\es[-10]
155: .D1 \es+(10much bigger\es-(10
156: .D1 \es+'100'much much bigger\es-'100'
157: .Pp
1.82 kristaps 158: Note these forms are
1.76 kristaps 159: .Em not
1.82 kristaps 160: recommended for
1.57 kristaps 161: .Nm ,
1.74 kristaps 162: which encourages semantic annotation.
1.57 kristaps 163: .Ss Predefined Strings
1.82 kristaps 164: Historically,
1.57 kristaps 165: .Xr groff 1
1.82 kristaps 166: also defined a set of package-specific
1.57 kristaps 167: .Dq predefined strings ,
1.82 kristaps 168: which, like
1.57 kristaps 169: .Sx Special Characters ,
1.124 kristaps 170: mark special output characters and strings by way of input codes.
1.54 kristaps 171: Predefined strings are escaped with the slash-asterisk,
1.57 kristaps 172: .Sq \e* :
1.54 kristaps 173: single-character
1.57 kristaps 174: .Sq \e*X ,
1.54 kristaps 175: two-character
1.57 kristaps 176: .Sq \e*(XX ,
1.54 kristaps 177: and N-character
1.57 kristaps 178: .Sq \e*[N] .
1.54 kristaps 179: See
1.57 kristaps 180: .Xr mandoc_char 7
1.100 kristaps 181: for a complete list.
182: Examples include
1.57 kristaps 183: .Sq \e*(Am
184: .Pq ampersand
1.54 kristaps 185: and
1.57 kristaps 186: .Sq \e*(Ba
187: .Pq vertical bar .
188: .Ss Whitespace
1.98 kristaps 189: Whitespace consists of the space character.
1.96 kristaps 190: In free-form lines, whitespace is preserved within a line; un-escaped
191: trailing spaces are stripped from input (unless in a literal context).
1.97 kristaps 192: Blank free-form lines, which may include whitespace, are only permitted
1.96 kristaps 193: within literal contexts.
1.57 kristaps 194: .Pp
1.100 kristaps 195: In macro lines, whitespace delimits arguments and is discarded.
196: If arguments are quoted, whitespace within the quotes is retained.
1.57 kristaps 197: .Ss Quotation
1.46 kristaps 198: Macro arguments may be quoted with a double-quote to group
1.100 kristaps 199: space-delimited terms or to retain blocks of whitespace.
200: A quoted argument begins with a double-quote preceded by whitespace.
201: The next double-quote not pair-wise adjacent to another double-quote
202: terminates the literal, regardless of surrounding whitespace.
1.57 kristaps 203: .Pp
1.50 kristaps 204: This produces tokens
1.57 kristaps 205: .Sq a" ,
206: .Sq b c ,
207: .Sq de ,
1.47 kristaps 208: and
1.57 kristaps 209: .Sq fg" .
1.47 kristaps 210: Note that any quoted term, be it argument or macro, is indiscriminately
1.100 kristaps 211: considered literal text.
212: Thus, the following produces
1.57 kristaps 213: .Sq \&Em a :
214: .Bd -literal -offset indent
1.47 kristaps 215: \&.Em "Em a"
1.57 kristaps 216: .Ed
217: .Pp
1.46 kristaps 218: In free-form mode, quotes are regarded as opaque text.
1.63 kristaps 219: .Ss Dates
1.66 kristaps 220: There are several macros in
221: .Nm
1.100 kristaps 222: that require a date argument.
223: The canonical form for dates is the American format:
1.66 kristaps 224: .Pp
225: .D1 Cm Month Day , Year
226: .Pp
227: The
228: .Cm Day
1.100 kristaps 229: value is an optionally zero-padded numeral.
230: The
1.66 kristaps 231: .Cm Month
1.100 kristaps 232: value is the full month name.
233: The
1.66 kristaps 234: .Cm Year
235: value is the full four-digit year.
236: .Pp
1.72 kristaps 237: Reduced form dates are broken-down canonical form dates:
1.66 kristaps 238: .Pp
1.72 kristaps 239: .D1 Cm Month , Year
240: .D1 Cm Year
1.66 kristaps 241: .Pp
242: Some examples of valid dates follow:
243: .Pp
244: .D1 "May, 2009" Pq reduced form
245: .D1 "2009" Pq reduced form
246: .D1 "May 20, 2009" Pq canonical form
1.61 kristaps 247: .Ss Scaling Widths
248: Many macros support scaled widths for their arguments, such as
249: stipulating a two-inch list indentation with the following:
250: .Bd -literal -offset indent
251: \&.Bl -tag -width 2i
252: .Ed
253: .Pp
254: The syntax for scaled widths is
1.62 kristaps 255: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
1.61 kristaps 256: where a decimal must be preceded or proceeded by at least one digit.
1.100 kristaps 257: Negative numbers, while accepted, are truncated to zero.
258: The following scaling units are accepted:
1.61 kristaps 259: .Pp
260: .Bl -tag -width Ds -offset indent -compact
261: .It c
262: centimetre
263: .It i
264: inch
265: .It P
266: pica (~1/6 inch)
267: .It p
268: point (~1/72 inch)
269: .It f
270: synonym for
271: .Sq u
272: .It v
273: default vertical span
274: .It m
275: width of rendered
276: .Sq m
277: .Pq em
278: character
279: .It n
280: width of rendered
281: .Sq n
282: .Pq en
283: character
284: .It u
285: default horizontal span
286: .It M
287: mini-em (~1/100 em)
288: .El
289: .Pp
290: Using anything other than
291: .Sq m ,
292: .Sq n ,
293: .Sq u ,
294: or
295: .Sq v
1.100 kristaps 296: is necessarily non-portable across output media.
297: See
1.61 kristaps 298: .Sx COMPATIBILITY .
1.101 kristaps 299: .Ss Sentence Spacing
300: When composing a manual, make sure that your sentences end at the end of
301: a line.
302: By doing so, front-ends will be able to apply the proper amount of
303: spacing after the end of sentence (unescaped) period, exclamation mark,
1.107 kristaps 304: or question mark followed by zero or more non-sentence closing
305: delimiters (
306: .Ns Sq \&) ,
307: .Sq \&] ,
308: .Sq \&' ,
309: .Sq \&" ) .
1.102 kristaps 310: .Pp
311: The proper spacing is also intelligently preserved if a sentence ends at
1.107 kristaps 312: the boundary of a macro line, e.g.,
313: .Pp
314: .D1 \&Xr mandoc 1 \.
315: .D1 \&Fl T \&Ns \&Cm ascii \.
1.43 kristaps 316: .Sh MANUAL STRUCTURE
1.66 kristaps 317: A well-formed
1.57 kristaps 318: .Nm
1.66 kristaps 319: document consists of a document prologue followed by one or more
320: sections.
321: .Pp
322: The prologue, which consists of (in order) the
1.64 kristaps 323: .Sx \&Dd ,
324: .Sx \&Dt ,
1.33 kristaps 325: and
1.66 kristaps 326: .Sx \&Os
327: macros, is required for every document.
328: .Pp
1.82 kristaps 329: The first section (sections are denoted by
1.66 kristaps 330: .Sx \&Sh )
331: must be the NAME section, consisting of at least one
1.64 kristaps 332: .Sx \&Nm
1.50 kristaps 333: followed by
1.66 kristaps 334: .Sx \&Nd .
335: .Pp
1.122 kristaps 336: Following that, convention dictates specifying at least the
337: .Em SYNOPSIS
338: and
339: .Em DESCRIPTION
340: sections, although this varies between manual sections.
1.66 kristaps 341: .Pp
342: The following is a well-formed skeleton
343: .Nm
344: file:
1.57 kristaps 345: .Bd -literal -offset indent
1.43 kristaps 346: \&.Dd $\&Mdocdate$
347: \&.Dt mdoc 7
348: \&.Os
349: \&.Sh NAME
1.58 kristaps 350: \&.Nm foo
351: \&.Nd a description goes here
1.108 kristaps 352: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.58 kristaps 353: \&.\e\*q .Sh LIBRARY
354: \&.Sh SYNOPSIS
355: \&.Nm foo
356: \&.Op Fl options
357: \&.Ar
358: \&.Sh DESCRIPTION
359: The
360: \&.Nm
361: utility processes files ...
1.59 kristaps 362: \&.\e\*q .Sh IMPLEMENTATION NOTES
1.58 kristaps 363: \&.\e\*q The next is for sections 2, 3, & 9 only.
364: \&.\e\*q .Sh RETURN VALUES
365: \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
366: \&.\e\*q .Sh ENVIRONMENT
367: \&.\e\*q .Sh FILES
1.99 kristaps 368: \&.\e\*q The next is for sections 1 & 8 only.
369: \&.\e\*q .Sh EXIT STATUS
1.58 kristaps 370: \&.\e\*q .Sh EXAMPLES
371: \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
372: \&.\e\*q .Sh DIAGNOSTICS
373: \&.\e\*q The next is for sections 2, 3, & 9 only.
374: \&.\e\*q .Sh ERRORS
375: \&.\e\*q .Sh SEE ALSO
376: \&.\e\*q .Xr foobar 1
377: \&.\e\*q .Sh STANDARDS
378: \&.\e\*q .Sh HISTORY
379: \&.\e\*q .Sh AUTHORS
380: \&.\e\*q .Sh CAVEATS
381: \&.\e\*q .Sh BUGS
382: \&.\e\*q .Sh SECURITY CONSIDERATIONS
1.57 kristaps 383: .Ed
384: .Pp
1.66 kristaps 385: The sections in a
386: .Nm
1.100 kristaps 387: document are conventionally ordered as they appear above.
388: Sections should be composed as follows:
1.73 kristaps 389: .Bl -ohang -offset Ds
390: .It Em NAME
1.100 kristaps 391: The name(s) and a short description of the documented material.
392: The syntax for this as follows:
1.73 kristaps 393: .Bd -literal -offset indent
394: \&.Nm name0
395: \&.Nm name1
396: \&.Nm name2
397: \&.Nd a short description
398: .Ed
399: .Pp
400: The
1.66 kristaps 401: .Sx \&Nm
1.73 kristaps 402: macro(s) must precede the
403: .Sx \&Nd
404: macro.
1.80 kristaps 405: .Pp
1.82 kristaps 406: See
1.80 kristaps 407: .Sx \&Nm
408: and
409: .Sx \&Nd .
1.73 kristaps 410: .It Em LIBRARY
411: The name of the library containing the documented material, which is
1.108 kristaps 412: assumed to be a function in a section 2, 3, or 9 manual.
1.100 kristaps 413: The syntax for this is as follows:
1.73 kristaps 414: .Bd -literal -offset indent
415: \&.Lb libarm
416: .Ed
417: .Pp
418: See
1.80 kristaps 419: .Sx \&Lb .
1.73 kristaps 420: .It Em SYNOPSIS
421: Documents the utility invocation syntax, function call syntax, or device
1.82 kristaps 422: configuration.
1.73 kristaps 423: .Pp
424: For the first, utilities (sections 1, 6, and 8), this is
425: generally structured as follows:
426: .Bd -literal -offset indent
427: \&.Nm foo
428: \&.Op Fl v
429: \&.Op Fl o Ar file
430: \&.Op Ar
431: \&.Nm bar
432: \&.Op Fl v
433: \&.Op Fl o Ar file
434: \&.Op Ar
435: .Ed
436: .Pp
437: For the second, function calls (sections 2, 3, 9):
438: .Bd -literal -offset indent
439: \&.Vt extern const char *global;
440: \&.In header.h
441: \&.Ft "char *"
442: \&.Fn foo "const char *src"
443: \&.Ft "char *"
444: \&.Fn bar "const char *src"
445: .Ed
446: .Pp
447: And for the third, configurations (section 4):
448: .Bd -literal -offset indent
449: \&.Cd \*qit* at isa? port 0x2e\*q
450: \&.Cd \*qit* at isa? port 0x4e\*q
451: .Ed
452: .Pp
1.82 kristaps 453: Manuals not in these sections generally don't need a
1.73 kristaps 454: .Em SYNOPSIS .
1.80 kristaps 455: .Pp
1.122 kristaps 456: Some macros are displayed differently in the
457: .Em SYNOPSIS
458: section, particularly
459: .Sx \&Nm ,
1.80 kristaps 460: .Sx \&Cd ,
1.122 kristaps 461: .Sx \&Fd ,
462: .Sx \&Fn ,
463: .Sx \&Fo ,
464: .Sx \&In ,
465: .Sx \&Vt ,
466: and
467: .Sx \&Ft .
468: All of these macros are output on their own line. If two such
469: dissimilar macros are pair-wise invoked (except for
470: .Sx \&Ft
471: before
472: .Sx \&Fo
473: or
1.123 kristaps 474: .Sx \&Fn ) ,
1.122 kristaps 475: they are separated by a vertical space, unless in the case of
476: .Sx \&Fo ,
1.80 kristaps 477: .Sx \&Fn ,
1.122 kristaps 478: and
1.80 kristaps 479: .Sx \&Ft ,
1.122 kristaps 480: which are always separated by vertical space.
1.73 kristaps 481: .It Em DESCRIPTION
1.82 kristaps 482: This expands upon the brief, one-line description in
1.73 kristaps 483: .Em NAME .
484: It usually contains a break-down of the options (if documenting a
485: command), such as:
486: .Bd -literal -offset indent
487: The arguments are as follows:
488: \&.Bl \-tag \-width Ds
489: \&.It Fl v
490: Print verbose information.
491: \&.El
492: .Ed
1.80 kristaps 493: .Pp
1.73 kristaps 494: Manuals not documenting a command won't include the above fragment.
495: .It Em IMPLEMENTATION NOTES
1.100 kristaps 496: Implementation-specific notes should be kept here.
497: This is useful when implementing standard functions that may have side
498: effects or notable algorithmic implications.
1.73 kristaps 499: .It Em RETURN VALUES
500: This section is the dual of
501: .Em EXIT STATUS ,
1.100 kristaps 502: which is used for commands.
503: It documents the return values of functions in sections 2, 3, and 9.
1.73 kristaps 504: .Pp
505: See
506: .Sx \&Rv .
507: .It Em ENVIRONMENT
508: Documents any usages of environment variables, e.g.,
509: .Xr environ 7 .
510: .Pp
511: See
512: .Sx \&Ev .
513: .It Em FILES
1.100 kristaps 514: Documents files used.
515: It's helpful to document both the file and a short description of how
516: the file is used (created, modified, etc.).
1.73 kristaps 517: .Pp
518: See
519: .Sx \&Pa .
1.99 kristaps 520: .It Em EXIT STATUS
1.100 kristaps 521: Command exit status for section 1, 6, and 8 manuals.
522: This section is the dual of
1.99 kristaps 523: .Em RETURN VALUES ,
1.100 kristaps 524: which is used for functions.
525: Historically, this information was described in
1.99 kristaps 526: .Em DIAGNOSTICS ,
527: a practise that is now discouraged.
528: .Pp
529: See
530: .Sx \&Ex .
1.73 kristaps 531: .It Em EXAMPLES
1.100 kristaps 532: Example usages.
533: This often contains snippets of well-formed, well-tested invocations.
534: Make doubly sure that your examples work properly!
1.73 kristaps 535: .It Em DIAGNOSTICS
1.100 kristaps 536: Documents error conditions.
537: This is most useful in section 4 manuals.
1.73 kristaps 538: Historically, this section was used in place of
539: .Em EXIT STATUS
540: for manuals in sections 1, 6, and 8; however, this practise is
541: discouraged.
542: .Pp
543: See
1.80 kristaps 544: .Sx \&Bl
545: .Fl diag .
1.73 kristaps 546: .It Em ERRORS
547: Documents error handling in sections 2, 3, and 9.
548: .Pp
549: See
550: .Sx \&Er .
551: .It Em SEE ALSO
1.100 kristaps 552: References other manuals with related topics.
553: This section should exist for most manuals.
554: Cross-references should conventionally be ordered first by section, then
555: alphabetically.
1.73 kristaps 556: .Pp
557: See
558: .Sx \&Xr .
559: .It Em STANDARDS
1.100 kristaps 560: References any standards implemented or used.
561: If not adhering to any standards, the
1.73 kristaps 562: .Em HISTORY
563: section should be used instead.
564: .Pp
565: See
566: .Sx \&St .
567: .It Em HISTORY
568: The history of any manual without a
569: .Em STANDARDS
570: section should be described in this section.
571: .It Em AUTHORS
572: Credits to authors, if applicable, should appear in this section.
573: Authors should generally be noted by both name and an e-mail address.
574: .Pp
575: See
576: .Sx \&An .
577: .It Em CAVEATS
578: Explanations of common misuses and misunderstandings should be explained
579: in this section.
580: .It Em BUGS
581: Extant bugs should be described in this section.
582: .It Em SECURITY CONSIDERATIONS
583: Documents any security precautions that operators should consider.
1.66 kristaps 584: .El
1.43 kristaps 585: .Sh MACRO SYNTAX
1.56 kristaps 586: Macros are one to three three characters in length and begin with a
587: control character ,
1.57 kristaps 588: .Sq \&. ,
1.100 kristaps 589: at the beginning of the line.
590: An arbitrary amount of whitespace may sit between the control character
591: and the macro name.
592: Thus, the following are equivalent:
1.64 kristaps 593: .Bd -literal -offset indent
594: \&.Pp
595: \&.\ \ \ \&Pp
596: .Ed
1.57 kristaps 597: .Pp
1.100 kristaps 598: The syntax of a macro depends on its classification.
599: In this section,
1.57 kristaps 600: .Sq \-arg
1.43 kristaps 601: refers to macro arguments, which may be followed by zero or more
1.57 kristaps 602: .Sq parm
1.43 kristaps 603: parameters;
1.57 kristaps 604: .Sq \&Yo
1.43 kristaps 605: opens the scope of a macro; and if specified,
1.57 kristaps 606: .Sq \&Yc
1.43 kristaps 607: closes it out.
1.57 kristaps 608: .Pp
1.43 kristaps 609: The
1.57 kristaps 610: .Em Callable
1.43 kristaps 611: column indicates that the macro may be called subsequent to the initial
1.100 kristaps 612: line-macro.
613: If a macro is not callable, then its invocation after the initial line
614: macro is interpreted as opaque text, such that
1.60 kristaps 615: .Sq \&.Fl \&Sh
1.55 kristaps 616: produces
1.60 kristaps 617: .Sq Fl \&Sh .
1.57 kristaps 618: .Pp
1.55 kristaps 619: The
1.57 kristaps 620: .Em Parsable
1.43 kristaps 621: column indicates whether the macro may be followed by further
1.100 kristaps 622: (ostensibly callable) macros.
623: If a macro is not parsable, subsequent macro invocations on the line
624: will be interpreted as opaque text.
1.57 kristaps 625: .Pp
1.55 kristaps 626: The
1.57 kristaps 627: .Em Scope
1.43 kristaps 628: column, if applicable, describes closure rules.
1.57 kristaps 629: .Ss Block full-explicit
1.100 kristaps 630: Multi-line scope closed by an explicit closing macro.
631: All macros contains bodies; only
1.64 kristaps 632: .Sx \&Bf
1.43 kristaps 633: contains a head.
1.57 kristaps 634: .Bd -literal -offset indent
1.50 kristaps 635: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
636: \(lBbody...\(rB
1.43 kristaps 637: \&.Yc
1.57 kristaps 638: .Ed
639: .Pp
640: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
641: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
1.64 kristaps 642: .It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed
643: .It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef
644: .It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek
645: .It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El
646: .It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd
647: .It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf
648: .It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk
649: .It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl
1.57 kristaps 650: .El
651: .Ss Block full-implicit
1.43 kristaps 652: Multi-line scope closed by end-of-file or implicitly by another macro.
1.50 kristaps 653: All macros have bodies; some
1.57 kristaps 654: .Po
1.64 kristaps 655: .Sx \&It Fl bullet ,
656: .Fl hyphen ,
657: .Fl dash ,
658: .Fl enum ,
659: .Fl item
1.57 kristaps 660: .Pc
1.64 kristaps 661: don't have heads; only one
662: .Po
663: .Sx \&It Fl column
1.82 kristaps 664: .Pc
1.64 kristaps 665: has multiple heads.
1.57 kristaps 666: .Bd -literal -offset indent
1.50 kristaps 667: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
668: \(lBbody...\(rB
1.57 kristaps 669: .Ed
670: .Pp
671: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
672: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
1.64 kristaps 673: .It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El
674: .It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh
675: .It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh
676: .It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss
1.57 kristaps 677: .El
678: .Ss Block partial-explicit
1.100 kristaps 679: Like block full-explicit, but also with single-line scope.
680: Each has at least a body and, in limited circumstances, a head
1.64 kristaps 681: .Po
682: .Sx \&Fo ,
683: .Sx \&Eo
684: .Pc
1.50 kristaps 685: and/or tail
1.64 kristaps 686: .Pq Sx \&Ec .
1.57 kristaps 687: .Bd -literal -offset indent
1.50 kristaps 688: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
689: \(lBbody...\(rB
690: \&.Yc \(lBtail...\(rB
1.2 kristaps 691:
1.43 kristaps 692: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
1.50 kristaps 693: \(lBbody...\(rB \&Yc \(lBtail...\(rB
1.57 kristaps 694: .Ed
695: .Pp
696: .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
697: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
1.64 kristaps 698: .It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao
1.63 kristaps 699: .It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac
1.64 kristaps 700: .It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo
701: .It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc
702: .It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro
703: .It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc
704: .It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do
705: .It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc
706: .It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo
707: .It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec
708: .It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo
709: .It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc
710: .It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo
711: .It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc
712: .It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po
713: .It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc
714: .It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo
715: .It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc
1.63 kristaps 716: .It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs
717: .It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re
1.64 kristaps 718: .It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So
719: .It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc
720: .It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo
721: .It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc
1.57 kristaps 722: .El
723: .Ss Block partial-implicit
1.50 kristaps 724: Like block full-implicit, but with single-line scope closed by
1.57 kristaps 725: .Sx Reserved Characters
1.43 kristaps 726: or end of line.
1.57 kristaps 727: .Bd -literal -offset indent
1.43 kristaps 728: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
1.57 kristaps 729: .Ed
730: .Pp
731: .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
732: .It Em Macro Ta Em Callable Ta Em Parsable
1.64 kristaps 733: .It Sx \&Aq Ta Yes Ta Yes
734: .It Sx \&Bq Ta Yes Ta Yes
735: .It Sx \&Brq Ta Yes Ta Yes
736: .It Sx \&D1 Ta \&No Ta \&Yes
737: .It Sx \&Dl Ta \&No Ta Yes
738: .It Sx \&Dq Ta Yes Ta Yes
739: .It Sx \&Op Ta Yes Ta Yes
740: .It Sx \&Pq Ta Yes Ta Yes
741: .It Sx \&Ql Ta Yes Ta Yes
742: .It Sx \&Qq Ta Yes Ta Yes
743: .It Sx \&Sq Ta Yes Ta Yes
1.83 kristaps 744: .It Sx \&Vt Ta Yes Ta Yes
1.57 kristaps 745: .El
1.83 kristaps 746: .Pp
747: Note that the
748: .Sx \&Vt
749: macro is a
750: .Sx Block partial-implicit
751: only when invoked as the first macro
1.109 kristaps 752: in a
753: .Em SYNOPSIS
754: section line, else it is
1.83 kristaps 755: .Sx In-line .
1.57 kristaps 756: .Ss In-line
1.50 kristaps 757: Closed by
1.57 kristaps 758: .Sx Reserved Characters ,
1.100 kristaps 759: end of line, fixed argument lengths, and/or subsequent macros.
760: In-line macros have only text children.
761: If a number (or inequality) of arguments is
1.57 kristaps 762: .Pq n ,
1.3 kristaps 763: then the macro accepts an arbitrary number of arguments.
1.57 kristaps 764: .Bd -literal -offset indent
1.43 kristaps 765: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
766:
767: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
768:
769: \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
1.57 kristaps 770: .Ed
771: .Pp
772: .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
773: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
1.63 kristaps 774: .It Sx \&%A Ta \&No Ta \&No Ta >0
775: .It Sx \&%B Ta \&No Ta \&No Ta >0
776: .It Sx \&%C Ta \&No Ta \&No Ta >0
777: .It Sx \&%D Ta \&No Ta \&No Ta >0
778: .It Sx \&%I Ta \&No Ta \&No Ta >0
779: .It Sx \&%J Ta \&No Ta \&No Ta >0
780: .It Sx \&%N Ta \&No Ta \&No Ta >0
781: .It Sx \&%O Ta \&No Ta \&No Ta >0
782: .It Sx \&%P Ta \&No Ta \&No Ta >0
1.69 kristaps 783: .It Sx \&%Q Ta \&No Ta \&No Ta >0
1.63 kristaps 784: .It Sx \&%R Ta \&No Ta \&No Ta >0
785: .It Sx \&%T Ta \&No Ta \&No Ta >0
1.69 kristaps 786: .It Sx \&%U Ta \&No Ta \&No Ta >0
1.63 kristaps 787: .It Sx \&%V Ta \&No Ta \&No Ta >0
1.64 kristaps 788: .It Sx \&Ad Ta Yes Ta Yes Ta n
789: .It Sx \&An Ta Yes Ta Yes Ta n
790: .It Sx \&Ap Ta Yes Ta Yes Ta 0
791: .It Sx \&Ar Ta Yes Ta Yes Ta n
792: .It Sx \&At Ta Yes Ta Yes Ta 1
793: .It Sx \&Bsx Ta Yes Ta Yes Ta n
794: .It Sx \&Bt Ta \&No Ta \&No Ta 0
795: .It Sx \&Bx Ta Yes Ta Yes Ta n
796: .It Sx \&Cd Ta Yes Ta Yes Ta >0
797: .It Sx \&Cm Ta Yes Ta Yes Ta n
798: .It Sx \&Db Ta \&No Ta \&No Ta 1
799: .It Sx \&Dd Ta \&No Ta \&No Ta >0
800: .It Sx \&Dt Ta \&No Ta \&No Ta n
801: .It Sx \&Dv Ta Yes Ta Yes Ta n
802: .It Sx \&Dx Ta Yes Ta Yes Ta n
803: .It Sx \&Em Ta Yes Ta Yes Ta >0
804: .It Sx \&En Ta \&No Ta \&No Ta 0
805: .It Sx \&Er Ta Yes Ta Yes Ta >0
806: .It Sx \&Es Ta \&No Ta \&No Ta 0
807: .It Sx \&Ev Ta Yes Ta Yes Ta n
808: .It Sx \&Ex Ta \&No Ta \&No Ta n
809: .It Sx \&Fa Ta Yes Ta Yes Ta n
810: .It Sx \&Fd Ta \&No Ta \&No Ta >0
811: .It Sx \&Fl Ta Yes Ta Yes Ta n
812: .It Sx \&Fn Ta Yes Ta Yes Ta >0
813: .It Sx \&Fr Ta \&No Ta \&No Ta n
814: .It Sx \&Ft Ta Yes Ta Yes Ta n
815: .It Sx \&Fx Ta Yes Ta Yes Ta n
816: .It Sx \&Hf Ta \&No Ta \&No Ta n
817: .It Sx \&Ic Ta Yes Ta Yes Ta >0
818: .It Sx \&In Ta \&No Ta \&No Ta n
819: .It Sx \&Lb Ta \&No Ta \&No Ta 1
820: .It Sx \&Li Ta Yes Ta Yes Ta n
821: .It Sx \&Lk Ta Yes Ta Yes Ta n
822: .It Sx \&Lp Ta \&No Ta \&No Ta 0
823: .It Sx \&Ms Ta Yes Ta Yes Ta >0
824: .It Sx \&Mt Ta Yes Ta Yes Ta >0
825: .It Sx \&Nm Ta Yes Ta Yes Ta n
826: .It Sx \&No Ta Yes Ta Yes Ta 0
827: .It Sx \&Ns Ta Yes Ta Yes Ta 0
828: .It Sx \&Nx Ta Yes Ta Yes Ta n
829: .It Sx \&Os Ta \&No Ta \&No Ta n
830: .It Sx \&Ot Ta \&No Ta \&No Ta n
831: .It Sx \&Ox Ta Yes Ta Yes Ta n
832: .It Sx \&Pa Ta Yes Ta Yes Ta n
1.88 kristaps 833: .It Sx \&Pf Ta Yes Ta Yes Ta 1
1.64 kristaps 834: .It Sx \&Pp Ta \&No Ta \&No Ta 0
835: .It Sx \&Rv Ta \&No Ta \&No Ta n
836: .It Sx \&Sm Ta \&No Ta \&No Ta 1
837: .It Sx \&St Ta \&No Ta Yes Ta 1
838: .It Sx \&Sx Ta Yes Ta Yes Ta >0
839: .It Sx \&Sy Ta Yes Ta Yes Ta >0
840: .It Sx \&Tn Ta Yes Ta Yes Ta >0
841: .It Sx \&Ud Ta \&No Ta \&No Ta 0
842: .It Sx \&Ux Ta Yes Ta Yes Ta n
843: .It Sx \&Va Ta Yes Ta Yes Ta n
844: .It Sx \&Vt Ta Yes Ta Yes Ta >0
1.84 kristaps 845: .It Sx \&Xr Ta Yes Ta Yes Ta >0
1.64 kristaps 846: .It Sx \&br Ta \&No Ta \&No Ta 0
847: .It Sx \&sp Ta \&No Ta \&No Ta 1
1.82 kristaps 848: .El
1.63 kristaps 849: .Sh REFERENCE
850: This section is a canonical reference of all macros, arranged
1.100 kristaps 851: alphabetically.
852: For the scoping of individual macros, see
1.63 kristaps 853: .Sx MACRO SYNTAX .
854: .Ss \&%A
855: Author name of an
856: .Sx \&Rs
857: block. Multiple authors should each be accorded their own
1.64 kristaps 858: .Sx \%%A
1.66 kristaps 859: line. Author names should be ordered with full or abbreviated
860: forename(s) first, then full surname.
1.63 kristaps 861: .Ss \&%B
862: Book title of an
863: .Sx \&Rs
864: block. This macro may also be used in a non-bibliographic context when
865: referring to book titles.
866: .Ss \&%C
867: Publication city or location of an
868: .Sx \&Rs
869: block.
870: .Pp
1.65 kristaps 871: .Em Remarks :
1.63 kristaps 872: this macro is not implemented in
873: .Xr groff 1 .
874: .Ss \&%D
875: Publication date of an
876: .Sx \&Rs
1.72 kristaps 877: block. This should follow the reduced or canonical form syntax
878: described in
1.63 kristaps 879: .Sx Dates .
880: .Ss \&%I
881: Publisher or issuer name of an
882: .Sx \&Rs
883: block.
884: .Ss \&%J
885: Journal name of an
886: .Sx \&Rs
887: block.
888: .Ss \&%N
889: Issue number (usually for journals) of an
890: .Sx \&Rs
891: block.
892: .Ss \&%O
893: Optional information of an
894: .Sx \&Rs
895: block.
896: .Ss \&%P
897: Book or journal page number of an
898: .Sx \&Rs
899: block.
900: .Ss \&%Q
901: Institutional author (school, government, etc.) of an
902: .Sx \&Rs
903: block. Multiple institutional authors should each be accorded their own
1.64 kristaps 904: .Sx \&%Q
1.63 kristaps 905: line.
906: .Ss \&%R
907: Technical report name of an
908: .Sx \&Rs
909: block.
910: .Ss \&%T
911: Article title of an
912: .Sx \&Rs
913: block. This macro may also be used in a non-bibliographical context
914: when referring to article titles.
1.69 kristaps 915: .Ss \&%U
1.70 kristaps 916: URI of reference document.
1.63 kristaps 917: .Ss \&%V
918: Volume number of an
919: .Sx \&Rs
920: block.
921: .Ss \&Ac
922: Closes an
923: .Sx \&Ao
924: block. Does not have any tail arguments.
925: .Ss \&Ad
926: Address construct: usually in the context of an computational address in
927: memory, not a physical (post) address.
928: .Pp
1.64 kristaps 929: Examples:
1.91 kristaps 930: .D1 \&.Ad [0,$]
931: .D1 \&.Ad 0x00000000
1.63 kristaps 932: .Ss \&An
1.100 kristaps 933: Author name.
934: This macro may alternatively accepts the following arguments, although
935: these may not be specified along with a parameter:
1.64 kristaps 936: .Bl -tag -width 12n -offset indent
937: .It Fl split
1.66 kristaps 938: Renders a line break before each author listing.
1.64 kristaps 939: .It Fl nosplit
940: The opposite of
941: .Fl split .
942: .El
943: .Pp
944: In the AUTHORS section, the default is not to split the first author
945: listing, but all subsequent author listings, whether or not they're
1.100 kristaps 946: interspersed by other macros or text, are split.
947: Thus, specifying
1.64 kristaps 948: .Fl split
1.100 kristaps 949: will cause the first listing also to be split.
950: If not in the AUTHORS section, the default is not to split.
1.64 kristaps 951: .Pp
952: Examples:
1.91 kristaps 953: .D1 \&.An -nosplit
954: .D1 \&.An J. D. Ullman .
1.64 kristaps 955: .Pp
956: .Em Remarks :
957: the effects of
958: .Fl split
959: or
960: .Fl nosplit
961: are re-set when entering the AUTHORS section, so if one specifies
962: .Sx \&An Fl nosplit
963: in the general document body, it must be re-specified in the AUTHORS
964: section.
1.63 kristaps 965: .Ss \&Ao
1.100 kristaps 966: Begins a block enclosed by angled brackets.
967: Does not have any head arguments.
1.63 kristaps 968: .Pp
1.64 kristaps 969: Examples:
1.91 kristaps 970: .D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
1.63 kristaps 971: .Pp
1.64 kristaps 972: See also
973: .Sx \&Aq .
1.63 kristaps 974: .Ss \&Ap
1.100 kristaps 975: Inserts an apostrophe without any surrounding white-space.
1.124 kristaps 976: This is generally used as a grammatical device when referring to the verb
1.100 kristaps 977: form of a function:
1.64 kristaps 978: .Bd -literal -offset indent
979: \&.Fn execve Ap d
980: .Ed
1.63 kristaps 981: .Ss \&Aq
1.82 kristaps 982: Encloses its arguments in angled brackets.
1.64 kristaps 983: .Pp
984: Examples:
1.91 kristaps 985: .D1 \&.Fl -key= \&Ns \&Aq \&Ar val
1.64 kristaps 986: .Pp
987: .Em Remarks :
988: this macro is often abused for rendering URIs, which should instead use
989: .Sx \&Lk
990: or
991: .Sx \&Mt ,
992: or to note pre-processor
993: .Dq Li #include
994: statements, which should use
995: .Sx \&In .
996: .Pp
997: See also
998: .Sx \&Ao .
1.63 kristaps 999: .Ss \&Ar
1.100 kristaps 1000: Command arguments.
1001: If an argument is not provided, the string
1.64 kristaps 1002: .Dq file ...
1.66 kristaps 1003: is used as a default.
1.64 kristaps 1004: .Pp
1005: Examples:
1.91 kristaps 1006: .D1 \&.Fl o \&Ns \&Ar file1
1007: .D1 \&.Ar
1008: .D1 \&.Ar arg1 , arg2 .
1.63 kristaps 1009: .Ss \&At
1.100 kristaps 1010: Formats an AT&T version.
1011: Accepts at most one parameter:
1.64 kristaps 1012: .Bl -tag -width 12n -offset indent
1013: .It Cm v[1-7] | 32v
1014: A version of
1015: .At .
1016: .It Cm V[.[1-4]]?
1017: A system version of
1018: .At .
1019: .El
1020: .Pp
1021: Note that these parameters do not begin with a hyphen.
1022: .Pp
1023: Examples:
1.91 kristaps 1024: .D1 \&.At
1025: .D1 \&.At V.1
1.65 kristaps 1026: .Pp
1027: See also
1.66 kristaps 1028: .Sx \&Bsx ,
1.65 kristaps 1029: .Sx \&Bx ,
1.66 kristaps 1030: .Sx \&Dx ,
1.65 kristaps 1031: .Sx \&Fx ,
1032: .Sx \&Nx ,
1033: .Sx \&Ox ,
1034: and
1035: .Sx \&Ux .
1.63 kristaps 1036: .Ss \&Bc
1.64 kristaps 1037: Closes a
1038: .Sx \&Bo
1039: block. Does not have any tail arguments.
1.63 kristaps 1040: .Ss \&Bd
1.100 kristaps 1041: Begins a display block.
1042: A display is collection of macros or text which may be collectively
1043: offset or justified in a manner different from that
1044: of the enclosing context.
1045: By default, the block is preceded by a vertical space.
1.64 kristaps 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
1.100 kristaps 1063: The type must be provided first.
1064: Secondary arguments are as follows:
1.64 kristaps 1065: .Bl -tag -width 12n -offset indent
1066: .It Fl offset Ar width
1067: Offset by the value of
1068: .Ar width ,
1069: which is interpreted as one of the following, specified in order:
1070: .Bl -item
1071: .It
1072: As one of the pre-defined strings
1073: .Ar indent ,
1074: the width of standard indentation;
1075: .Ar indent-two ,
1076: twice
1077: .Ar indent ;
1078: .Ar left ,
1079: which has no effect ;
1080: .Ar right ,
1081: which justifies to the right margin; and
1082: .Ar center ,
1083: which aligns around an imagined centre axis.
1084: .It
1.100 kristaps 1085: As a precalculated width for a named macro.
1086: The most popular is the imaginary macro
1.67 kristaps 1087: .Ar \&Ds ,
1.64 kristaps 1088: which resolves to
1089: .Ar 6n .
1090: .It
1091: As a scaling unit following the syntax described in
1092: .Sx Scaling Widths .
1093: .It
1094: As the calculated string length of the opaque string.
1095: .El
1096: .Pp
1.126 kristaps 1097: If not provided an argument, it will be ignored.
1.64 kristaps 1098: .It Fl compact
1099: Do not assert a vertical space before the block.
1100: .It Fl file Ar file
1101: Prepend the file
1102: .Ar file
1103: before any text or macros within the block.
1104: .El
1105: .Pp
1106: Examples:
1107: .Bd -literal -offset indent
1108: \&.Bd \-unfilled \-offset two-indent \-compact
1.65 kristaps 1109: Hello world.
1.64 kristaps 1110: \&.Ed
1111: .Ed
1.66 kristaps 1112: .Pp
1113: See also
1114: .Sx \&D1
1115: and
1116: .Sx \&Dl .
1.63 kristaps 1117: .Ss \&Bf
1118: .Ss \&Bk
1.127 ! schwarze 1119: Begins a keep block, containing a collection of macros or text
! 1120: to be kept together in the output.
! 1121: One argument is required; additional arguments are ignored.
! 1122: Currently, the only argument implemented is
! 1123: .Fl words ,
! 1124: requesting to keep together all words of the contained text
! 1125: on the same output line.
! 1126: A
! 1127: .Fl lines
! 1128: argument to keep together all lines of the contained text
! 1129: on the same page has been desired for a long time,
! 1130: but has never been implemented.
! 1131: .Pp
! 1132: Examples:
! 1133: .Bd -literal -offset indent
! 1134: \&.Bk \-words
! 1135: \&.Op o Ar output_file
! 1136: \&.Ek
! 1137: .Ed
1.63 kristaps 1138: .Ss \&Bl
1.103 kristaps 1139: Begins a list composed of one or more list entries.
1.104 kristaps 1140: A list is associated with a type, which is a required argument.
1141: Other arguments are
1142: .Fl width ,
1143: defined per-type as accepting a literal or
1144: .Sx Scaling Widths
1145: value;
1146: .Fl offset ,
1147: also accepting a literal or
1148: .Sx Scaling Widths
1149: value setting the list's global offset; and
1150: .Fl compact ,
1151: suppressing the default vertical space printed before each list entry.
1.103 kristaps 1152: A list entry is specified by the
1153: .Sx \&It
1154: macro, which consists of a head and optional body (depending on the list
1155: type).
1156: A list must specify one of the following list types:
1157: .Bl -tag -width 12n -offset indent
1158: .It Fl bullet
1159: A list offset by a bullet.
1160: The head of list entries must be empty.
1161: List entry bodies are positioned after the bullet.
1.104 kristaps 1162: The
1163: .Fl width
1164: argument varies the width of list bodies' left-margins.
1.103 kristaps 1165: .It Fl column
1166: A columnated list.
1.104 kristaps 1167: The
1168: .Fl width
1169: argument has no effect.
1.103 kristaps 1170: The number of columns is specified as parameters to the
1171: .Sx \&Bl
1172: macro.
1173: These dictate the width of columns either as
1174: .Sx Scaling Widths
1175: or literal text.
1.114 kristaps 1176: If the initial macro of a
1177: .Fl column
1178: list is not an
1179: .Sx \&It ,
1180: an
1181: .Sx \&It
1182: context spanning each line is implied until an
1183: .Sx \&It
1184: line macro is encountered, at which point list bodies are interpreted as
1185: described in the
1186: .Sx \&It
1187: documentation.
1.103 kristaps 1188: .It Fl dash
1189: A list offset by a dash (hyphen).
1190: The head of list entries must be empty.
1191: List entry bodies are positioned past the dash.
1.104 kristaps 1192: The
1193: .Fl width
1194: argument varies the width of list bodies' left-margins.
1.103 kristaps 1195: .It Fl diag
1196: Like
1197: .Fl inset ,
1198: but with additional formatting to the head.
1.104 kristaps 1199: The
1200: .Fl width
1201: argument varies the width of list bodies' left-margins.
1.103 kristaps 1202: .It Fl enum
1203: An enumerated list offset by the enumeration from 1.
1204: The head of list entries must be empty.
1205: List entry bodies are positioned after the enumeration.
1.104 kristaps 1206: The
1207: .Fl width
1208: argument varies the width of list bodies' left-margins.
1.103 kristaps 1209: .It Fl hang
1210: Like
1211: .Fl tag ,
1212: but instead of list bodies positioned after the head, they trail the
1213: head text.
1.104 kristaps 1214: The
1215: .Fl width
1216: argument varies the width of list bodies' left-margins.
1.103 kristaps 1217: .It Fl hyphen
1218: Synonym for
1219: .Fl dash .
1220: .It Fl inset
1221: List bodies follow the list head.
1.104 kristaps 1222: The
1223: .Fl width
1224: argument is ignored.
1.103 kristaps 1225: .It Fl item
1226: This produces blocks of text.
1227: The head of list entries must be empty.
1.104 kristaps 1228: The
1229: .Fl width
1230: argument is ignored.
1.103 kristaps 1231: .It Fl ohang
1232: List bodies are positioned on the line following the head.
1.104 kristaps 1233: The
1234: .Fl width
1235: argument is ignored.
1.103 kristaps 1236: .It Fl tag
1237: A list offset by list entry heads. List entry bodies are positioned
1238: after the head as specified by the
1239: .Fl width
1240: argument.
1241: .El
1.114 kristaps 1242: .Pp
1243: See also
1244: .Sx \&It .
1.63 kristaps 1245: .Ss \&Bo
1.100 kristaps 1246: Begins a block enclosed by square brackets.
1247: Does not have any head arguments.
1.65 kristaps 1248: .Pp
1249: Examples:
1250: .Bd -literal -offset indent
1251: \&.Bo 1 ,
1.91 kristaps 1252: \&.Dv BUFSIZ \&Bc
1.65 kristaps 1253: .Ed
1254: .Pp
1255: See also
1256: .Sx \&Bq .
1.63 kristaps 1257: .Ss \&Bq
1.82 kristaps 1258: Encloses its arguments in square brackets.
1.65 kristaps 1259: .Pp
1260: Examples:
1.91 kristaps 1261: .D1 \&.Bq 1 , \&Dv BUFSIZ
1.65 kristaps 1262: .Pp
1263: .Em Remarks :
1264: this macro is sometimes abused to emulate optional arguments for
1265: commands; the correct macros to use for this purpose are
1266: .Sx \&Op ,
1267: .Sx \&Oo ,
1268: and
1269: .Sx \&Oc .
1270: .Pp
1271: See also
1272: .Sx \&Bo .
1.63 kristaps 1273: .Ss \&Brc
1.65 kristaps 1274: Closes a
1275: .Sx \&Bro
1276: block. Does not have any tail arguments.
1.63 kristaps 1277: .Ss \&Bro
1.100 kristaps 1278: Begins a block enclosed by curly braces.
1279: Does not have any head arguments.
1.65 kristaps 1280: .Pp
1281: Examples:
1282: .Bd -literal -offset indent
1283: \&.Bro 1 , ... ,
1.91 kristaps 1284: \&.Va n \&Brc
1.65 kristaps 1285: .Ed
1286: .Pp
1287: See also
1288: .Sx \&Brq .
1.63 kristaps 1289: .Ss \&Brq
1.65 kristaps 1290: Encloses its arguments in curly braces.
1291: .Pp
1292: Examples:
1.91 kristaps 1293: .D1 \&.Brq 1 , ... , \&Va n
1.65 kristaps 1294: .Pp
1295: See also
1296: .Sx \&Bro .
1.63 kristaps 1297: .Ss \&Bsx
1.65 kristaps 1298: Format the BSD/OS version provided as an argument, or a default value if
1299: no argument is provided.
1300: .Pp
1301: Examples:
1.91 kristaps 1302: .D1 \&.Bsx 1.0
1303: .D1 \&.Bsx
1.65 kristaps 1304: .Pp
1305: See also
1306: .Sx \&At ,
1307: .Sx \&Bx ,
1.66 kristaps 1308: .Sx \&Dx ,
1.65 kristaps 1309: .Sx \&Fx ,
1310: .Sx \&Nx ,
1311: .Sx \&Ox ,
1312: and
1313: .Sx \&Ux .
1.63 kristaps 1314: .Ss \&Bt
1.66 kristaps 1315: Prints
1316: .Dq is currently in beta test.
1.63 kristaps 1317: .Ss \&Bx
1.65 kristaps 1318: Format the BSD version provided as an argument, or a default value if no
1319: argument is provided.
1320: .Pp
1321: Examples:
1.91 kristaps 1322: .D1 \&.Bx 4.4
1323: .D1 \&.Bx
1.65 kristaps 1324: .Pp
1325: See also
1326: .Sx \&At ,
1327: .Sx \&Bsx ,
1.66 kristaps 1328: .Sx \&Dx ,
1.65 kristaps 1329: .Sx \&Fx ,
1330: .Sx \&Nx ,
1331: .Sx \&Ox ,
1332: and
1333: .Sx \&Ux .
1.63 kristaps 1334: .Ss \&Cd
1.100 kristaps 1335: Configuration declaration.
1336: This denotes strings accepted by
1.66 kristaps 1337: .Xr config 8 .
1338: .Pp
1339: Examples:
1.91 kristaps 1340: .D1 \&.Cd device le0 at scode?
1.66 kristaps 1341: .Pp
1342: .Em Remarks :
1343: this macro is commonly abused by using quoted literals to retain
1344: white-space and align consecutive
1345: .Sx \&Cd
1.100 kristaps 1346: declarations.
1347: This practise is discouraged.
1.63 kristaps 1348: .Ss \&Cm
1.100 kristaps 1349: Command modifiers.
1350: Useful when specifying configuration options or keys.
1.66 kristaps 1351: .Pp
1352: Examples:
1.91 kristaps 1353: .D1 \&.Cm ControlPath
1354: .D1 \&.Cm ControlMaster
1.66 kristaps 1355: .Pp
1356: See also
1357: .Sx \&Fl .
1.63 kristaps 1358: .Ss \&D1
1.100 kristaps 1359: One-line indented display.
1360: This is formatted by the default rules and is useful for simple indented
1361: statements.
1362: It is followed by a newline.
1.66 kristaps 1363: .Pp
1364: Examples:
1.91 kristaps 1365: .D1 \&.D1 \&Fl abcdefgh
1.66 kristaps 1366: .Pp
1367: See also
1368: .Sx \&Bd
1369: and
1370: .Sx \&Dl .
1.63 kristaps 1371: .Ss \&Db
1.117 kristaps 1372: Start a debugging context.
1373: This macro is parsed, but generally ignored.
1.120 kristaps 1374: Its syntax is as follows:
1.117 kristaps 1375: .Pp
1.120 kristaps 1376: .D1 Pf \. Sx \&Db Cm on | off
1.63 kristaps 1377: .Ss \&Dc
1.66 kristaps 1378: Closes a
1379: .Sx \&Do
1380: block. Does not have any tail arguments.
1.63 kristaps 1381: .Ss \&Dd
1.100 kristaps 1382: Document date.
1383: This is the mandatory first macro of any
1.66 kristaps 1384: .Nm
1.100 kristaps 1385: manual.
1.120 kristaps 1386: Its syntax is as follows:
1.66 kristaps 1387: .Pp
1.120 kristaps 1388: .D1 Pf \. Sx \&Dd Cm date
1.66 kristaps 1389: .Pp
1.82 kristaps 1390: The
1.66 kristaps 1391: .Cm date
1392: field may be either
1393: .Ar $\&Mdocdate$ ,
1394: which signifies the current manual revision date dictated by
1.72 kristaps 1395: .Xr cvs 1 ,
1.66 kristaps 1396: or instead a valid canonical date as specified by
1397: .Sx Dates .
1.72 kristaps 1398: If a date does not conform, the current date is used instead.
1.66 kristaps 1399: .Pp
1400: Examples:
1.91 kristaps 1401: .D1 \&.Dd $\&Mdocdate$
1402: .D1 \&.Dd $\&Mdocdate: July 21 2007$
1403: .D1 \&.Dd July 21, 2007
1.66 kristaps 1404: .Pp
1405: See also
1406: .Sx \&Dt
1407: and
1408: .Sx \&Os .
1.63 kristaps 1409: .Ss \&Dl
1.100 kristaps 1410: One-line intended display.
1411: This is formatted as literal text and is useful for commands and
1412: invocations.
1413: It is followed by a newline.
1.66 kristaps 1414: .Pp
1415: Examples:
1.91 kristaps 1416: .D1 \&.Dl % mandoc mdoc.7 | less
1.66 kristaps 1417: .Pp
1418: See also
1419: .Sx \&Bd
1420: and
1421: .Sx \&D1 .
1.63 kristaps 1422: .Ss \&Do
1.66 kristaps 1423: Begins a block enclosed by double quotes. Does not have any head
1424: arguments.
1425: .Pp
1426: Examples:
1.91 kristaps 1427: .D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot
1.66 kristaps 1428: .Pp
1429: See also
1430: .Sx \&Dq .
1.63 kristaps 1431: .Ss \&Dq
1.82 kristaps 1432: Encloses its arguments in double quotes.
1.66 kristaps 1433: .Pp
1434: Examples:
1.91 kristaps 1435: .Bd -literal -offset indent -compact
1.66 kristaps 1436: \&.Dq April is the cruellest month
1437: \e(em T.S. Eliot
1438: .Ed
1439: .Pp
1440: See also
1441: .Sx \&Do .
1.63 kristaps 1442: .Ss \&Dt
1.100 kristaps 1443: Document title.
1444: This is the mandatory second macro of any
1.66 kristaps 1445: .Nm
1.100 kristaps 1446: file.
1.120 kristaps 1447: Its syntax is as follows:
1448: .Bd -ragged -offset indent
1449: .Pf \. Sx \&Dt
1450: .Oo
1451: .Cm title
1452: .Oo
1453: .Cm section
1454: .Op Cm volume | arch
1455: .Oc
1456: .Oc
1457: .Ed
1.66 kristaps 1458: .Pp
1459: Its arguments are as follows:
1460: .Bl -tag -width Ds -offset Ds
1461: .It Cm title
1.111 kristaps 1462: The document's title (name), defaulting to
1463: .Qq UNKNOWN
1464: if unspecified.
1465: It should be capitalised.
1.66 kristaps 1466: .It Cm section
1.100 kristaps 1467: The manual section.
1468: This may be one of
1.66 kristaps 1469: .Ar 1
1470: .Pq utilities ,
1471: .Ar 2
1472: .Pq system calls ,
1473: .Ar 3
1474: .Pq libraries ,
1475: .Ar 3p
1476: .Pq Perl libraries ,
1477: .Ar 4
1478: .Pq devices ,
1479: .Ar 5
1480: .Pq file formats ,
1481: .Ar 6
1482: .Pq games ,
1483: .Ar 7
1484: .Pq miscellaneous ,
1485: .Ar 8
1486: .Pq system utilities ,
1487: .Ar 9
1488: .Pq kernel functions ,
1489: .Ar X11
1490: .Pq X Window System ,
1491: .Ar X11R6
1492: .Pq X Window System ,
1493: .Ar unass
1494: .Pq unassociated ,
1495: .Ar local
1496: .Pq local system ,
1497: .Ar draft
1498: .Pq draft manual ,
1499: or
1500: .Ar paper
1501: .Pq paper .
1.111 kristaps 1502: It should correspond to the manual's filename suffix and defaults to
1503: .Qq 1
1504: if unspecified.
1.66 kristaps 1505: .It Cm volume
1506: This overrides the volume inferred from
1507: .Ar section .
1508: This field is optional, and if specified, must be one of
1509: .Ar USD
1510: .Pq users' supplementary documents ,
1511: .Ar PS1
1512: .Pq programmers' supplementary documents ,
1513: .Ar AMD
1514: .Pq administrators' supplementary documents ,
1515: .Ar SMM
1516: .Pq system managers' manuals ,
1517: .Ar URM
1518: .Pq users' reference manuals ,
1519: .Ar PRM
1520: .Pq programmers' reference manuals ,
1521: .Ar KM
1522: .Pq kernel manuals ,
1523: .Ar IND
1524: .Pq master index ,
1525: .Ar MMI
1526: .Pq master index ,
1527: .Ar LOCAL
1528: .Pq local manuals ,
1529: .Ar LOC
1530: .Pq local manuals ,
1531: or
1532: .Ar CON
1533: .Pq contributed manuals .
1534: .It Cm arch
1.100 kristaps 1535: This specifies a specific relevant architecture.
1536: If
1.66 kristaps 1537: .Cm volume
1538: is not provided, it may be used in its place, else it may be used
1.100 kristaps 1539: subsequent that.
1540: It, too, is optional.
1541: It must be one of
1.66 kristaps 1542: .Ar alpha ,
1543: .Ar amd64 ,
1544: .Ar amiga ,
1545: .Ar arc ,
1546: .Ar arm ,
1547: .Ar armish ,
1548: .Ar aviion ,
1549: .Ar hp300 ,
1550: .Ar hppa ,
1551: .Ar hppa64 ,
1552: .Ar i386 ,
1553: .Ar landisk ,
1.86 kristaps 1554: .Ar loongson ,
1.66 kristaps 1555: .Ar luna88k ,
1556: .Ar mac68k ,
1557: .Ar macppc ,
1558: .Ar mvme68k ,
1559: .Ar mvme88k ,
1560: .Ar mvmeppc ,
1561: .Ar pmax ,
1562: .Ar sgi ,
1563: .Ar socppc ,
1564: .Ar sparc ,
1565: .Ar sparc64 ,
1566: .Ar sun3 ,
1567: .Ar vax ,
1568: or
1569: .Ar zaurus .
1570: .El
1571: .Pp
1572: Examples:
1.91 kristaps 1573: .D1 \&.Dt FOO 1
1574: .D1 \&.Dt FOO 4 KM
1575: .D1 \&.Dt FOO 9 i386
1.66 kristaps 1576: .Pp
1577: See also
1578: .Sx \&Dd
1579: and
1580: .Sx \&Os .
1.63 kristaps 1581: .Ss \&Dv
1.66 kristaps 1582: Defined variables such as preprocessor constants.
1583: .Pp
1584: Examples:
1.91 kristaps 1585: .D1 \&.Dv BUFSIZ
1586: .D1 \&.Dv STDOUT_FILENO
1.66 kristaps 1587: .Pp
1588: See also
1589: .Sx \&Er .
1.63 kristaps 1590: .Ss \&Dx
1.71 kristaps 1591: Format the DragonFly BSD version provided as an argument, or a default
1.66 kristaps 1592: value if no argument is provided.
1593: .Pp
1594: Examples:
1.91 kristaps 1595: .D1 \&.Dx 2.4.1
1596: .D1 \&.Dx
1.66 kristaps 1597: .Pp
1598: See also
1599: .Sx \&At ,
1600: .Sx \&Bsx ,
1601: .Sx \&Bx ,
1602: .Sx \&Fx ,
1603: .Sx \&Nx ,
1604: .Sx \&Ox ,
1605: and
1606: .Sx \&Ux .
1.63 kristaps 1607: .Ss \&Ec
1608: .Ss \&Ed
1609: .Ss \&Ef
1610: .Ss \&Ek
1.127 ! schwarze 1611: Ends a keep context started by
! 1612: .Sx \&Bk .
1.63 kristaps 1613: .Ss \&El
1.117 kristaps 1614: Ends a list context started by
1615: .Sx \&Bl .
1616: .Pp
1617: See also
1618: .Sx \&Bl
1619: and
1620: .Sx \&It .
1.63 kristaps 1621: .Ss \&Em
1.100 kristaps 1622: Denotes text that should be emphasised.
1623: Note that this is a presentation term and should not be used for
1624: stylistically decorating technical terms.
1.66 kristaps 1625: .Pp
1626: Examples:
1.91 kristaps 1627: .D1 \&.Em Warnings!
1628: .D1 \&.Em Remarks :
1.63 kristaps 1629: .Ss \&En
1630: .Ss \&Eo
1631: .Ss \&Er
1.90 kristaps 1632: Display error constants.
1.66 kristaps 1633: .Pp
1634: Examples:
1.91 kristaps 1635: .D1 \&.Er EPERM
1636: .D1 \&.Er ENOENT
1.66 kristaps 1637: .Pp
1638: See also
1639: .Sx \&Dv .
1.63 kristaps 1640: .Ss \&Es
1641: .Ss \&Ev
1.66 kristaps 1642: Environmental variables such as those specified in
1643: .Xr environ 7 .
1644: .Pp
1645: Examples:
1.91 kristaps 1646: .D1 \&.Ev DISPLAY
1647: .D1 \&.Ev PATH
1.63 kristaps 1648: .Ss \&Ex
1.100 kristaps 1649: Inserts text regarding a utility's exit values.
1650: This macro must have first the
1.66 kristaps 1651: .Fl std
1652: argument specified, then an optional
1653: .Ar utility .
1654: If
1655: .Ar utility
1656: is not provided, the document's name as stipulated in
1657: .Sx \&Nm
1658: is provided.
1.63 kristaps 1659: .Ss \&Fa
1.117 kristaps 1660: Function argument.
1.120 kristaps 1661: Its syntax is as follows:
1662: .Bd -ragged -offset indent
1663: .Pf \. Sx \&Fa
1664: .Op Cm argtype
1665: .Cm argname
1666: .Ed
1667: .Pp
1.117 kristaps 1668: This may be invoked for names with or without the corresponding type.
1669: It is also used to specify the field name of a structure.
1670: Most often, the
1671: .Sx \&Fa
1672: macro is used in the
1673: .Em SYNOPSIS
1.120 kristaps 1674: within
1675: .Sx \&Fo
1.117 kristaps 1676: section when documenting multi-line function prototypes.
1677: If invoked with multiple arguments, the arguments are separated by a
1678: comma.
1679: Furthermore, if the following macro is another
1680: .Sx \&Fa ,
1681: the last argument will also have a trailing comma.
1682: .Pp
1683: Examples:
1684: .D1 \&.Fa \(dqconst char *p\(dq
1685: .D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
1686: .D1 \&.Fa foo
1.120 kristaps 1687: .Pp
1688: See also
1689: .Sx \&Fo .
1.63 kristaps 1690: .Ss \&Fc
1691: .Ss \&Fd
1.117 kristaps 1692: Historically used to document include files.
1693: This usage has been deprecated in favour of
1694: .Sx \&In .
1695: Do not use this macro.
1696: .Pp
1697: See also
1.122 kristaps 1698: .Sx MANUAL STRUCTURE
1699: and
1.117 kristaps 1700: .Sx \&In .
1.63 kristaps 1701: .Ss \&Fl
1.100 kristaps 1702: Command-line flag.
1703: Used when listing arguments to command-line utilities.
1704: Prints a fixed-width hyphen
1.79 kristaps 1705: .Sq \-
1.100 kristaps 1706: directly followed by each argument.
1707: If no arguments are provided, a hyphen is printed followed by a space.
1708: If the argument is a macro, a hyphen is prefixed to the subsequent macro
1709: output.
1.79 kristaps 1710: .Pp
1711: Examples:
1.91 kristaps 1712: .D1 \&.Fl a b c
1713: .D1 \&.Fl \&Pf a b
1714: .D1 \&.Fl
1715: .D1 \&.Op \&Fl o \&Ns \&Ar file
1.79 kristaps 1716: .Pp
1717: See also
1718: .Sx \&Cm .
1.63 kristaps 1719: .Ss \&Fn
1.119 kristaps 1720: A function name.
1.120 kristaps 1721: Its syntax is as follows:
1.119 kristaps 1722: .Bd -ragged -offset indent
1723: .Pf \. Ns Sx \&Fn
1724: .Op Cm functype
1725: .Cm funcname
1726: .Op Oo Cm argtype Oc Cm argname
1727: .Ed
1.120 kristaps 1728: .Pp
1.122 kristaps 1729: Function arguments are surrounded in parenthesis and
1.119 kristaps 1730: are delimited by commas.
1731: If no arguments are specified, blank parenthesis are output.
1732: .Pp
1733: Examples:
1734: .D1 \&.Fn "int funcname" "int arg0" "int arg1"
1735: .D1 \&.Fn funcname "int arg0"
1736: .D1 \&.Fn funcname arg0
1.120 kristaps 1737: .Bd -literal -offset indent -compact
1738: \&.Ft functype
1739: \&.Fn funcname
1740: .Ed
1.119 kristaps 1741: .Pp
1742: See also
1.122 kristaps 1743: .Sx MANUAL STRUCTURE
1.119 kristaps 1744: and
1745: .Sx \&Ft .
1.63 kristaps 1746: .Ss \&Fo
1.120 kristaps 1747: Begin a function block.
1748: This is a multi-line version of
1749: .Sx \&Fn .
1750: Its syntax is as follows:
1751: .Pp
1752: .D1 Pf \. Sx \&Fo Cm funcname
1753: .Pp
1754: Invocations usually occur in the following context:
1755: .Bd -ragged -offset indent
1756: .Pf \. Sx \&Ft Cm functype
1757: .br
1758: .Pf \. Sx \&Fo Cm funcname
1759: .br
1760: .Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname
1761: .br
1762: \.\.\.
1763: .br
1764: .Pf \. Sx \&Fc
1765: .Ed
1766: .Pp
1767: A
1768: .Sx \&Fo
1769: scope is closed by
1770: .Pp
1771: See also
1.122 kristaps 1772: .Sx MANUAL STRUCTURE ,
1.120 kristaps 1773: .Sx \&Fa ,
1774: .Sx \&Fc ,
1775: and
1.63 kristaps 1776: .Ss \&Ft
1.120 kristaps 1777: A function type.
1778: Its syntax is as follows:
1779: .Pp
1780: .D1 Pf \. Sx \&Ft Cm functype
1781: .Pp
1782: Examples:
1783: .D1 \&.Ft int
1784: .Bd -literal -offset indent -compact
1785: \&.Ft functype
1786: \&.Fn funcname
1787: .Ed
1788: .Pp
1789: See also
1.122 kristaps 1790: .Sx MANUAL STRUCTURE ,
1791: .Sx \&Fn ,
1.120 kristaps 1792: and
1.122 kristaps 1793: .Sx \&Fo .
1.63 kristaps 1794: .Ss \&Fx
1.65 kristaps 1795: Format the FreeBSD version provided as an argument, or a default value
1796: if no argument is provided.
1797: .Pp
1798: Examples:
1.91 kristaps 1799: .D1 \&.Fx 7.1
1800: .D1 \&.Fx
1.65 kristaps 1801: .Pp
1802: See also
1803: .Sx \&At ,
1.66 kristaps 1804: .Sx \&Bsx ,
1.65 kristaps 1805: .Sx \&Bx ,
1.66 kristaps 1806: .Sx \&Dx ,
1.65 kristaps 1807: .Sx \&Nx ,
1808: .Sx \&Ox ,
1809: and
1810: .Sx \&Ux .
1.63 kristaps 1811: .Ss \&Hf
1812: .Ss \&Ic
1813: .Ss \&In
1.118 kristaps 1814: An
1815: .Qq include
1816: file.
1817: In the
1818: .Em SYNOPSIS
1819: section (only if invoked as the line macro), the first argument is
1820: preceded by
1821: .Qq #include ,
1.122 kristaps 1822: the arguments is enclosed in angled braces.
1.118 kristaps 1823: .Pp
1.122 kristaps 1824: Examples:
1.118 kristaps 1825: .D1 \&.In sys/types
1.122 kristaps 1826: .Pp
1827: See also
1828: .Sx MANUAL STRUCTURE .
1.63 kristaps 1829: .Ss \&It
1.120 kristaps 1830: A list item.
1831: The syntax of this macro depends on the list type.
1.114 kristaps 1832: .Pp
1833: Lists
1834: of type
1835: .Fl hang ,
1836: .Fl ohang ,
1837: .Fl inset ,
1838: and
1839: .Fl diag
1.120 kristaps 1840: have the following syntax:
1.114 kristaps 1841: .Pp
1.120 kristaps 1842: .D1 Pf \. Sx \&It Cm args
1.114 kristaps 1843: .Pp
1844: Lists of type
1845: .Fl bullet ,
1846: .Fl dash ,
1847: .Fl enum ,
1848: .Fl hyphen
1849: and
1850: .Fl item
1.120 kristaps 1851: have the following syntax:
1.114 kristaps 1852: .Pp
1.120 kristaps 1853: .D1 Pf \. Sx \&It
1.114 kristaps 1854: .Pp
1855: with subsequent lines interpreted within the scope of the
1856: .Sx \&It
1857: until either a closing
1858: .Sx \&El
1859: or another
1860: .Sx \&It .
1861: .Pp
1862: The
1863: .Fl tag
1.120 kristaps 1864: list has the following syntax:
1.114 kristaps 1865: .Pp
1.120 kristaps 1866: .D1 Pf \. Sx \&It Op Cm args
1.114 kristaps 1867: .Pp
1.120 kristaps 1868: Subsequent lines are interpreted as with
1.114 kristaps 1869: .Fl bullet
1870: and family.
1871: The line arguments correspond to the list's left-hand side; body
1872: arguments correspond to the list's contents.
1873: .Pp
1874: The
1875: .Fl column
1876: list is the most complicated.
1.120 kristaps 1877: Its syntax is as follows:
1.114 kristaps 1878: .Pp
1.120 kristaps 1879: .D1 Pf \. Sx \&It Op Cm args
1.114 kristaps 1880: .Pp
1.120 kristaps 1881: The
1.114 kristaps 1882: .Cm args
1883: are phrases, a mix of macros and text corresponding to a line column,
1884: delimited by tabs or the special
1885: .Sq \&Ta
1886: pseudo-macro.
1887: Lines subsequent the
1888: .Sx \&It
1889: are interpreted within the scope of the last phrase.
1890: Calling the pseudo-macro
1891: .Sq \&Ta
1892: will open a new phrase scope (this must occur on a macro line to be
1893: interpreted as a macro). Note that the tab phrase delimiter may only be
1894: used within the
1895: .Sx \&It
1896: line itself.
1897: Subsequent this, only the
1898: .Sq \&Ta
1899: pseudo-macro may be used to delimit phrases.
1.124 kristaps 1900: Furthermore, note that quoted sections propagate over tab-delimited
1.114 kristaps 1901: phrases on an
1902: .Sx \&It ,
1903: for example,
1904: .Pp
1.121 kristaps 1905: .D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
1.114 kristaps 1906: .Pp
1907: will preserve the semicolon whitespace except for the last.
1908: .Pp
1909: See also
1910: .Sx \&Bl .
1.63 kristaps 1911: .Ss \&Lb
1.109 kristaps 1912: Specify a library.
1.120 kristaps 1913: The syntax is as follows:
1.109 kristaps 1914: .Pp
1.120 kristaps 1915: .D1 Pf \. Sx \&Lb Cm library
1.109 kristaps 1916: .Pp
1917: The
1918: .Cm library
1919: parameter may be a system library, such as
1920: .Cm libz
1921: or
1922: .Cm libpam ,
1923: in which case a small library description is printed next to the linker
1924: invocation; or a custom library, in which case the library name is
1925: printed in quotes.
1926: This is most commonly used in the
1927: .Em SYNOPSIS
1928: section as described in
1929: .Sx MANUAL STRUCTURE .
1930: .Pp
1931: Examples:
1932: .D1 \&.Lb libz
1933: .D1 \&.Lb mdoc
1.63 kristaps 1934: .Ss \&Li
1935: .Ss \&Lk
1.100 kristaps 1936: Format a hyperlink.
1.120 kristaps 1937: Its syntax is as follows:
1.70 kristaps 1938: .Pp
1.120 kristaps 1939: .D1 Pf \. Sx \&Lk Cm uri Op Cm name
1.70 kristaps 1940: .Pp
1941: Examples:
1.91 kristaps 1942: .D1 \&.Lk http://bsd.lv "The BSD.lv Project"
1943: .D1 \&.Lk http://bsd.lv
1.70 kristaps 1944: .Pp
1945: See also
1946: .Sx \&Mt .
1.63 kristaps 1947: .Ss \&Lp
1948: .Ss \&Ms
1949: .Ss \&Mt
1.116 kristaps 1950: Format a
1951: .Qq mailto:
1952: hyperlink.
1.120 kristaps 1953: Its syntax is as follows:
1.116 kristaps 1954: .Pp
1.120 kristaps 1955: .D1 Pf \. Sx \&Mt Cm address
1.116 kristaps 1956: .Pp
1957: Examples:
1958: .D1 \&.Mt discuss@manpages.bsd.lv
1.63 kristaps 1959: .Ss \&Nd
1960: .Ss \&Nm
1961: .Ss \&No
1962: .Ss \&Ns
1963: .Ss \&Nx
1.65 kristaps 1964: Format the NetBSD version provided as an argument, or a default value if
1965: no argument is provided.
1966: .Pp
1967: Examples:
1.91 kristaps 1968: .D1 \&.Nx 5.01
1969: .D1 \&.Nx
1.65 kristaps 1970: .Pp
1971: See also
1972: .Sx \&At ,
1.66 kristaps 1973: .Sx \&Bsx ,
1.65 kristaps 1974: .Sx \&Bx ,
1.66 kristaps 1975: .Sx \&Dx ,
1.65 kristaps 1976: .Sx \&Fx ,
1977: .Sx \&Ox ,
1978: and
1979: .Sx \&Ux .
1.63 kristaps 1980: .Ss \&Oc
1981: .Ss \&Oo
1982: .Ss \&Op
1983: .Ss \&Os
1.100 kristaps 1984: Document operating system version.
1985: This is the mandatory third macro of
1.66 kristaps 1986: any
1987: .Nm
1.120 kristaps 1988: file.
1989: Its syntax is as follows:
1.66 kristaps 1990: .Pp
1.120 kristaps 1991: .D1 Pf \. Sx \&Os Op Cm system
1.66 kristaps 1992: .Pp
1993: The optional
1994: .Cm system
1.100 kristaps 1995: parameter specifies the relevant operating system or environment.
1996: Left unspecified, it defaults to the local operating system version.
1997: This is the suggested form.
1.66 kristaps 1998: .Pp
1999: Examples:
1.91 kristaps 2000: .D1 \&.Os
2001: .D1 \&.Os KTH/CSC/TCS
2002: .D1 \&.Os BSD 4.3
1.66 kristaps 2003: .Pp
2004: See also
2005: .Sx \&Dd
2006: and
2007: .Sx \&Dt .
1.63 kristaps 2008: .Ss \&Ot
1.66 kristaps 2009: Unknown usage.
2010: .Pp
2011: .Em Remarks :
2012: this macro has been deprecated.
1.63 kristaps 2013: .Ss \&Ox
1.65 kristaps 2014: Format the OpenBSD version provided as an argument, or a default value
2015: if no argument is provided.
2016: .Pp
2017: Examples:
1.91 kristaps 2018: .D1 \&.Ox 4.5
2019: .D1 \&.Ox
1.65 kristaps 2020: .Pp
2021: See also
2022: .Sx \&At ,
2023: .Sx \&Bsx ,
2024: .Sx \&Bx ,
1.66 kristaps 2025: .Sx \&Dx ,
1.65 kristaps 2026: .Sx \&Fx ,
2027: .Sx \&Nx ,
2028: and
2029: .Sx \&Ux .
1.63 kristaps 2030: .Ss \&Pa
2031: .Ss \&Pc
2032: .Ss \&Pf
2033: .Ss \&Po
2034: .Ss \&Pp
2035: .Ss \&Pq
2036: .Ss \&Qc
2037: .Ss \&Ql
2038: .Ss \&Qo
2039: .Ss \&Qq
2040: .Ss \&Re
2041: Closes a
2042: .Sx \&Rs
1.100 kristaps 2043: block.
2044: Does not have any tail arguments.
1.63 kristaps 2045: .Ss \&Rs
2046: Begins a bibliographic
2047: .Pq Dq reference
1.100 kristaps 2048: block.
2049: Does not have any head arguments.
2050: The block macro may only contain
1.63 kristaps 2051: .Sx \&%A ,
2052: .Sx \&%B ,
2053: .Sx \&%C ,
2054: .Sx \&%D ,
2055: .Sx \&%I ,
2056: .Sx \&%J ,
2057: .Sx \&%N ,
2058: .Sx \&%O ,
2059: .Sx \&%P ,
2060: .Sx \&%Q ,
2061: .Sx \&%R ,
2062: .Sx \&%T ,
1.120 kristaps 2063: .Sx \&%U ,
1.63 kristaps 2064: and
2065: .Sx \&%V
2066: child macros (at least one must be specified).
2067: .Pp
1.64 kristaps 2068: Examples:
1.91 kristaps 2069: .Bd -literal -offset indent -compact
1.63 kristaps 2070: \&.Rs
2071: \&.%A J. E. Hopcroft
2072: \&.%A J. D. Ullman
2073: \&.%B Introduction to Automata Theory, Languages, and Computation
2074: \&.%I Addison-Wesley
2075: \&.%C Reading, Massachusettes
2076: \&.%D 1979
2077: \&.Re
2078: .Ed
2079: .Pp
2080: If an
2081: .Sx \&Rs
2082: block is used within a SEE ALSO section, a vertical space is asserted
2083: before the rendered output, else the block continues on the current
2084: line.
2085: .Ss \&Rv
2086: .Ss \&Sc
2087: .Ss \&Sh
2088: .Ss \&Sm
2089: .Ss \&So
2090: .Ss \&Sq
2091: .Ss \&Ss
2092: .Ss \&St
2093: .Ss \&Sx
2094: .Ss \&Sy
2095: .Ss \&Tn
2096: .Ss \&Ud
1.110 kristaps 2097: Prints out
2098: .Dq currently under development.
1.63 kristaps 2099: .Ss \&Ux
1.100 kristaps 2100: Format the UNIX name.
2101: Accepts no argument.
1.65 kristaps 2102: .Pp
2103: Examples:
1.91 kristaps 2104: .D1 \&.Ux
1.65 kristaps 2105: .Pp
2106: See also
2107: .Sx \&At ,
1.66 kristaps 2108: .Sx \&Bsx ,
1.65 kristaps 2109: .Sx \&Bx ,
1.66 kristaps 2110: .Sx \&Dx ,
1.65 kristaps 2111: .Sx \&Fx ,
2112: .Sx \&Nx ,
2113: and
2114: .Sx \&Ox .
1.63 kristaps 2115: .Ss \&Va
2116: .Ss \&Vt
1.100 kristaps 2117: A variable type.
1.122 kristaps 2118: This is also used for indicating global variables in the
2119: .Em SYNOPSIS
1.100 kristaps 2120: section, in which case a variable name is also specified.
2121: Note that it accepts
1.83 kristaps 2122: .Sx Block partial-implicit
1.123 kristaps 2123: syntax when invoked as the first macro in the
1.122 kristaps 2124: .Em SYNOPSIS
2125: section, else it accepts ordinary
1.83 kristaps 2126: .Sx In-line
2127: syntax.
2128: .Pp
2129: Note that this should not be confused with
2130: .Sx \&Ft ,
2131: which is used for function return types.
2132: .Pp
2133: Examples:
1.91 kristaps 2134: .D1 \&.Vt unsigned char
1.121 kristaps 2135: .D1 \&.Vt extern const char * const sys_signame[] \&;
1.83 kristaps 2136: .Pp
2137: See also
1.122 kristaps 2138: .Sx MANUAL STRUCTURE
1.83 kristaps 2139: and
2140: .Sx \&Va .
1.84 kristaps 2141: .Ss \&Xc
1.87 kristaps 2142: Close a scope opened by
2143: .Sx \&Xo .
1.84 kristaps 2144: .Ss \&Xo
1.100 kristaps 2145: Open an extension scope.
2146: This macro originally existed to extend the 9-argument limit of troff;
2147: since this limit has been lifted, the macro has been deprecated.
1.84 kristaps 2148: .Ss \&Xr
2149: Link to another manual
2150: .Pq Qq cross-reference .
1.120 kristaps 2151: Its syntax is as follows:
1.84 kristaps 2152: .Pp
1.120 kristaps 2153: .D1 Pf \. Sx \&Xr Cm name section
1.84 kristaps 2154: .Pp
2155: The
2156: .Cm name
2157: and
2158: .Cm section
1.100 kristaps 2159: are the name and section of the linked manual.
2160: If
1.84 kristaps 2161: .Cm section
2162: is followed by non-punctuation, an
2163: .Sx \&Ns
1.100 kristaps 2164: is inserted into the token stream.
2165: This behaviour is for compatibility with
1.84 kristaps 2166: .Xr groff 1 .
2167: .Pp
2168: Examples:
1.91 kristaps 2169: .D1 \&.Xr mandoc 1
1.121 kristaps 2170: .D1 \&.Xr mandoc 1 \&;
1.91 kristaps 2171: .D1 \&.Xr mandoc 1 \&Ns s behaviour
1.84 kristaps 2172: .Ss \&br
2173: .Ss \&sp
1.4 kristaps 2174: .Sh COMPATIBILITY
1.93 kristaps 2175: This section documents compatibility between mandoc and other other
2176: troff implementations, at this time limited to GNU troff
2177: .Pq Qq groff .
1.50 kristaps 2178: The term
1.57 kristaps 2179: .Qq historic groff
1.93 kristaps 2180: refers to groff versions before the
1.57 kristaps 2181: .Pa doc.tmac
1.50 kristaps 2182: file re-write
1.57 kristaps 2183: .Pq somewhere between 1.15 and 1.19 .
2184: .Pp
1.93 kristaps 2185: Heirloom troff, the other significant troff implementation accepting
2186: \-mdoc, is similar to historic groff.
2187: .Pp
1.57 kristaps 2188: .Bl -dash -compact
1.125 kristaps 2189: .It
1.126 kristaps 2190: Old groff fails to assert a newline before
2191: .Sx \&Bd Fl ragged compact .
1.119 kristaps 2192: .It
1.120 kristaps 2193: groff behaves inconsistently when encountering
2194: .Pf non- Sx \&Fa
2195: children of
2196: .Sx \&Fo
2197: regarding spacing between arguments.
2198: In mandoc, this is not the case: each argument is consistently followed
2199: by a single space and the trailing
2200: .Sq \&)
2201: suppresses prior spacing.
2202: .It
2203: groff behaves inconsistently when encountering
2204: .Sx \&Ft
2205: and
2206: .Sx \&Fn
2207: in the
2208: .Em SYNOPSIS :
1.124 kristaps 2209: at times newline(s) are suppressed depending on whether a prior
1.120 kristaps 2210: .Sx \&Fn
2211: has been invoked.
2212: In mandoc, this is not the case.
2213: See
2214: .Sx \&Ft
2215: and
2216: .Sx \&Fn
2217: for the normalised behaviour.
2218: .It
1.119 kristaps 2219: Historic groff does not break before an
2220: .Sx \&Fn
2221: when not invoked as the line macro in the
2222: .Em SYNOPSIS
2223: section.
1.118 kristaps 2224: .It
2225: Historic groff formats the
2226: .Sx \&In
2227: badly: trailing arguments are trashed and
2228: .Em SYNOPSIS
2229: is not specially treated.
1.115 kristaps 2230: .It
2231: groff does not accept the
2232: .Sq \&Ta
2233: pseudo-macro as a line macro.
2234: mandoc does.
1.57 kristaps 2235: .It
1.81 kristaps 2236: The comment syntax
2237: .Sq \e."
2238: is no longer accepted.
2239: .It
1.93 kristaps 2240: In groff, the
1.80 kristaps 2241: .Sx \&Pa
2242: macro does not format its arguments when used in the FILES section under
1.100 kristaps 2243: certain list types.
2244: mandoc does.
1.80 kristaps 2245: .It
1.93 kristaps 2246: Historic groff does not print a dash for empty
1.79 kristaps 2247: .Sx \&Fl
1.100 kristaps 2248: arguments.
2249: mandoc and newer groff implementations do.
1.79 kristaps 2250: .It
1.93 kristaps 2251: groff behaves irregularly when specifying
1.77 kristaps 2252: .Sq \ef
1.93 kristaps 2253: .Sx Text Decoration
1.100 kristaps 2254: within line-macro scopes.
2255: mandoc follows a consistent system.
1.77 kristaps 2256: .It
1.93 kristaps 2257: In mandoc, negative scaling units are truncated to zero; groff would
1.100 kristaps 2258: move to prior lines.
2259: Furthermore, the
1.61 kristaps 2260: .Sq f
2261: scaling unit, while accepted, is rendered as the default unit.
2262: .It
1.48 kristaps 2263: In quoted literals, groff allowed pair-wise double-quotes to produce a
1.100 kristaps 2264: standalone double-quote in formatted output.
2265: This idiosyncratic behaviour is not applicable in mandoc.
1.57 kristaps 2266: .It
1.126 kristaps 2267: Display offsets
1.78 kristaps 2268: .Sx \&Bd
1.126 kristaps 2269: .Fl offset Ar center
1.64 kristaps 2270: and
1.126 kristaps 2271: .Fl offset Ar right
2272: are disregarded in mandoc.
2273: Furthermore, the
1.64 kristaps 2274: .Fl file Ar file
1.126 kristaps 2275: argument is not supported in mandoc.
1.100 kristaps 2276: Lastly, since text is not right-justified in mandoc (or even groff),
1.64 kristaps 2277: .Fl ragged
2278: and
2279: .Fl filled
2280: are aliases, as are
2281: .Fl literal
2282: and
2283: .Fl unfilled .
1.57 kristaps 2284: .It
1.100 kristaps 2285: Historic groff has many un-callable macros.
2286: Most of these (excluding some block-level macros) are now callable.
1.57 kristaps 2287: .It
1.50 kristaps 2288: The vertical bar
1.57 kristaps 2289: .Sq \(ba
1.28 kristaps 2290: made historic groff
1.57 kristaps 2291: .Qq go orbital
1.93 kristaps 2292: but has been a proper delimiter since then.
1.57 kristaps 2293: .It
1.93 kristaps 2294: .Sx \&It Fl nested
1.28 kristaps 2295: is assumed for all lists (it wasn't in historic groff): any list may be
2296: nested and
1.64 kristaps 2297: .Fl enum
1.4 kristaps 2298: lists will restart the sequence only for the sub-list.
1.57 kristaps 2299: .It
1.4 kristaps 2300: Some manuals use
1.64 kristaps 2301: .Sx \&Li
1.4 kristaps 2302: incorrectly by following it with a reserved character and expecting the
1.100 kristaps 2303: delimiter to render.
2304: This is not supported in mandoc.
1.93 kristaps 2305: .It
2306: In groff, the
2307: .Sx \&Cd ,
2308: .Sx \&Er ,
1.106 kristaps 2309: .Sx \&Ex ,
1.93 kristaps 2310: and
1.106 kristaps 2311: .Sx \&Rv
1.100 kristaps 2312: macros were stipulated only to occur in certain manual sections.
2313: mandoc does not have these restrictions.
1.105 kristaps 2314: .It
2315: Newer groff and mandoc print
2316: .Qq AT&T UNIX
2317: prior to unknown arguments of
2318: .Sx \&At ;
2319: older groff did nothing.
1.57 kristaps 2320: .El
1.2 kristaps 2321: .Sh SEE ALSO
1.57 kristaps 2322: .Xr mandoc 1 ,
2323: .Xr mandoc_char 7
1.2 kristaps 2324: .Sh AUTHORS
2325: The
1.57 kristaps 2326: .Nm
1.50 kristaps 2327: reference was written by
1.94 kristaps 2328: .An Kristaps Dzonsons Aq kristaps@bsd.lv .
1.64 kristaps 2329: .\"
2330: .\" XXX: this really isn't the place for these caveats.
2331: .\" .
2332: .\" .
2333: .\" .Sh CAVEATS
2334: .\" There are many ambiguous parts of mdoc.
2335: .\" .
2336: .\" .Pp
2337: .\" .Bl -dash -compact
2338: .\" .It
2339: .\" .Sq \&Fa
2340: .\" should be
2341: .\" .Sq \&Va
2342: .\" as function arguments are variables.
2343: .\" .It
2344: .\" .Sq \&Ft
2345: .\" should be
2346: .\" .Sq \&Vt
2347: .\" as function return types are still types. Furthermore, the
2348: .\" .Sq \&Ft
2349: .\" should be removed and
2350: .\" .Sq \&Fo ,
2351: .\" which ostensibly follows it, should follow the same convention as
2352: .\" .Sq \&Va .
2353: .\" .It
2354: .\" .Sq \&Va
2355: .\" should formalise that only one or two arguments are acceptable: a
2356: .\" variable name and optional, preceding type.
2357: .\" .It
2358: .\" .Sq \&Fd
2359: .\" is ambiguous. It's commonly used to indicate an include file in the
2360: .\" synopsis section.
2361: .\" .Sq \&In
2362: .\" should be used, instead.
2363: .\" .It
2364: .\" Only the
2365: .\" .Sq \-literal
2366: .\" argument to
2367: .\" .Sq \&Bd
2368: .\" makes sense. The remaining ones should be removed.
2369: .\" .It
2370: .\" The
2371: .\" .Sq \&Xo
2372: .\" and
2373: .\" .Sq \&Xc
2374: .\" macros should be deprecated.
2375: .\" .It
2376: .\" The
2377: .\" .Sq \&Dt
2378: .\" macro lacks clarity. It should be absolutely clear which title will
2379: .\" render when formatting the manual page.
2380: .\" .It
2381: .\" A
2382: .\" .Sq \&Lx
2383: .\" should be provided for Linux (\(`a la
2384: .\" .Sq \&Ox ,
2385: .\" .Sq \&Nx
2386: .\" etc.).
2387: .\" .It
2388: .\" There's no way to refer to references in
2389: .\" .Sq \&Rs/Re
2390: .\" blocks.
2391: .\" .It
2392: .\" The \-split and \-nosplit dictates via
2393: .\" .Sq \&An
2394: .\" are re-set when entering and leaving the AUTHORS section.
2395: .\" .El
2396: .\" .
CVSweb