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