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