Annotation of mandoc/mdoc.7, Revision 1.299
1.299 ! schwarze 1: .\" $Id: mdoc.7,v 1.298 2025/06/05 13:48:19 schwarze Exp $
1.1 kristaps 2: .\"
1.298 schwarze 3: .\" Copyright (c) 2010-2021, 2024, 2025 Ingo Schwarze <schwarze@openbsd.org>
1.179 schwarze 4: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
1.22 kristaps 7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: .\"
1.22 kristaps 10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.50 kristaps 17: .\"
1.299 ! schwarze 18: .Dd $Mdocdate: June 5 2025 $
1.20 kristaps 19: .Dt MDOC 7
1.1 kristaps 20: .Os
21: .Sh NAME
1.57 kristaps 22: .Nm mdoc
1.211 schwarze 23: .Nd semantic markup language for formatting manual pages
1.1 kristaps 24: .Sh DESCRIPTION
25: The
1.57 kristaps 26: .Nm mdoc
1.211 schwarze 27: language supports authoring of manual pages for the
28: .Xr man 1
29: utility by allowing semantic annotations of words, phrases,
30: page sections and complete manual pages.
31: Such annotations are used by formatting tools to achieve a uniform
32: presentation across all manuals written in
33: .Nm ,
34: and to support hyperlinking if supported by the output medium.
35: .Pp
36: This reference document describes the structure of manual pages
37: and the syntax and usage of the
1.200 kristaps 38: .Nm
1.211 schwarze 39: language.
40: The reference implementation of a parsing and formatting tool is
1.144 schwarze 41: .Xr mandoc 1 ;
42: the
1.57 kristaps 43: .Sx COMPATIBILITY
1.200 kristaps 44: section describes compatibility with other implementations.
1.57 kristaps 45: .Pp
1.211 schwarze 46: In an
1.57 kristaps 47: .Nm
1.211 schwarze 48: document, lines beginning with the control character
1.185 kristaps 49: .Sq \&.
1.211 schwarze 50: are called
51: .Dq macro lines .
52: The first word is the macro name.
53: It consists of two or three letters.
54: Most macro names begin with a capital letter.
55: For a list of available macros, see
56: .Sx MACRO OVERVIEW .
57: The words following the macro name are arguments to the macro, optionally
58: including the names of other, callable macros; see
59: .Sx MACRO SYNTAX
60: for details.
61: .Pp
62: Lines not beginning with the control character are called
63: .Dq text lines .
64: They provide free-form text to be printed; the formatting of the text
65: depends on the respective processing context:
1.57 kristaps 66: .Bd -literal -offset indent
1.13 kristaps 67: \&.Sh Macro lines change control state.
1.185 kristaps 68: Text lines are interpreted within the current state.
1.57 kristaps 69: .Ed
1.211 schwarze 70: .Pp
71: Many aspects of the basic syntax of the
1.57 kristaps 72: .Nm
1.211 schwarze 73: language are based on the
74: .Xr roff 7
75: language; see the
76: .Em LANGUAGE SYNTAX
77: and
78: .Em MACRO SYNTAX
79: sections in the
80: .Xr roff 7
81: manual for details, in particular regarding
82: comments, escape sequences, whitespace, and quoting.
83: However, using
84: .Xr roff 7
85: requests in
1.200 kristaps 86: .Nm
1.211 schwarze 87: documents is discouraged;
88: .Xr mandoc 1
89: supports some of them merely for backward compatibility.
1.43 kristaps 90: .Sh MANUAL STRUCTURE
1.66 kristaps 91: A well-formed
1.57 kristaps 92: .Nm
1.66 kristaps 93: document consists of a document prologue followed by one or more
94: sections.
95: .Pp
1.141 kristaps 96: The prologue, which consists of the
1.274 schwarze 97: .Ic \&Dd ,
98: .Ic \&Dt ,
1.33 kristaps 99: and
1.274 schwarze 100: .Ic \&Os
1.141 kristaps 101: macros in that order, is required for every document.
1.66 kristaps 102: .Pp
1.82 kristaps 103: The first section (sections are denoted by
1.274 schwarze 104: .Ic \&Sh )
1.66 kristaps 105: must be the NAME section, consisting of at least one
1.274 schwarze 106: .Ic \&Nm
1.50 kristaps 107: followed by
1.274 schwarze 108: .Ic \&Nd .
1.66 kristaps 109: .Pp
1.122 kristaps 110: Following that, convention dictates specifying at least the
111: .Em SYNOPSIS
112: and
113: .Em DESCRIPTION
114: sections, although this varies between manual sections.
1.66 kristaps 115: .Pp
116: The following is a well-formed skeleton
117: .Nm
1.188 kristaps 118: file for a utility
119: .Qq progname :
1.57 kristaps 120: .Bd -literal -offset indent
1.43 kristaps 121: \&.Dd $\&Mdocdate$
1.188 kristaps 122: \&.Dt PROGNAME section
1.43 kristaps 123: \&.Os
124: \&.Sh NAME
1.188 kristaps 125: \&.Nm progname
1.194 schwarze 126: \&.Nd one line about what it does
1.203 kristaps 127: \&.\e\(dq .Sh LIBRARY
1.227 schwarze 128: \&.\e\(dq For sections 2, 3, and 9 only.
1.203 kristaps 129: \&.\e\(dq Not used in OpenBSD.
1.58 kristaps 130: \&.Sh SYNOPSIS
1.188 kristaps 131: \&.Nm progname
1.58 kristaps 132: \&.Op Fl options
133: \&.Ar
134: \&.Sh DESCRIPTION
135: The
136: \&.Nm
137: utility processes files ...
1.228 schwarze 138: \&.\e\(dq .Sh CONTEXT
139: \&.\e\(dq For section 9 functions only.
1.203 kristaps 140: \&.\e\(dq .Sh IMPLEMENTATION NOTES
141: \&.\e\(dq Not used in OpenBSD.
142: \&.\e\(dq .Sh RETURN VALUES
1.227 schwarze 143: \&.\e\(dq For sections 2, 3, and 9 function return values only.
1.203 kristaps 144: \&.\e\(dq .Sh ENVIRONMENT
1.227 schwarze 145: \&.\e\(dq For sections 1, 6, 7, and 8 only.
1.203 kristaps 146: \&.\e\(dq .Sh FILES
147: \&.\e\(dq .Sh EXIT STATUS
1.227 schwarze 148: \&.\e\(dq For sections 1, 6, and 8 only.
1.203 kristaps 149: \&.\e\(dq .Sh EXAMPLES
150: \&.\e\(dq .Sh DIAGNOSTICS
1.227 schwarze 151: \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
1.203 kristaps 152: \&.\e\(dq .Sh ERRORS
1.227 schwarze 153: \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
1.203 kristaps 154: \&.\e\(dq .Sh SEE ALSO
155: \&.\e\(dq .Xr foobar 1
156: \&.\e\(dq .Sh STANDARDS
157: \&.\e\(dq .Sh HISTORY
158: \&.\e\(dq .Sh AUTHORS
159: \&.\e\(dq .Sh CAVEATS
160: \&.\e\(dq .Sh BUGS
161: \&.\e\(dq .Sh SECURITY CONSIDERATIONS
162: \&.\e\(dq Not used in OpenBSD.
1.57 kristaps 163: .Ed
164: .Pp
1.144 schwarze 165: The sections in an
1.66 kristaps 166: .Nm
1.100 kristaps 167: document are conventionally ordered as they appear above.
168: Sections should be composed as follows:
1.73 kristaps 169: .Bl -ohang -offset Ds
170: .It Em NAME
1.144 schwarze 171: The name(s) and a one line description of the documented material.
1.100 kristaps 172: The syntax for this as follows:
1.73 kristaps 173: .Bd -literal -offset indent
1.144 schwarze 174: \&.Nm name0 ,
175: \&.Nm name1 ,
1.73 kristaps 176: \&.Nm name2
1.144 schwarze 177: \&.Nd a one line description
1.73 kristaps 178: .Ed
179: .Pp
1.185 kristaps 180: Multiple
181: .Sq \&Nm
182: names should be separated by commas.
183: .Pp
1.73 kristaps 184: The
1.274 schwarze 185: .Ic \&Nm
1.73 kristaps 186: macro(s) must precede the
1.274 schwarze 187: .Ic \&Nd
1.73 kristaps 188: macro.
1.80 kristaps 189: .Pp
1.82 kristaps 190: See
1.274 schwarze 191: .Ic \&Nm
1.80 kristaps 192: and
1.274 schwarze 193: .Ic \&Nd .
1.73 kristaps 194: .It Em LIBRARY
1.298 schwarze 195: The name of the library containing the documented functions.
196: Using this section is no longer recommended.
197: If any
198: .Ic \&Lb
199: macro is needed, put it at the beginning of the
200: .Em SYNOPSIS
201: section instead.
1.73 kristaps 202: .It Em SYNOPSIS
203: Documents the utility invocation syntax, function call syntax, or device
1.82 kristaps 204: configuration.
1.73 kristaps 205: .Pp
206: For the first, utilities (sections 1, 6, and 8), this is
207: generally structured as follows:
208: .Bd -literal -offset indent
1.185 kristaps 209: \&.Nm bar
1.73 kristaps 210: \&.Op Fl v
211: \&.Op Fl o Ar file
212: \&.Op Ar
1.185 kristaps 213: \&.Nm foo
1.73 kristaps 214: \&.Op Fl v
215: \&.Op Fl o Ar file
216: \&.Op Ar
217: .Ed
218: .Pp
1.185 kristaps 219: Commands should be ordered alphabetically.
220: .Pp
1.73 kristaps 221: For the second, function calls (sections 2, 3, 9):
222: .Bd -literal -offset indent
1.298 schwarze 223: \&.Lb libname \e" unless the functions are in libc
1.146 kristaps 224: \&.In header.h
1.73 kristaps 225: \&.Vt extern const char *global;
1.299 ! schwarze 226: \&.Ft char *
1.73 kristaps 227: \&.Fn foo "const char *src"
1.299 ! schwarze 228: \&.Ft char *
1.73 kristaps 229: \&.Fn bar "const char *src"
230: .Ed
231: .Pp
1.185 kristaps 232: Ordering of
1.274 schwarze 233: .Ic \&In ,
234: .Ic \&Vt ,
235: .Ic \&Fn ,
1.185 kristaps 236: and
1.274 schwarze 237: .Ic \&Fo
1.185 kristaps 238: macros should follow C header-file conventions.
239: .Pp
1.73 kristaps 240: And for the third, configurations (section 4):
241: .Bd -literal -offset indent
1.203 kristaps 242: \&.Cd \(dqit* at isa? port 0x2e\(dq
243: \&.Cd \(dqit* at isa? port 0x4e\(dq
1.73 kristaps 244: .Ed
245: .Pp
1.82 kristaps 246: Manuals not in these sections generally don't need a
1.73 kristaps 247: .Em SYNOPSIS .
1.80 kristaps 248: .Pp
1.122 kristaps 249: Some macros are displayed differently in the
250: .Em SYNOPSIS
251: section, particularly
1.274 schwarze 252: .Ic \&Nm ,
253: .Ic \&Cd ,
254: .Ic \&Fd ,
255: .Ic \&Fn ,
256: .Ic \&Fo ,
257: .Ic \&In ,
258: .Ic \&Vt ,
1.122 kristaps 259: and
1.274 schwarze 260: .Ic \&Ft .
1.138 kristaps 261: All of these macros are output on their own line.
1.144 schwarze 262: If two such dissimilar macros are pairwise invoked (except for
1.274 schwarze 263: .Ic \&Ft
1.122 kristaps 264: before
1.274 schwarze 265: .Ic \&Fo
1.122 kristaps 266: or
1.274 schwarze 267: .Ic \&Fn ) ,
1.122 kristaps 268: they are separated by a vertical space, unless in the case of
1.274 schwarze 269: .Ic \&Fo ,
270: .Ic \&Fn ,
1.122 kristaps 271: and
1.274 schwarze 272: .Ic \&Ft ,
1.122 kristaps 273: which are always separated by vertical space.
1.128 schwarze 274: .Pp
275: When text and macros following an
1.274 schwarze 276: .Ic \&Nm
1.128 schwarze 277: macro starting an input line span multiple output lines,
278: all output lines but the first will be indented to align
279: with the text immediately following the
1.274 schwarze 280: .Ic \&Nm
1.128 schwarze 281: macro, up to the next
1.274 schwarze 282: .Ic \&Nm ,
283: .Ic \&Sh ,
1.128 schwarze 284: or
1.274 schwarze 285: .Ic \&Ss
1.128 schwarze 286: macro or the end of an enclosing block, whichever comes first.
1.73 kristaps 287: .It Em DESCRIPTION
1.185 kristaps 288: This begins with an expansion of the brief, one line description in
289: .Em NAME :
290: .Bd -literal -offset indent
291: The
292: \&.Nm
293: utility does this, that, and the other.
294: .Ed
295: .Pp
296: It usually follows with a breakdown of the options (if documenting a
1.73 kristaps 297: command), such as:
298: .Bd -literal -offset indent
1.285 schwarze 299: The options are as follows:
1.73 kristaps 300: \&.Bl \-tag \-width Ds
301: \&.It Fl v
302: Print verbose information.
303: \&.El
304: .Ed
1.257 schwarze 305: .Pp
306: List the options in alphabetical order,
307: uppercase before lowercase for each letter and
308: with no regard to whether an option takes an argument.
309: Put digits in ascending order before all letter options.
1.80 kristaps 310: .Pp
1.73 kristaps 311: Manuals not documenting a command won't include the above fragment.
1.198 schwarze 312: .Pp
313: Since the
314: .Em DESCRIPTION
315: section usually contains most of the text of a manual, longer manuals
316: often use the
1.274 schwarze 317: .Ic \&Ss
1.198 schwarze 318: macro to form subsections.
319: In very long manuals, the
320: .Em DESCRIPTION
321: may be split into multiple sections, each started by an
1.274 schwarze 322: .Ic \&Sh
1.198 schwarze 323: macro followed by a non-standard section name, and each having
324: several subsections, like in the present
325: .Nm
326: manual.
1.228 schwarze 327: .It Em CONTEXT
328: This section lists the contexts in which functions can be called in section 9.
329: The contexts are autoconf, process, or interrupt.
1.73 kristaps 330: .It Em IMPLEMENTATION NOTES
1.100 kristaps 331: Implementation-specific notes should be kept here.
332: This is useful when implementing standard functions that may have side
333: effects or notable algorithmic implications.
1.73 kristaps 334: .It Em RETURN VALUES
1.144 schwarze 335: This section documents the
336: return values of functions in sections 2, 3, and 9.
1.73 kristaps 337: .Pp
338: See
1.274 schwarze 339: .Ic \&Rv .
1.73 kristaps 340: .It Em ENVIRONMENT
1.141 kristaps 341: Lists the environment variables used by the utility,
342: and explains the syntax and semantics of their values.
343: The
344: .Xr environ 7
345: manual provides examples of typical content and formatting.
1.73 kristaps 346: .Pp
347: See
1.274 schwarze 348: .Ic \&Ev .
1.73 kristaps 349: .It Em FILES
1.100 kristaps 350: Documents files used.
1.141 kristaps 351: It's helpful to document both the file name and a short description of how
1.100 kristaps 352: the file is used (created, modified, etc.).
1.73 kristaps 353: .Pp
354: See
1.274 schwarze 355: .Ic \&Pa .
1.99 kristaps 356: .It Em EXIT STATUS
1.144 schwarze 357: This section documents the
358: command exit status for section 1, 6, and 8 utilities.
1.100 kristaps 359: Historically, this information was described in
1.99 kristaps 360: .Em DIAGNOSTICS ,
361: a practise that is now discouraged.
362: .Pp
363: See
1.274 schwarze 364: .Ic \&Ex .
1.73 kristaps 365: .It Em EXAMPLES
1.100 kristaps 366: Example usages.
367: This often contains snippets of well-formed, well-tested invocations.
1.144 schwarze 368: Make sure that examples work properly!
1.73 kristaps 369: .It Em DIAGNOSTICS
1.227 schwarze 370: Documents error messages.
371: In section 4 and 9 manuals, these are usually messages printed by the
372: kernel to the console and to the kernel log.
373: In section 1, 6, 7, and 8, these are usually messages printed by
374: userland programs to the standard error output.
375: .Pp
1.73 kristaps 376: Historically, this section was used in place of
377: .Em EXIT STATUS
378: for manuals in sections 1, 6, and 8; however, this practise is
379: discouraged.
380: .Pp
381: See
1.274 schwarze 382: .Ic \&Bl
1.80 kristaps 383: .Fl diag .
1.73 kristaps 384: .It Em ERRORS
1.227 schwarze 385: Documents
386: .Xr errno 2
387: settings in sections 2, 3, 4, and 9.
1.73 kristaps 388: .Pp
389: See
1.274 schwarze 390: .Ic \&Er .
1.73 kristaps 391: .It Em SEE ALSO
1.100 kristaps 392: References other manuals with related topics.
393: This section should exist for most manuals.
394: Cross-references should conventionally be ordered first by section, then
1.238 schwarze 395: alphabetically (ignoring case).
1.73 kristaps 396: .Pp
1.198 schwarze 397: References to other documentation concerning the topic of the manual page,
398: for example authoritative books or journal articles, may also be
399: provided in this section.
400: .Pp
1.73 kristaps 401: See
1.274 schwarze 402: .Ic \&Rs
1.198 schwarze 403: and
1.274 schwarze 404: .Ic \&Xr .
1.73 kristaps 405: .It Em STANDARDS
1.100 kristaps 406: References any standards implemented or used.
407: If not adhering to any standards, the
1.73 kristaps 408: .Em HISTORY
409: section should be used instead.
410: .Pp
411: See
1.274 schwarze 412: .Ic \&St .
1.73 kristaps 413: .It Em HISTORY
1.198 schwarze 414: A brief history of the subject, including where it was first implemented,
415: and when it was ported to or reimplemented for the operating system at hand.
1.73 kristaps 416: .It Em AUTHORS
1.143 schwarze 417: Credits to the person or persons who wrote the code and/or documentation.
1.141 kristaps 418: Authors should generally be noted by both name and email address.
1.73 kristaps 419: .Pp
420: See
1.274 schwarze 421: .Ic \&An .
1.73 kristaps 422: .It Em CAVEATS
1.141 kristaps 423: Common misuses and misunderstandings should be explained
1.73 kristaps 424: in this section.
425: .It Em BUGS
1.147 kristaps 426: Known bugs, limitations, and work-arounds should be described
1.141 kristaps 427: in this section.
1.73 kristaps 428: .It Em SECURITY CONSIDERATIONS
429: Documents any security precautions that operators should consider.
1.66 kristaps 430: .El
1.211 schwarze 431: .Sh MACRO OVERVIEW
432: This overview is sorted such that macros of similar purpose are listed
433: together, to help find the best macro for any given purpose.
434: Deprecated macros are not included in the overview, but can be found below
435: in the alphabetical
436: .Sx MACRO REFERENCE .
437: .Ss Document preamble and NAME section macros
438: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 439: .It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year
440: .It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch
1.290 schwarze 441: .It Ic \&Os Ta operating system footer: Op Ar footer text
1.274 schwarze 442: .It Ic \&Nm Ta document name (one argument)
443: .It Ic \&Nd Ta document description (one line)
1.211 schwarze 444: .El
445: .Ss Sections and cross references
446: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 447: .It Ic \&Sh Ta section header (one line)
448: .It Ic \&Ss Ta subsection header (one line)
449: .It Ic \&Sx Ta internal cross reference to a section or subsection
450: .It Ic \&Xr Ta cross reference to another manual page: Ar name section
1.280 schwarze 451: .It Ic \&Tg Ta tag the definition of a Ar term Pq <= 1 arguments
1.274 schwarze 452: .It Ic \&Pp Ta start a text paragraph (no arguments)
1.211 schwarze 453: .El
454: .Ss Displays and lists
455: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 456: .It Ic \&Bd , \&Ed Ta display block:
1.211 schwarze 457: .Fl Ar type
458: .Op Fl offset Ar width
459: .Op Fl compact
1.274 schwarze 460: .It Ic \&D1 Ta indented display (one line)
461: .It Ic \&Dl Ta indented literal display (one line)
1.297 schwarze 462: .It Ic \&Ql Ta normal in-line literal display: Ql text
463: .It Ic \&Li Ta unquoted in-line literal display: Li text
1.274 schwarze 464: .It Ic \&Bl , \&El Ta list block:
1.211 schwarze 465: .Fl Ar type
466: .Op Fl width Ar val
467: .Op Fl offset Ar val
468: .Op Fl compact
1.274 schwarze 469: .It Ic \&It Ta list item (syntax depends on Fl Ar type )
470: .It Ic \&Ta Ta table cell separator in Ic \&Bl Fl column No lists
471: .It Ic \&Rs , \&%* , \&Re Ta bibliographic block (references)
1.57 kristaps 472: .El
1.211 schwarze 473: .Ss Spacing control
474: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 475: .It Ic \&Pf Ta prefix, no following horizontal space (one argument)
476: .It Ic \&Ns Ta roman font, no preceding horizontal space (no arguments)
477: .It Ic \&Ap Ta apostrophe without surrounding whitespace (no arguments)
478: .It Ic \&Sm Ta switch horizontal spacing mode: Op Cm on | off
479: .It Ic \&Bk , \&Ek Ta keep block: Fl words
1.57 kristaps 480: .El
1.268 schwarze 481: .Ss Semantic markup for command line utilities
1.211 schwarze 482: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 483: .It Ic \&Nm Ta start a SYNOPSIS block with the name of a utility
484: .It Ic \&Fl Ta command line options (flags) (>=0 arguments)
485: .It Ic \&Cm Ta command modifier (>0 arguments)
486: .It Ic \&Ar Ta command arguments (>=0 arguments)
487: .It Ic \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)
488: .It Ic \&Ic Ta internal or interactive command (>0 arguments)
489: .It Ic \&Ev Ta environmental variable (>0 arguments)
490: .It Ic \&Pa Ta file system path (>=0 arguments)
1.57 kristaps 491: .El
1.268 schwarze 492: .Ss Semantic markup for function libraries
1.211 schwarze 493: .Bl -column "Brq, Bro, Brc" description
1.298 schwarze 494: .It Ic \&Lb Ta function library (>0 arguments)
1.274 schwarze 495: .It Ic \&In Ta include file (one argument)
496: .It Ic \&Fd Ta other preprocessor directive (>0 arguments)
497: .It Ic \&Ft Ta function type (>0 arguments)
498: .It Ic \&Fo , \&Fc Ta function block: Ar funcname
499: .It Ic \&Fn Ta function name: Ar funcname Op Ar argument ...
500: .It Ic \&Fa Ta function argument (>0 arguments)
501: .It Ic \&Vt Ta variable type (>0 arguments)
502: .It Ic \&Va Ta variable name (>0 arguments)
503: .It Ic \&Dv Ta defined variable or preprocessor constant (>0 arguments)
504: .It Ic \&Er Ta error constant (>0 arguments)
505: .It Ic \&Ev Ta environmental variable (>0 arguments)
1.57 kristaps 506: .El
1.268 schwarze 507: .Ss Various semantic markup
1.211 schwarze 508: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 509: .It Ic \&An Ta author name (>0 arguments)
510: .It Ic \&Lk Ta hyperlink: Ar uri Op Ar display_name
511: .It Ic \&Mt Ta Do mailto Dc hyperlink: Ar localpart Ns @ Ns Ar domain
512: .It Ic \&Cd Ta kernel configuration declaration (>0 arguments)
513: .It Ic \&Ad Ta memory address (>0 arguments)
514: .It Ic \&Ms Ta mathematical symbol (>0 arguments)
1.190 schwarze 515: .El
1.211 schwarze 516: .Ss Physical markup
517: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 518: .It Ic \&Em Ta italic font or underline (emphasis) (>0 arguments)
519: .It Ic \&Sy Ta boldface font (symbolic) (>0 arguments)
1.275 schwarze 520: .It Ic \&No Ta return to roman font (normal) (>0 arguments)
1.274 schwarze 521: .It Ic \&Bf , \&Ef Ta font block: Fl Ar type | Cm \&Em | \&Li | \&Sy
1.82 kristaps 522: .El
1.211 schwarze 523: .Ss Physical enclosures
524: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 525: .It Ic \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text
526: .It Ic \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text
527: .It Ic \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
528: .It Ic \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text
529: .It Ic \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
530: .It Ic \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
531: .It Ic \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text
532: .It Ic \&Eo , \&Ec Ta generic enclosure
1.195 schwarze 533: .El
1.211 schwarze 534: .Ss Text production
535: .Bl -column "Brq, Bro, Brc" description
1.274 schwarze 536: .It Ic \&Ex Fl std Ta standard command exit values: Op Ar utility ...
537: .It Ic \&Rv Fl std Ta standard function return values: Op Ar function ...
538: .It Ic \&St Ta reference to a standards document (one argument)
539: .It Ic \&At Ta At
540: .It Ic \&Bx Ta Bx
541: .It Ic \&Bsx Ta Bsx
542: .It Ic \&Nx Ta Nx
543: .It Ic \&Fx Ta Fx
544: .It Ic \&Ox Ta Ox
545: .It Ic \&Dx Ta Dx
1.195 schwarze 546: .El
1.211 schwarze 547: .Sh MACRO REFERENCE
548: This section is a canonical reference of all macros, arranged
549: alphabetically.
550: For the scoping of individual macros, see
551: .Sx MACRO SYNTAX .
1.274 schwarze 552: .Bl -tag -width 3n
553: .It Ic \&%A Ar first_name ... last_name
1.211 schwarze 554: Author name of an
1.274 schwarze 555: .Ic \&Rs
1.211 schwarze 556: block.
557: Multiple authors should each be accorded their own
1.274 schwarze 558: .Ic \%%A
1.211 schwarze 559: line.
560: Author names should be ordered with full or abbreviated forename(s)
561: first, then full surname.
1.274 schwarze 562: .It Ic \&%B Ar title
1.211 schwarze 563: Book title of an
1.274 schwarze 564: .Ic \&Rs
1.138 kristaps 565: block.
566: This macro may also be used in a non-bibliographic context when
1.63 kristaps 567: referring to book titles.
1.274 schwarze 568: .It Ic \&%C Ar location
1.63 kristaps 569: Publication city or location of an
1.274 schwarze 570: .Ic \&Rs
1.63 kristaps 571: block.
1.274 schwarze 572: .It Ic \&%D Oo Ar month day , Oc Ar year
1.63 kristaps 573: Publication date of an
1.274 schwarze 574: .Ic \&Rs
1.138 kristaps 575: block.
1.274 schwarze 576: Provide the full English name of the
577: .Ar month
578: and all four digits of the
1.181 schwarze 579: .Ar year .
1.274 schwarze 580: .It Ic \&%I Ar name
1.63 kristaps 581: Publisher or issuer name of an
1.274 schwarze 582: .Ic \&Rs
1.63 kristaps 583: block.
1.274 schwarze 584: .It Ic \&%J Ar name
1.63 kristaps 585: Journal name of an
1.274 schwarze 586: .Ic \&Rs
1.63 kristaps 587: block.
1.274 schwarze 588: .It Ic \&%N Ar number
1.63 kristaps 589: Issue number (usually for journals) of an
1.274 schwarze 590: .Ic \&Rs
1.63 kristaps 591: block.
1.274 schwarze 592: .It Ic \&%O Ar line
1.63 kristaps 593: Optional information of an
1.274 schwarze 594: .Ic \&Rs
1.63 kristaps 595: block.
1.274 schwarze 596: .It Ic \&%P Ar number
1.63 kristaps 597: Book or journal page number of an
1.274 schwarze 598: .Ic \&Rs
1.63 kristaps 599: block.
1.277 schwarze 600: Conventionally, the argument starts with
601: .Ql p.\&
602: for a single page or
603: .Ql pp.\&
604: for a range of pages, for example:
605: .Pp
606: .Dl .%P pp. 42\e(en47
1.274 schwarze 607: .It Ic \&%Q Ar name
1.63 kristaps 608: Institutional author (school, government, etc.) of an
1.274 schwarze 609: .Ic \&Rs
1.138 kristaps 610: block.
611: Multiple institutional authors should each be accorded their own
1.274 schwarze 612: .Ic \&%Q
1.63 kristaps 613: line.
1.274 schwarze 614: .It Ic \&%R Ar name
1.63 kristaps 615: Technical report name of an
1.274 schwarze 616: .Ic \&Rs
1.63 kristaps 617: block.
1.274 schwarze 618: .It Ic \&%T Ar title
1.63 kristaps 619: Article title of an
1.274 schwarze 620: .Ic \&Rs
1.138 kristaps 621: block.
622: This macro may also be used in a non-bibliographical context when
623: referring to article titles.
1.274 schwarze 624: .It Ic \&%U Ar protocol Ns :// Ns Ar path
1.70 kristaps 625: URI of reference document.
1.274 schwarze 626: .It Ic \&%V Ar number
1.63 kristaps 627: Volume number of an
1.274 schwarze 628: .Ic \&Rs
1.63 kristaps 629: block.
1.274 schwarze 630: .It Ic \&Ac
1.141 kristaps 631: Close an
1.274 schwarze 632: .Ic \&Ao
1.138 kristaps 633: block.
634: Does not have any tail arguments.
1.287 schwarze 635: .Tg Ad
1.274 schwarze 636: .It Ic \&Ad Ar address
1.141 kristaps 637: Memory address.
638: Do not use this for postal addresses.
1.63 kristaps 639: .Pp
1.64 kristaps 640: Examples:
1.173 kristaps 641: .Dl \&.Ad [0,$]
642: .Dl \&.Ad 0x00000000
1.287 schwarze 643: .Tg An
1.274 schwarze 644: .It Ic \&An Fl split | nosplit | Ar first_name ... last_name
1.100 kristaps 645: Author name.
1.196 schwarze 646: Can be used both for the authors of the program, function, or driver
647: documented in the manual, or for the authors of the manual itself.
1.141 kristaps 648: Requires either the name of an author or one of the following arguments:
1.140 kristaps 649: .Pp
650: .Bl -tag -width "-nosplitX" -offset indent -compact
1.64 kristaps 651: .It Fl split
1.141 kristaps 652: Start a new output line before each subsequent invocation of
1.274 schwarze 653: .Ic \&An .
1.64 kristaps 654: .It Fl nosplit
655: The opposite of
656: .Fl split .
657: .El
658: .Pp
1.141 kristaps 659: The default is
660: .Fl nosplit .
661: The effect of selecting either of the
662: .Fl split
663: modes ends at the beginning of the
664: .Em AUTHORS
665: section.
1.140 kristaps 666: In the
667: .Em AUTHORS
1.141 kristaps 668: section, the default is
669: .Fl nosplit
670: for the first author listing and
1.64 kristaps 671: .Fl split
1.141 kristaps 672: for all other author listings.
1.64 kristaps 673: .Pp
674: Examples:
1.173 kristaps 675: .Dl \&.An -nosplit
1.219 schwarze 676: .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
1.274 schwarze 677: .It Ic \&Ao Ar block
1.141 kristaps 678: Begin a block enclosed by angle brackets.
1.100 kristaps 679: Does not have any head arguments.
1.270 schwarze 680: This macro is almost never useful.
681: See
1.274 schwarze 682: .Ic \&Aq
1.270 schwarze 683: for more details.
1.287 schwarze 684: .Tg Ap
1.274 schwarze 685: .It Ic \&Ap
1.138 kristaps 686: Inserts an apostrophe without any surrounding whitespace.
1.124 kristaps 687: This is generally used as a grammatical device when referring to the verb
1.140 kristaps 688: form of a function.
689: .Pp
690: Examples:
1.173 kristaps 691: .Dl \&.Fn execve \&Ap d
1.287 schwarze 692: .Tg Aq
1.274 schwarze 693: .It Ic \&Aq Ar line
694: Enclose the rest of the input line in angle brackets.
1.270 schwarze 695: The only important use case is for email addresses.
696: See
1.274 schwarze 697: .Ic \&Mt
1.270 schwarze 698: for an example.
1.64 kristaps 699: .Pp
1.270 schwarze 700: Occasionally, it is used for names of characters and keys, for example:
701: .Bd -literal -offset indent
702: Press the
703: \&.Aq escape
704: key to ...
705: .Ed
1.64 kristaps 706: .Pp
1.270 schwarze 707: For URIs, use
1.274 schwarze 708: .Ic \&Lk
1.270 schwarze 709: instead, and
1.274 schwarze 710: .Ic \&In
1.270 schwarze 711: for
712: .Dq #include
713: directives.
714: Never wrap
1.274 schwarze 715: .Ic \&Ar
1.270 schwarze 716: in
1.274 schwarze 717: .Ic \&Aq .
1.270 schwarze 718: .Pp
719: Since
1.274 schwarze 720: .Ic \&Aq
1.270 schwarze 721: usually renders with non-ASCII characters in non-ASCII output modes,
722: do not use it where the ASCII characters
723: .Sq <
724: and
725: .Sq >
726: are required as syntax elements.
727: Instead, use these characters directly in such cases, combining them
728: with the macros
1.274 schwarze 729: .Ic \&Pf ,
730: .Ic \&Ns ,
1.64 kristaps 731: or
1.274 schwarze 732: .Ic \&Eo
1.270 schwarze 733: as needed.
1.64 kristaps 734: .Pp
735: See also
1.274 schwarze 736: .Ic \&Ao .
1.287 schwarze 737: .Tg Ar
1.274 schwarze 738: .It Ic \&Ar Op Ar placeholder ...
1.100 kristaps 739: Command arguments.
740: If an argument is not provided, the string
1.141 kristaps 741: .Dq file ...\&
1.66 kristaps 742: is used as a default.
1.64 kristaps 743: .Pp
744: Examples:
1.196 schwarze 745: .Dl ".Fl o Ar file"
746: .Dl ".Ar"
747: .Dl ".Ar arg1 , arg2 ."
748: .Pp
749: The arguments to the
1.274 schwarze 750: .Ic \&Ar
1.196 schwarze 751: macro are names and placeholders for command arguments;
752: for fixed strings to be passed verbatim as arguments, use
1.274 schwarze 753: .Ic \&Fl
1.196 schwarze 754: or
1.274 schwarze 755: .Ic \&Cm .
1.287 schwarze 756: .Tg At
1.274 schwarze 757: .It Ic \&At Op Ar version
1.220 schwarze 758: Formats an
759: .At
760: version.
1.141 kristaps 761: Accepts one optional argument:
1.140 kristaps 762: .Pp
763: .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
1.64 kristaps 764: .It Cm v[1-7] | 32v
765: A version of
766: .At .
1.192 schwarze 767: .It Cm III
768: .At III .
1.265 schwarze 769: .It Cm V | V.[1-4]
1.141 kristaps 770: A version of
771: .At V .
1.64 kristaps 772: .El
773: .Pp
1.141 kristaps 774: Note that these arguments do not begin with a hyphen.
1.64 kristaps 775: .Pp
776: Examples:
1.173 kristaps 777: .Dl \&.At
1.192 schwarze 778: .Dl \&.At III
1.173 kristaps 779: .Dl \&.At V.1
1.65 kristaps 780: .Pp
781: See also
1.274 schwarze 782: .Ic \&Bsx ,
783: .Ic \&Bx ,
784: .Ic \&Dx ,
785: .Ic \&Fx ,
786: .Ic \&Nx ,
1.65 kristaps 787: and
1.274 schwarze 788: .Ic \&Ox .
789: .It Ic \&Bc
1.141 kristaps 790: Close a
1.274 schwarze 791: .Ic \&Bo
1.138 kristaps 792: block.
793: Does not have any tail arguments.
1.287 schwarze 794: .Tg Bd
1.274 schwarze 795: .It Ic \&Bd Fl Ns Ar type Oo Fl offset Ar width Oc Op Fl compact
1.141 kristaps 796: Begin a display block.
797: Display blocks are used to select a different indentation and
798: justification than the one used by the surrounding text.
1.185 kristaps 799: They may contain both macro lines and text lines.
1.141 kristaps 800: By default, a display block is preceded by a vertical space.
1.64 kristaps 801: .Pp
1.141 kristaps 802: The
803: .Ar type
804: must be one of the following:
805: .Bl -tag -width 13n -offset indent
806: .It Fl centered
1.249 schwarze 807: Produce one output line from each input line, and center-justify each line.
1.141 kristaps 808: Using this display type is not recommended; many
809: .Nm
810: implementations render it poorly.
811: .It Fl filled
1.198 schwarze 812: Change the positions of line breaks to fill each line, and left- and
813: right-justify the resulting block.
1.141 kristaps 814: .It Fl literal
1.198 schwarze 815: Produce one output line from each input line,
816: and do not justify the block at all.
1.169 kristaps 817: Preserve white space as it appears in the input.
1.198 schwarze 818: Always use a constant-width font.
819: Use this for displaying source code.
1.64 kristaps 820: .It Fl ragged
1.198 schwarze 821: Change the positions of line breaks to fill each line, and left-justify
822: the resulting block.
1.64 kristaps 823: .It Fl unfilled
1.198 schwarze 824: The same as
825: .Fl literal ,
826: but using the same font as for normal text, which is a variable width font
827: if supported by the output device.
1.64 kristaps 828: .El
829: .Pp
1.141 kristaps 830: The
831: .Ar type
832: must be provided first.
833: Additional arguments may follow:
834: .Bl -tag -width 13n -offset indent
835: .It Fl offset Ar width
836: Indent the display by the
837: .Ar width ,
838: which may be one of the following:
1.64 kristaps 839: .Bl -item
840: .It
1.141 kristaps 841: One of the pre-defined strings
842: .Cm indent ,
1.198 schwarze 843: the width of a standard indentation (six constant width characters);
1.141 kristaps 844: .Cm indent-two ,
1.64 kristaps 845: twice
1.141 kristaps 846: .Cm indent ;
847: .Cm left ,
1.131 kristaps 848: which has no effect;
1.141 kristaps 849: .Cm right ,
850: which justifies to the right margin; or
851: .Cm center ,
1.249 schwarze 852: which aligns around an imagined center axis.
1.64 kristaps 853: .It
1.141 kristaps 854: A macro invocation, which selects a predefined width
855: associated with that macro.
1.100 kristaps 856: The most popular is the imaginary macro
1.67 kristaps 857: .Ar \&Ds ,
1.64 kristaps 858: which resolves to
1.141 kristaps 859: .Sy 6n .
1.64 kristaps 860: .It
1.215 schwarze 861: A scaling width as described in
862: .Xr roff 7 .
1.64 kristaps 863: .It
1.141 kristaps 864: An arbitrary string, which indents by the length of this string.
1.64 kristaps 865: .El
866: .Pp
1.141 kristaps 867: When the argument is missing,
868: .Fl offset
869: is ignored.
1.64 kristaps 870: .It Fl compact
1.141 kristaps 871: Do not assert vertical space before the display.
1.64 kristaps 872: .El
873: .Pp
874: Examples:
875: .Bd -literal -offset indent
1.141 kristaps 876: \&.Bd \-literal \-offset indent \-compact
1.65 kristaps 877: Hello world.
1.64 kristaps 878: \&.Ed
879: .Ed
1.66 kristaps 880: .Pp
881: See also
1.274 schwarze 882: .Ic \&D1
1.66 kristaps 883: and
1.274 schwarze 884: .Ic \&Dl .
1.287 schwarze 885: .Tg Bf
1.274 schwarze 886: .It Ic \&Bf Fl emphasis | literal | symbolic | Cm \&Em | \&Li | \&Sy
1.129 kristaps 887: Change the font mode for a scoped block of text.
888: The
889: .Fl emphasis
890: and
891: .Cm \&Em
892: argument are equivalent, as are
893: .Fl symbolic
894: and
1.144 schwarze 895: .Cm \&Sy ,
1.129 kristaps 896: and
897: .Fl literal
898: and
899: .Cm \&Li .
900: Without an argument, this macro does nothing.
901: The font mode continues until broken by a new font mode in a nested
902: scope or
1.274 schwarze 903: .Ic \&Ef
1.129 kristaps 904: is encountered.
905: .Pp
906: See also
1.274 schwarze 907: .Ic \&Li ,
908: .Ic \&Ef ,
909: .Ic \&Em ,
1.129 kristaps 910: and
1.274 schwarze 911: .Ic \&Sy .
1.287 schwarze 912: .Tg Bk
1.274 schwarze 913: .It Ic \&Bk Fl words
1.186 schwarze 914: For each macro, keep its output together on the same output line,
915: until the end of the macro or the end of the input line is reached,
916: whichever comes first.
1.185 kristaps 917: Line breaks in text lines are unaffected.
1.131 kristaps 918: .Pp
1.133 kristaps 919: The
920: .Fl words
1.141 kristaps 921: argument is required; additional arguments are ignored.
1.127 schwarze 922: .Pp
1.141 kristaps 923: The following example will not break within each
1.274 schwarze 924: .Ic \&Op
1.133 kristaps 925: macro line:
1.127 schwarze 926: .Bd -literal -offset indent
927: \&.Bk \-words
1.133 kristaps 928: \&.Op Fl f Ar flags
929: \&.Op Fl o Ar output
1.127 schwarze 930: \&.Ek
931: .Ed
1.129 kristaps 932: .Pp
1.133 kristaps 933: Be careful in using over-long lines within a keep block!
934: Doing so will clobber the right margin.
1.287 schwarze 935: .Tg Bl
1.274 schwarze 936: .It Xo
937: .Ic \&Bl
1.141 kristaps 938: .Fl Ns Ar type
1.131 kristaps 939: .Op Fl width Ar val
940: .Op Fl offset Ar val
941: .Op Fl compact
1.274 schwarze 942: .Op Ar col ...
943: .Xc
944: Begin a list.
945: Lists consist of items specified using the
946: .Ic \&It
947: macro, containing a head or a body or both.
1.131 kristaps 948: .Pp
1.141 kristaps 949: The list
950: .Ar type
951: is mandatory and must be specified first.
952: The
953: .Fl width
954: and
955: .Fl offset
1.240 schwarze 956: arguments accept macro names as described for
1.274 schwarze 957: .Ic \&Bd
1.240 schwarze 958: .Fl offset ,
959: scaling widths as described in
960: .Xr roff 7 ,
1.141 kristaps 961: or use the length of the given string.
962: The
963: .Fl offset
964: is a global indentation for the whole list, affecting both item heads
965: and bodies.
966: For those list types supporting it, the
967: .Fl width
968: argument requests an additional indentation of item bodies,
969: to be added to the
970: .Fl offset .
971: Unless the
972: .Fl compact
973: argument is specified, list entries are separated by vertical space.
974: .Pp
1.103 kristaps 975: A list must specify one of the following list types:
976: .Bl -tag -width 12n -offset indent
977: .It Fl bullet
1.141 kristaps 978: No item heads can be specified, but a bullet will be printed at the head
979: of each item.
980: Item bodies start on the same output line as the bullet
981: and are indented according to the
1.104 kristaps 982: .Fl width
1.141 kristaps 983: argument.
1.103 kristaps 984: .It Fl column
985: A columnated list.
1.104 kristaps 986: The
987: .Fl width
1.262 schwarze 988: argument has no effect; instead, the string length of each argument
989: specifies the width of one column.
1.141 kristaps 990: If the first line of the body of a
1.114 kristaps 991: .Fl column
992: list is not an
1.274 schwarze 993: .Ic \&It
1.141 kristaps 994: macro line,
1.274 schwarze 995: .Ic \&It
1.141 kristaps 996: contexts spanning one input line each are implied until an
1.274 schwarze 997: .Ic \&It
1.141 kristaps 998: macro line is encountered, at which point items start being interpreted as
1.114 kristaps 999: described in the
1.274 schwarze 1000: .Ic \&It
1.114 kristaps 1001: documentation.
1.103 kristaps 1002: .It Fl dash
1.141 kristaps 1003: Like
1004: .Fl bullet ,
1005: except that dashes are used in place of bullets.
1.103 kristaps 1006: .It Fl diag
1007: Like
1008: .Fl inset ,
1.141 kristaps 1009: except that item heads are not parsed for macro invocations.
1.198 schwarze 1010: Most often used in the
1011: .Em DIAGNOSTICS
1012: section with error constants in the item heads.
1.103 kristaps 1013: .It Fl enum
1.141 kristaps 1014: A numbered list.
1.198 schwarze 1015: No item heads can be specified.
1.141 kristaps 1016: Formatted like
1017: .Fl bullet ,
1.291 schwarze 1018: except that ordinal numbers are used in place of bullets,
1.141 kristaps 1019: starting at 1.
1.103 kristaps 1020: .It Fl hang
1021: Like
1022: .Fl tag ,
1.141 kristaps 1023: except that the first lines of item bodies are not indented, but follow
1024: the item heads like in
1025: .Fl inset
1026: lists.
1.103 kristaps 1027: .It Fl hyphen
1028: Synonym for
1029: .Fl dash .
1030: .It Fl inset
1.141 kristaps 1031: Item bodies follow items heads on the same line, using normal inter-word
1032: spacing.
1033: Bodies are not indented, and the
1.104 kristaps 1034: .Fl width
1035: argument is ignored.
1.103 kristaps 1036: .It Fl item
1.141 kristaps 1037: No item heads can be specified, and none are printed.
1038: Bodies are not indented, and the
1.104 kristaps 1039: .Fl width
1040: argument is ignored.
1.103 kristaps 1041: .It Fl ohang
1.141 kristaps 1042: Item bodies start on the line following item heads and are not indented.
1.104 kristaps 1043: The
1044: .Fl width
1045: argument is ignored.
1.103 kristaps 1046: .It Fl tag
1.141 kristaps 1047: Item bodies are indented according to the
1.103 kristaps 1048: .Fl width
1049: argument.
1.141 kristaps 1050: When an item head fits inside the indentation, the item body follows
1051: this head on the same output line.
1052: Otherwise, the body starts on the output line following the head.
1.103 kristaps 1053: .El
1.114 kristaps 1054: .Pp
1.198 schwarze 1055: Lists may be nested within lists and displays.
1056: Nesting of
1057: .Fl column
1058: and
1059: .Fl enum
1060: lists may not be portable.
1061: .Pp
1.114 kristaps 1062: See also
1.274 schwarze 1063: .Ic \&El
1.141 kristaps 1064: and
1.274 schwarze 1065: .Ic \&It .
1066: .It Ic \&Bo Ar block
1.141 kristaps 1067: Begin a block enclosed by square brackets.
1.100 kristaps 1068: Does not have any head arguments.
1.65 kristaps 1069: .Pp
1070: Examples:
1.140 kristaps 1071: .Bd -literal -offset indent -compact
1.65 kristaps 1072: \&.Bo 1 ,
1.91 kristaps 1073: \&.Dv BUFSIZ \&Bc
1.65 kristaps 1074: .Ed
1075: .Pp
1076: See also
1.274 schwarze 1077: .Ic \&Bq .
1.287 schwarze 1078: .Tg Bq
1.274 schwarze 1079: .It Ic \&Bq Ar line
1.82 kristaps 1080: Encloses its arguments in square brackets.
1.65 kristaps 1081: .Pp
1082: Examples:
1.173 kristaps 1083: .Dl \&.Bq 1 , \&Dv BUFSIZ
1.65 kristaps 1084: .Pp
1085: .Em Remarks :
1086: this macro is sometimes abused to emulate optional arguments for
1087: commands; the correct macros to use for this purpose are
1.274 schwarze 1088: .Ic \&Op ,
1089: .Ic \&Oo ,
1.65 kristaps 1090: and
1.274 schwarze 1091: .Ic \&Oc .
1.65 kristaps 1092: .Pp
1093: See also
1.274 schwarze 1094: .Ic \&Bo .
1095: .It Ic \&Brc
1.141 kristaps 1096: Close a
1.274 schwarze 1097: .Ic \&Bro
1.138 kristaps 1098: block.
1099: Does not have any tail arguments.
1.274 schwarze 1100: .It Ic \&Bro Ar block
1.141 kristaps 1101: Begin a block enclosed by curly braces.
1.100 kristaps 1102: Does not have any head arguments.
1.65 kristaps 1103: .Pp
1104: Examples:
1.140 kristaps 1105: .Bd -literal -offset indent -compact
1.65 kristaps 1106: \&.Bro 1 , ... ,
1.91 kristaps 1107: \&.Va n \&Brc
1.65 kristaps 1108: .Ed
1109: .Pp
1110: See also
1.274 schwarze 1111: .Ic \&Brq .
1.287 schwarze 1112: .Tg Brq
1.274 schwarze 1113: .It Ic \&Brq Ar line
1.65 kristaps 1114: Encloses its arguments in curly braces.
1115: .Pp
1116: Examples:
1.173 kristaps 1117: .Dl \&.Brq 1 , ... , \&Va n
1.65 kristaps 1118: .Pp
1119: See also
1.274 schwarze 1120: .Ic \&Bro .
1.287 schwarze 1121: .Tg Bsx
1.274 schwarze 1122: .It Ic \&Bsx Op Ar version
1.220 schwarze 1123: Format the
1124: .Bsx
1125: version provided as an argument, or a default value if
1.65 kristaps 1126: no argument is provided.
1127: .Pp
1128: Examples:
1.173 kristaps 1129: .Dl \&.Bsx 1.0
1130: .Dl \&.Bsx
1.65 kristaps 1131: .Pp
1132: See also
1.274 schwarze 1133: .Ic \&At ,
1134: .Ic \&Bx ,
1135: .Ic \&Dx ,
1136: .Ic \&Fx ,
1137: .Ic \&Nx ,
1.65 kristaps 1138: and
1.274 schwarze 1139: .Ic \&Ox .
1140: .It Ic \&Bt
1.230 schwarze 1141: Supported only for compatibility, do not use this in new manuals.
1.66 kristaps 1142: Prints
1.198 schwarze 1143: .Dq is currently in beta test.
1.287 schwarze 1144: .Tg Bx
1.274 schwarze 1145: .It Ic \&Bx Op Ar version Op Ar variant
1.220 schwarze 1146: Format the
1147: .Bx
1148: version provided as an argument, or a default value if no
1.65 kristaps 1149: argument is provided.
1150: .Pp
1151: Examples:
1.198 schwarze 1152: .Dl \&.Bx 4.3 Tahoe
1.173 kristaps 1153: .Dl \&.Bx 4.4
1154: .Dl \&.Bx
1.65 kristaps 1155: .Pp
1156: See also
1.274 schwarze 1157: .Ic \&At ,
1158: .Ic \&Bsx ,
1159: .Ic \&Dx ,
1160: .Ic \&Fx ,
1161: .Ic \&Nx ,
1.65 kristaps 1162: and
1.274 schwarze 1163: .Ic \&Ox .
1.287 schwarze 1164: .Tg Cd
1.274 schwarze 1165: .It Ic \&Cd Ar line
1.141 kristaps 1166: Kernel configuration declaration.
1.100 kristaps 1167: This denotes strings accepted by
1.66 kristaps 1168: .Xr config 8 .
1.196 schwarze 1169: It is most often used in section 4 manual pages.
1.66 kristaps 1170: .Pp
1171: Examples:
1.173 kristaps 1172: .Dl \&.Cd device le0 at scode?
1.66 kristaps 1173: .Pp
1174: .Em Remarks :
1175: this macro is commonly abused by using quoted literals to retain
1.138 kristaps 1176: whitespace and align consecutive
1.274 schwarze 1177: .Ic \&Cd
1.100 kristaps 1178: declarations.
1179: This practise is discouraged.
1.287 schwarze 1180: .Tg Cm
1.274 schwarze 1181: .It Ic \&Cm Ar keyword ...
1.100 kristaps 1182: Command modifiers.
1.278 schwarze 1183: Typically used for fixed strings passed as arguments to interactive
1184: commands, to commands in interpreted scripts, or to configuration
1185: file directives, unless
1.274 schwarze 1186: .Ic \&Fl
1.196 schwarze 1187: is more appropriate.
1.66 kristaps 1188: .Pp
1189: Examples:
1.196 schwarze 1190: .Dl ".Nm mt Fl f Ar device Cm rewind"
1191: .Dl ".Nm ps Fl o Cm pid , Ns Cm command"
1192: .Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
1.278 schwarze 1193: .Dl ".Ic set Fl o Cm vi"
1194: .Dl ".Ic lookup Cm file bind"
1195: .Dl ".Ic permit Ar identity Op Cm as Ar target"
1.287 schwarze 1196: .Tg D1
1.274 schwarze 1197: .It Ic \&D1 Ar line
1.100 kristaps 1198: One-line indented display.
1199: This is formatted by the default rules and is useful for simple indented
1200: statements.
1201: It is followed by a newline.
1.66 kristaps 1202: .Pp
1203: Examples:
1.173 kristaps 1204: .Dl \&.D1 \&Fl abcdefgh
1.66 kristaps 1205: .Pp
1206: See also
1.274 schwarze 1207: .Ic \&Bd
1.66 kristaps 1208: and
1.274 schwarze 1209: .Ic \&Dl .
1210: .It Ic \&Db
1.242 schwarze 1211: This macro is obsolete.
1212: No replacement is needed.
1213: It is ignored by
1214: .Xr mandoc 1
1215: and groff including its arguments.
1216: It was formerly used to toggle a debugging mode.
1.274 schwarze 1217: .It Ic \&Dc
1.141 kristaps 1218: Close a
1.274 schwarze 1219: .Ic \&Do
1.138 kristaps 1220: block.
1221: Does not have any tail arguments.
1.287 schwarze 1222: .Tg Dd
1.274 schwarze 1223: .It Ic \&Dd Cm $\&Mdocdate$ | Ar month day , year
1.281 schwarze 1224: Document date for display in the page footer,
1225: by convention the date of the last change.
1.100 kristaps 1226: This is the mandatory first macro of any
1.66 kristaps 1227: .Nm
1.100 kristaps 1228: manual.
1.66 kristaps 1229: .Pp
1.82 kristaps 1230: The
1.181 schwarze 1231: .Ar month
1232: is the full English month name, the
1233: .Ar day
1.271 schwarze 1234: is an integer number, and the
1.181 schwarze 1235: .Ar year
1236: is the full four-digit year.
1237: .Pp
1238: Other arguments are not portable; the
1239: .Xr mandoc 1
1240: utility handles them as follows:
1241: .Bl -dash -offset 3n -compact
1242: .It
1243: To have the date automatically filled in by the
1244: .Ox
1245: version of
1.72 kristaps 1246: .Xr cvs 1 ,
1.181 schwarze 1247: the special string
1248: .Dq $\&Mdocdate$
1249: can be given as an argument.
1250: .It
1.233 schwarze 1251: The traditional, purely numeric
1252: .Xr man 7
1253: format
1254: .Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day
1255: is accepted, too.
1.181 schwarze 1256: .It
1257: If a date string cannot be parsed, it is used verbatim.
1258: .It
1259: If no date string is given, the current date is used.
1260: .El
1.66 kristaps 1261: .Pp
1262: Examples:
1.173 kristaps 1263: .Dl \&.Dd $\&Mdocdate$
1.271 schwarze 1264: .Dl \&.Dd $\&Mdocdate: July 2 2018$
1265: .Dl \&.Dd July 2, 2018
1.66 kristaps 1266: .Pp
1267: See also
1.274 schwarze 1268: .Ic \&Dt
1.66 kristaps 1269: and
1.274 schwarze 1270: .Ic \&Os .
1.287 schwarze 1271: .Tg Dl
1.274 schwarze 1272: .It Ic \&Dl Ar line
1.297 schwarze 1273: One-line indented literal display.
1274: This is formatted using a constant-width font
1275: and is useful for commands and invocations.
1.100 kristaps 1276: It is followed by a newline.
1.66 kristaps 1277: .Pp
1278: Examples:
1.173 kristaps 1279: .Dl \&.Dl % mandoc mdoc.7 \e(ba less
1.66 kristaps 1280: .Pp
1281: See also
1.274 schwarze 1282: .Ic \&Ql ,
1283: .Ic \&Bd Fl literal ,
1.66 kristaps 1284: and
1.274 schwarze 1285: .Ic \&D1 .
1286: .It Ic \&Do Ar block
1.141 kristaps 1287: Begin a block enclosed by double quotes.
1.138 kristaps 1288: Does not have any head arguments.
1.66 kristaps 1289: .Pp
1290: Examples:
1.140 kristaps 1291: .Bd -literal -offset indent -compact
1292: \&.Do
1293: April is the cruellest month
1294: \&.Dc
1295: \e(em T.S. Eliot
1296: .Ed
1.66 kristaps 1297: .Pp
1298: See also
1.274 schwarze 1299: .Ic \&Dq .
1.287 schwarze 1300: .Tg Dq
1.274 schwarze 1301: .It Ic \&Dq Ar line
1.138 kristaps 1302: Encloses its arguments in
1303: .Dq typographic
1304: double-quotes.
1.66 kristaps 1305: .Pp
1306: Examples:
1.91 kristaps 1307: .Bd -literal -offset indent -compact
1.66 kristaps 1308: \&.Dq April is the cruellest month
1309: \e(em T.S. Eliot
1310: .Ed
1311: .Pp
1312: See also
1.274 schwarze 1313: .Ic \&Qq ,
1314: .Ic \&Sq ,
1.138 kristaps 1315: and
1.274 schwarze 1316: .Ic \&Do .
1.287 schwarze 1317: .Tg Dt
1.274 schwarze 1318: .It Ic \&Dt Ar TITLE section Op Ar arch
1.233 schwarze 1319: Document title for display in the page header.
1.100 kristaps 1320: This is the mandatory second macro of any
1.66 kristaps 1321: .Nm
1.100 kristaps 1322: file.
1.66 kristaps 1323: .Pp
1324: Its arguments are as follows:
1.233 schwarze 1325: .Bl -tag -width section -offset 2n
1326: .It Ar TITLE
1.111 kristaps 1327: The document's title (name), defaulting to
1.233 schwarze 1328: .Dq UNTITLED
1.111 kristaps 1329: if unspecified.
1.233 schwarze 1330: To achieve a uniform appearance of page header lines,
1331: it should by convention be all caps.
1.141 kristaps 1332: .It Ar section
1.100 kristaps 1333: The manual section.
1334: This may be one of
1.225 schwarze 1335: .Cm 1
1.246 schwarze 1336: .Pq General Commands ,
1.225 schwarze 1337: .Cm 2
1.246 schwarze 1338: .Pq System Calls ,
1.225 schwarze 1339: .Cm 3
1.246 schwarze 1340: .Pq Library Functions ,
1.225 schwarze 1341: .Cm 3p
1.246 schwarze 1342: .Pq Perl Library ,
1.225 schwarze 1343: .Cm 4
1.246 schwarze 1344: .Pq Device Drivers ,
1.225 schwarze 1345: .Cm 5
1.246 schwarze 1346: .Pq File Formats ,
1.225 schwarze 1347: .Cm 6
1.246 schwarze 1348: .Pq Games ,
1.225 schwarze 1349: .Cm 7
1.246 schwarze 1350: .Pq Miscellaneous Information ,
1.225 schwarze 1351: .Cm 8
1.246 schwarze 1352: .Pq System Manager's Manual ,
1353: or
1.225 schwarze 1354: .Cm 9
1.246 schwarze 1355: .Pq Kernel Developer's Manual .
1.111 kristaps 1356: It should correspond to the manual's filename suffix and defaults to
1.233 schwarze 1357: the empty string if unspecified.
1.141 kristaps 1358: .It Ar arch
1.213 schwarze 1359: This specifies the machine architecture a manual page applies to,
1360: where relevant, for example
1361: .Cm alpha ,
1362: .Cm amd64 ,
1363: .Cm i386 ,
1.66 kristaps 1364: or
1.213 schwarze 1365: .Cm sparc64 .
1.243 schwarze 1366: The list of valid architectures varies by operating system.
1.66 kristaps 1367: .El
1368: .Pp
1369: Examples:
1.173 kristaps 1370: .Dl \&.Dt FOO 1
1371: .Dl \&.Dt FOO 9 i386
1.66 kristaps 1372: .Pp
1373: See also
1.274 schwarze 1374: .Ic \&Dd
1.66 kristaps 1375: and
1.274 schwarze 1376: .Ic \&Os .
1.287 schwarze 1377: .Tg Dv
1.274 schwarze 1378: .It Ic \&Dv Ar identifier ...
1.189 kristaps 1379: Defined variables such as preprocessor constants, constant symbols,
1380: enumeration values, and so on.
1.66 kristaps 1381: .Pp
1382: Examples:
1.189 kristaps 1383: .Dl \&.Dv NULL
1.173 kristaps 1384: .Dl \&.Dv BUFSIZ
1385: .Dl \&.Dv STDOUT_FILENO
1.66 kristaps 1386: .Pp
1387: See also
1.274 schwarze 1388: .Ic \&Er
1.189 kristaps 1389: and
1.274 schwarze 1390: .Ic \&Ev
1.222 schwarze 1391: for special-purpose constants,
1.274 schwarze 1392: .Ic \&Va
1.222 schwarze 1393: for variable symbols, and
1.274 schwarze 1394: .Ic \&Fd
1.222 schwarze 1395: for listing preprocessor variable definitions in the
1396: .Em SYNOPSIS .
1.287 schwarze 1397: .Tg Dx
1.274 schwarze 1398: .It Ic \&Dx Op Ar version
1.220 schwarze 1399: Format the
1400: .Dx
1401: version provided as an argument, or a default
1.66 kristaps 1402: value if no argument is provided.
1403: .Pp
1404: Examples:
1.173 kristaps 1405: .Dl \&.Dx 2.4.1
1406: .Dl \&.Dx
1.66 kristaps 1407: .Pp
1408: See also
1.274 schwarze 1409: .Ic \&At ,
1410: .Ic \&Bsx ,
1411: .Ic \&Bx ,
1412: .Ic \&Fx ,
1413: .Ic \&Nx ,
1.66 kristaps 1414: and
1.274 schwarze 1415: .Ic \&Ox .
1416: .It Ic \&Ec Op Ar closing_delimiter
1.131 kristaps 1417: Close a scope started by
1.274 schwarze 1418: .Ic \&Eo .
1.131 kristaps 1419: .Pp
1420: The
1.274 schwarze 1421: .Ar closing_delimiter
1.131 kristaps 1422: argument is used as the enclosure tail, for example, specifying \e(rq
1423: will emulate
1.274 schwarze 1424: .Ic \&Dc .
1425: .It Ic \&Ed
1.131 kristaps 1426: End a display context started by
1.274 schwarze 1427: .Ic \&Bd .
1428: .It Ic \&Ef
1.141 kristaps 1429: End a font mode context started by
1.274 schwarze 1430: .Ic \&Bf .
1431: .It Ic \&Ek
1.141 kristaps 1432: End a keep context started by
1.274 schwarze 1433: .Ic \&Bk .
1434: .It Ic \&El
1.141 kristaps 1435: End a list context started by
1.274 schwarze 1436: .Ic \&Bl .
1.117 kristaps 1437: See also
1.274 schwarze 1438: .Ic \&It .
1.287 schwarze 1439: .Tg Em
1.274 schwarze 1440: .It Ic \&Em Ar word ...
1.235 schwarze 1441: Request an italic font.
1442: If the output device does not provide that, underline.
1443: .Pp
1444: This is most often used for stress emphasis (not to be confused with
1445: importance, see
1.274 schwarze 1446: .Ic \&Sy ) .
1.235 schwarze 1447: In the rare cases where none of the semantic markup macros fit,
1448: it can also be used for technical terms and placeholders, except
1449: that for syntax elements,
1.274 schwarze 1450: .Ic \&Sy
1.235 schwarze 1451: and
1.274 schwarze 1452: .Ic \&Ar
1.235 schwarze 1453: are preferred, respectively.
1.66 kristaps 1454: .Pp
1455: Examples:
1.235 schwarze 1456: .Bd -literal -compact -offset indent
1457: Selected lines are those
1458: \&.Em not
1459: matching any of the specified patterns.
1460: Some of the functions use a
1461: \&.Em hold space
1462: to save the pattern space for subsequent retrieval.
1463: .Ed
1.138 kristaps 1464: .Pp
1465: See also
1.274 schwarze 1466: .Ic \&No ,
1467: .Ic \&Ql ,
1.138 kristaps 1468: and
1.274 schwarze 1469: .Ic \&Sy .
1470: .It Ic \&En Ar word ...
1.231 schwarze 1471: This macro is obsolete.
1472: Use
1.274 schwarze 1473: .Ic \&Eo
1.231 schwarze 1474: or any of the other enclosure macros.
1475: .Pp
1476: It encloses its argument in the delimiters specified by the last
1.274 schwarze 1477: .Ic \&Es
1.231 schwarze 1478: macro.
1.287 schwarze 1479: .Tg Eo
1.274 schwarze 1480: .It Ic \&Eo Op Ar opening_delimiter
1.131 kristaps 1481: An arbitrary enclosure.
1482: The
1.274 schwarze 1483: .Ar opening_delimiter
1.131 kristaps 1484: argument is used as the enclosure head, for example, specifying \e(lq
1485: will emulate
1.274 schwarze 1486: .Ic \&Do .
1.287 schwarze 1487: .Tg Er
1.274 schwarze 1488: .It Ic \&Er Ar identifier ...
1.189 kristaps 1489: Error constants for definitions of the
1490: .Va errno
1491: libc global variable.
1.196 schwarze 1492: This is most often used in section 2 and 3 manual pages.
1.66 kristaps 1493: .Pp
1494: Examples:
1.173 kristaps 1495: .Dl \&.Er EPERM
1496: .Dl \&.Er ENOENT
1.66 kristaps 1497: .Pp
1498: See also
1.274 schwarze 1499: .Ic \&Dv
1.189 kristaps 1500: for general constants.
1.274 schwarze 1501: .It Ic \&Es Ar opening_delimiter closing_delimiter
1.231 schwarze 1502: This macro is obsolete.
1503: Use
1.274 schwarze 1504: .Ic \&Eo
1.231 schwarze 1505: or any of the other enclosure macros.
1506: .Pp
1507: It takes two arguments, defining the delimiters to be used by subsequent
1.274 schwarze 1508: .Ic \&En
1.231 schwarze 1509: macros.
1.287 schwarze 1510: .Tg Ev
1.274 schwarze 1511: .It Ic \&Ev Ar identifier ...
1.66 kristaps 1512: Environmental variables such as those specified in
1513: .Xr environ 7 .
1514: .Pp
1515: Examples:
1.173 kristaps 1516: .Dl \&.Ev DISPLAY
1517: .Dl \&.Ev PATH
1.189 kristaps 1518: .Pp
1519: See also
1.274 schwarze 1520: .Ic \&Dv
1.189 kristaps 1521: for general constants.
1.287 schwarze 1522: .Tg Ex
1.274 schwarze 1523: .It Ic \&Ex Fl std Op Ar utility ...
1.191 kristaps 1524: Insert a standard sentence regarding command exit values of 0 on success
1525: and >0 on failure.
1.196 schwarze 1526: This is most often used in section 1, 6, and 8 manual pages.
1.141 kristaps 1527: .Pp
1.191 kristaps 1528: If
1.66 kristaps 1529: .Ar utility
1.141 kristaps 1530: is not specified, the document's name set by
1.274 schwarze 1531: .Ic \&Nm
1.141 kristaps 1532: is used.
1.191 kristaps 1533: Multiple
1534: .Ar utility
1535: arguments are treated as separate utilities.
1.139 kristaps 1536: .Pp
1537: See also
1.274 schwarze 1538: .Ic \&Rv .
1.287 schwarze 1539: .Tg Fa
1.274 schwarze 1540: .It Ic \&Fa Ar argument ...
1.239 schwarze 1541: Function argument or parameter.
1.232 schwarze 1542: Each argument may be a name and a type (recommended for the
1543: .Em SYNOPSIS
1544: section), a name alone (for function invocations),
1545: or a type alone (for function prototypes).
1546: If both a type and a name are given or if the type consists of multiple
1547: words, all words belonging to the same function argument have to be
1548: given in a single argument to the
1.274 schwarze 1549: .Ic \&Fa
1.232 schwarze 1550: macro.
1551: .Pp
1552: This macro is also used to specify the field name of a structure.
1553: .Pp
1.117 kristaps 1554: Most often, the
1.274 schwarze 1555: .Ic \&Fa
1.117 kristaps 1556: macro is used in the
1557: .Em SYNOPSIS
1.120 kristaps 1558: within
1.274 schwarze 1559: .Ic \&Fo
1.232 schwarze 1560: blocks when documenting multi-line function prototypes.
1.117 kristaps 1561: If invoked with multiple arguments, the arguments are separated by a
1562: comma.
1563: Furthermore, if the following macro is another
1.274 schwarze 1564: .Ic \&Fa ,
1.117 kristaps 1565: the last argument will also have a trailing comma.
1566: .Pp
1567: Examples:
1.173 kristaps 1568: .Dl \&.Fa \(dqconst char *p\(dq
1569: .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
1.232 schwarze 1570: .Dl \&.Fa \(dqchar *\(dq size_t
1.120 kristaps 1571: .Pp
1572: See also
1.274 schwarze 1573: .Ic \&Fo .
1574: .It Ic \&Fc
1.141 kristaps 1575: End a function context started by
1.274 schwarze 1576: .Ic \&Fo .
1.287 schwarze 1577: .Tg Fd
1.274 schwarze 1578: .It Ic \&Fd Pf # Ar directive Op Ar argument ...
1.222 schwarze 1579: Preprocessor directive, in particular for listing it in the
1580: .Em SYNOPSIS .
1581: Historically, it was also used to document include files.
1582: The latter usage has been deprecated in favour of
1.274 schwarze 1583: .Ic \&In .
1.222 schwarze 1584: .Pp
1585: Examples:
1586: .Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler
1587: .Dl \&.Fd #define SIO_MAXNFDS
1588: .Dl \&.Fd #ifdef FS_DEBUG
1589: .Dl \&.Ft void
1590: .Dl \&.Fn dbg_open \(dqconst char *\(dq
1591: .Dl \&.Fd #endif
1.117 kristaps 1592: .Pp
1593: See also
1.222 schwarze 1594: .Sx MANUAL STRUCTURE ,
1.274 schwarze 1595: .Ic \&In ,
1.122 kristaps 1596: and
1.274 schwarze 1597: .Ic \&Dv .
1.287 schwarze 1598: .Tg Fl
1.274 schwarze 1599: .It Ic \&Fl Op Ar word ...
1.196 schwarze 1600: Command-line flag or option.
1.100 kristaps 1601: Used when listing arguments to command-line utilities.
1.286 schwarze 1602: For each argument, prints an ASCII hyphen-minus character
1603: .Sq \- ,
1604: immediately followed by the argument.
1605: If no arguments are provided, a hyphen-minus is printed followed by a space.
1606: If the argument is a macro, a hyphen-minus is prefixed
1607: to the subsequent macro output.
1608: .Pp
1609: Examples:
1610: .Dl ".Nm du Op Fl H | L | P"
1611: .Dl ".Nm ls Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux"
1612: .Dl ".Nm route Cm add Fl inet Ar destination gateway"
1613: .Dl ".Nm locate.updatedb Op Fl \e-fcodes Ns = Ns Ar dbfile"
1614: .Dl ".Nm aucat Fl o Fl"
1615: .Dl ".Nm kill Fl Ar signal_number"
1616: .Pp
1.288 schwarze 1617: For GNU-style long options, escaping the additional hyphen-minus is not
1.286 schwarze 1618: strictly required, but may be safer with future versions of GNU troff; see
1619: .Xr mandoc_char 7
1620: for details.
1.79 kristaps 1621: .Pp
1622: See also
1.274 schwarze 1623: .Ic \&Cm .
1.287 schwarze 1624: .Tg Fn
1.274 schwarze 1625: .It Ic \&Fn Ar funcname Op Ar argument ...
1.119 kristaps 1626: A function name.
1.120 kristaps 1627: .Pp
1.122 kristaps 1628: Function arguments are surrounded in parenthesis and
1.119 kristaps 1629: are delimited by commas.
1630: If no arguments are specified, blank parenthesis are output.
1.196 schwarze 1631: In the
1632: .Em SYNOPSIS
1633: section, this macro starts a new output line,
1634: and a blank line is automatically inserted between function definitions.
1.119 kristaps 1635: .Pp
1636: Examples:
1.203 kristaps 1637: .Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq
1638: .Dl \&.Fn funcname \(dqint arg0\(dq
1.173 kristaps 1639: .Dl \&.Fn funcname arg0
1.276 schwarze 1640: .Bd -literal -offset indent
1.120 kristaps 1641: \&.Ft functype
1642: \&.Fn funcname
1643: .Ed
1.119 kristaps 1644: .Pp
1.163 schwarze 1645: When referring to a function documented in another manual page, use
1.274 schwarze 1646: .Ic \&Xr
1.163 schwarze 1647: instead.
1.119 kristaps 1648: See also
1.196 schwarze 1649: .Sx MANUAL STRUCTURE ,
1.274 schwarze 1650: .Ic \&Fo ,
1.119 kristaps 1651: and
1.274 schwarze 1652: .Ic \&Ft .
1.287 schwarze 1653: .Tg Fo
1.274 schwarze 1654: .It Ic \&Fo Ar funcname
1.120 kristaps 1655: Begin a function block.
1656: This is a multi-line version of
1.274 schwarze 1657: .Ic \&Fn .
1.120 kristaps 1658: .Pp
1659: Invocations usually occur in the following context:
1660: .Bd -ragged -offset indent
1.274 schwarze 1661: .Pf \. Ic \&Ft Ar functype
1.120 kristaps 1662: .br
1.274 schwarze 1663: .Pf \. Ic \&Fo Ar funcname
1.120 kristaps 1664: .br
1.274 schwarze 1665: .Pf \. Ic \&Fa Qq Ar argtype Ar argname
1.120 kristaps 1666: .br
1.183 kristaps 1667: \&.\.\.
1.120 kristaps 1668: .br
1.274 schwarze 1669: .Pf \. Ic \&Fc
1.120 kristaps 1670: .Ed
1671: .Pp
1672: A
1.274 schwarze 1673: .Ic \&Fo
1.120 kristaps 1674: scope is closed by
1.274 schwarze 1675: .Ic \&Fc .
1.120 kristaps 1676: .Pp
1677: See also
1.122 kristaps 1678: .Sx MANUAL STRUCTURE ,
1.274 schwarze 1679: .Ic \&Fa ,
1680: .Ic \&Fc ,
1.120 kristaps 1681: and
1.274 schwarze 1682: .Ic \&Ft .
1683: .It Ic \&Fr Ar number
1.231 schwarze 1684: This macro is obsolete.
1685: No replacement markup is needed.
1.198 schwarze 1686: .Pp
1.231 schwarze 1687: It was used to show numerical function return values in an italic font.
1.287 schwarze 1688: .Tg Ft
1.274 schwarze 1689: .It Ic \&Ft Ar functype
1.120 kristaps 1690: A function type.
1691: .Pp
1.196 schwarze 1692: In the
1693: .Em SYNOPSIS
1694: section, a new output line is started after this macro.
1695: .Pp
1.120 kristaps 1696: Examples:
1.173 kristaps 1697: .Dl \&.Ft int
1.120 kristaps 1698: .Bd -literal -offset indent -compact
1699: \&.Ft functype
1700: \&.Fn funcname
1701: .Ed
1702: .Pp
1703: See also
1.122 kristaps 1704: .Sx MANUAL STRUCTURE ,
1.274 schwarze 1705: .Ic \&Fn ,
1.120 kristaps 1706: and
1.274 schwarze 1707: .Ic \&Fo .
1.287 schwarze 1708: .Tg Fx
1.274 schwarze 1709: .It Ic \&Fx Op Ar version
1.144 schwarze 1710: Format the
1711: .Fx
1712: version provided as an argument, or a default value
1.65 kristaps 1713: if no argument is provided.
1714: .Pp
1715: Examples:
1.173 kristaps 1716: .Dl \&.Fx 7.1
1717: .Dl \&.Fx
1.65 kristaps 1718: .Pp
1719: See also
1.274 schwarze 1720: .Ic \&At ,
1721: .Ic \&Bsx ,
1722: .Ic \&Bx ,
1723: .Ic \&Dx ,
1724: .Ic \&Nx ,
1.65 kristaps 1725: and
1.274 schwarze 1726: .Ic \&Ox .
1727: .It Ic \&Hf Ar filename
1.198 schwarze 1728: This macro is not implemented in
1729: .Xr mandoc 1 .
1730: It was used to include the contents of a (header) file literally.
1.287 schwarze 1731: .Tg Ic
1.274 schwarze 1732: .It Ic \&Ic Ar keyword ...
1.278 schwarze 1733: Internal or interactive command, or configuration instruction
1734: in a configuration file.
1735: See also
1736: .Ic \&Cm .
1.132 kristaps 1737: .Pp
1738: Examples:
1.196 schwarze 1739: .Dl \&.Ic :wq
1.173 kristaps 1740: .Dl \&.Ic hash
1741: .Dl \&.Ic alias
1.132 kristaps 1742: .Pp
1743: Note that using
1.274 schwarze 1744: .Ic \&Ql ,
1745: .Ic \&Dl ,
1.273 schwarze 1746: or
1.274 schwarze 1747: .Ic \&Bd Fl literal
1.273 schwarze 1748: is preferred for displaying code samples; the
1.274 schwarze 1749: .Ic \&Ic
1.273 schwarze 1750: macro is used when referring to an individual command name.
1.287 schwarze 1751: .Tg In
1.274 schwarze 1752: .It Ic \&In Ar filename
1.251 schwarze 1753: The name of an include file.
1754: This macro is most often used in section 2, 3, and 9 manual pages.
1755: .Pp
1.196 schwarze 1756: When invoked as the first macro on an input line in the
1.118 kristaps 1757: .Em SYNOPSIS
1.196 schwarze 1758: section, the argument is displayed in angle brackets
1759: and preceded by
1.251 schwarze 1760: .Qq #include ,
1.196 schwarze 1761: and a blank line is inserted in front if there is a preceding
1762: function declaration.
1.251 schwarze 1763: In other sections, it only encloses its argument in angle brackets
1764: and causes no line break.
1.118 kristaps 1765: .Pp
1.122 kristaps 1766: Examples:
1.196 schwarze 1767: .Dl \&.In sys/types.h
1.122 kristaps 1768: .Pp
1769: See also
1770: .Sx MANUAL STRUCTURE .
1.287 schwarze 1771: .Tg It
1.274 schwarze 1772: .It Ic \&It Op Ar head
1.120 kristaps 1773: A list item.
1774: The syntax of this macro depends on the list type.
1.114 kristaps 1775: .Pp
1776: Lists
1777: of type
1778: .Fl hang ,
1779: .Fl ohang ,
1780: .Fl inset ,
1781: and
1782: .Fl diag
1.120 kristaps 1783: have the following syntax:
1.114 kristaps 1784: .Pp
1.274 schwarze 1785: .D1 Pf \. Ic \&It Ar args
1.114 kristaps 1786: .Pp
1787: Lists of type
1788: .Fl bullet ,
1789: .Fl dash ,
1790: .Fl enum ,
1791: .Fl hyphen
1792: and
1793: .Fl item
1.120 kristaps 1794: have the following syntax:
1.114 kristaps 1795: .Pp
1.274 schwarze 1796: .D1 Pf \. Ic \&It
1.114 kristaps 1797: .Pp
1798: with subsequent lines interpreted within the scope of the
1.274 schwarze 1799: .Ic \&It
1.114 kristaps 1800: until either a closing
1.274 schwarze 1801: .Ic \&El
1.114 kristaps 1802: or another
1.274 schwarze 1803: .Ic \&It .
1.114 kristaps 1804: .Pp
1805: The
1806: .Fl tag
1.120 kristaps 1807: list has the following syntax:
1.114 kristaps 1808: .Pp
1.274 schwarze 1809: .D1 Pf \. Ic \&It Op Cm args
1.114 kristaps 1810: .Pp
1.120 kristaps 1811: Subsequent lines are interpreted as with
1.114 kristaps 1812: .Fl bullet
1813: and family.
1814: The line arguments correspond to the list's left-hand side; body
1815: arguments correspond to the list's contents.
1816: .Pp
1817: The
1818: .Fl column
1819: list is the most complicated.
1.120 kristaps 1820: Its syntax is as follows:
1.114 kristaps 1821: .Pp
1.274 schwarze 1822: .D1 Pf \. Ic \&It Ar cell Op Ic \&Ta Ar cell ...
1823: .D1 Pf \. Ic \&It Ar cell Op <TAB> Ar cell ...
1.114 kristaps 1824: .Pp
1.190 schwarze 1825: The arguments consist of one or more lines of text and macros
1826: representing a complete table line.
1.260 schwarze 1827: Cells within the line are delimited by the special
1.274 schwarze 1828: .Ic \&Ta
1.260 schwarze 1829: block macro or by literal tab characters.
1830: .Pp
1831: Using literal tabs is strongly discouraged because they are very
1832: hard to use correctly and
1833: .Nm
1834: code using them is very hard to read.
1835: In particular, a blank character is syntactically significant
1836: before and after the literal tab character.
1837: If a word precedes or follows the tab without an intervening blank,
1838: that word is never interpreted as a macro call, but always output
1839: literally.
1840: .Pp
1.190 schwarze 1841: The tab cell delimiter may only be used within the
1.274 schwarze 1842: .Ic \&It
1.190 schwarze 1843: line itself; on following lines, only the
1.274 schwarze 1844: .Ic \&Ta
1.267 schwarze 1845: macro can be used to delimit cells, and portability requires that
1.274 schwarze 1846: .Ic \&Ta
1.267 schwarze 1847: is called by other macros: some parsers do not recognize it when
1848: it appears as the first macro on a line.
1.190 schwarze 1849: .Pp
1850: Note that quoted strings may span tab-delimited cells on an
1.274 schwarze 1851: .Ic \&It
1.190 schwarze 1852: line.
1853: For example,
1.114 kristaps 1854: .Pp
1.260 schwarze 1855: .Dl .It \(dqcol1 ,\& <TAB> col2 ,\(dq \&;
1.114 kristaps 1856: .Pp
1.260 schwarze 1857: will preserve the whitespace before both commas,
1858: but not the whitespace before the semicolon.
1.114 kristaps 1859: .Pp
1860: See also
1.274 schwarze 1861: .Ic \&Bl .
1.287 schwarze 1862: .Tg Lb
1.298 schwarze 1863: .It Ic \&Lb Cm lib Ns Ar name Op Cm lib Ns Ar name ...
1864: Specify one or more libraries to link against.
1865: Putting this macro at the beginning of the
1866: .Em SYNOPSIS
1867: section is recommended, in which case it prints this comment:
1868: .D1 /* Fl l Ns Ar name Oo Fl l Ns Ar name ... Oc */
1.109 kristaps 1869: .Pp
1.298 schwarze 1870: If used outside the
1871: .Em SYNOPSIS ,
1872: this macro prints
1873: .D1 library Dq Cm lib Ns Ar name
1874: instead.
1875: For system libraries, some operating systems
1876: print a short library description.
1.109 kristaps 1877: .Pp
1.298 schwarze 1878: Example:
1879: .Bd -literal -offset indent -compact
1880: \&.Sh SYNOPSIS
1881: \&.Lb libtls libssl libcrypto
1882: \&.In tls.h
1883: \&.Ft int
1884: \&.Fn tls_init void
1885: .Ed
1.287 schwarze 1886: .Tg Li
1.274 schwarze 1887: .It Ic \&Li Ar word ...
1.297 schwarze 1888: Unquoted in-line literal display, always set in a constant-width font.
1889: In most cases, use
1890: .Ic \&Ql
1891: instead because on terminal output devices,
1892: .Ic \&Li
1893: is usually indistinguishable from normal text.
1894: This macro is only useful when enclosing the argument in quotes
1895: is explicitly not desired, for example because it already stands out
1896: due to being wrapped in another macro, e.g. in an
1897: .Ic \&It
1898: head.
1899: .Pp
1900: For longer literal displays, use
1901: .Ic \&Dl Pq single line
1.273 schwarze 1902: or
1.274 schwarze 1903: .Ic \&Bd Fl literal Pq multi-line
1.273 schwarze 1904: instead.
1.287 schwarze 1905: .Tg Lk
1.274 schwarze 1906: .It Ic \&Lk Ar uri Op Ar display_name
1.100 kristaps 1907: Format a hyperlink.
1.70 kristaps 1908: .Pp
1909: Examples:
1.282 schwarze 1910: .Dl \&.Lk https://bsd.lv \(dqThe BSD.lv Project\(dq
1911: .Dl \&.Lk https://bsd.lv
1.70 kristaps 1912: .Pp
1913: See also
1.274 schwarze 1914: .Ic \&Mt .
1915: .It Ic \&Lp
1.272 schwarze 1916: Deprecated synonym for
1.274 schwarze 1917: .Ic \&Pp .
1.287 schwarze 1918: .Tg Ms
1.274 schwarze 1919: .It Ic \&Ms Ar name
1.138 kristaps 1920: Display a mathematical symbol.
1921: .Pp
1922: Examples:
1.173 kristaps 1923: .Dl \&.Ms sigma
1924: .Dl \&.Ms aleph
1.287 schwarze 1925: .Tg Mt
1.274 schwarze 1926: .It Ic \&Mt Ar localpart Ns @ Ns Ar domain
1.116 kristaps 1927: Format a
1.138 kristaps 1928: .Dq mailto:
1.116 kristaps 1929: hyperlink.
1930: .Pp
1931: Examples:
1.173 kristaps 1932: .Dl \&.Mt discuss@manpages.bsd.lv
1.219 schwarze 1933: .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
1.287 schwarze 1934: .Tg Nd
1.274 schwarze 1935: .It Ic \&Nd Ar line
1.144 schwarze 1936: A one line description of the manual's content.
1.252 schwarze 1937: This is the mandatory last macro of the
1938: .Em NAME
1939: section and not appropriate for other sections.
1.132 kristaps 1940: .Pp
1941: Examples:
1.274 schwarze 1942: .Dl Pf . Ic \&Nd mdoc language reference
1943: .Dl Pf . Ic \&Nd format and display UNIX manuals
1.132 kristaps 1944: .Pp
1945: The
1.274 schwarze 1946: .Ic \&Nd
1.132 kristaps 1947: macro technically accepts child macros and terminates with a subsequent
1.274 schwarze 1948: .Ic \&Sh
1.132 kristaps 1949: invocation.
1950: Do not assume this behaviour: some
1951: .Xr whatis 1
1952: database generators are not smart enough to parse more than the line
1953: arguments and will display macros verbatim.
1954: .Pp
1955: See also
1.274 schwarze 1956: .Ic \&Nm .
1.287 schwarze 1957: .Tg Nm
1.274 schwarze 1958: .It Ic \&Nm Op Ar name
1.128 schwarze 1959: The name of the manual page, or \(em in particular in section 1, 6,
1960: and 8 pages \(em of an additional command or feature documented in
1961: the manual page.
1962: When first invoked, the
1.274 schwarze 1963: .Ic \&Nm
1.128 schwarze 1964: macro expects a single argument, the name of the manual page.
1965: Usually, the first invocation happens in the
1966: .Em NAME
1967: section of the page.
1968: The specified name will be remembered and used whenever the macro is
1969: called again without arguments later in the page.
1970: The
1.274 schwarze 1971: .Ic \&Nm
1.128 schwarze 1972: macro uses
1973: .Sx Block full-implicit
1974: semantics when invoked as the first macro on an input line in the
1975: .Em SYNOPSIS
1976: section; otherwise, it uses ordinary
1977: .Sx In-line
1978: semantics.
1979: .Pp
1980: Examples:
1981: .Bd -literal -offset indent
1982: \&.Sh SYNOPSIS
1983: \&.Nm cat
1984: \&.Op Fl benstuv
1985: \&.Op Ar
1986: .Ed
1987: .Pp
1988: In the
1989: .Em SYNOPSIS
1990: of section 2, 3 and 9 manual pages, use the
1.274 schwarze 1991: .Ic \&Fn
1.128 schwarze 1992: macro rather than
1.274 schwarze 1993: .Ic \&Nm
1.128 schwarze 1994: to mark up the name of the manual page.
1.287 schwarze 1995: .Tg No
1.274 schwarze 1996: .It Ic \&No Ar word ...
1.198 schwarze 1997: Normal text.
1998: Closes the scope of any preceding in-line macro.
1999: When used after physical formatting macros like
1.274 schwarze 2000: .Ic \&Em
1.198 schwarze 2001: or
1.274 schwarze 2002: .Ic \&Sy ,
1.198 schwarze 2003: switches back to the standard font face and weight.
2004: Can also be used to embed plain text strings in macro lines
2005: using semantic annotation macros.
1.132 kristaps 2006: .Pp
2007: Examples:
1.198 schwarze 2008: .Dl ".Em italic , Sy bold , No and roman"
1.276 schwarze 2009: .Bd -literal -offset indent
1.198 schwarze 2010: \&.Sm off
2011: \&.Cm :C No / Ar pattern No / Ar replacement No /
2012: \&.Sm on
2013: .Ed
2014: .Pp
2015: See also
1.274 schwarze 2016: .Ic \&Em ,
2017: .Ic \&Ql ,
1.198 schwarze 2018: and
1.274 schwarze 2019: .Ic \&Sy .
1.287 schwarze 2020: .Tg Ns
1.274 schwarze 2021: .It Ic \&Ns
1.198 schwarze 2022: Suppress a space between the output of the preceding macro
2023: and the following text or macro.
2024: Following invocation, input is interpreted as normal text
2025: just like after an
1.274 schwarze 2026: .Ic \&No
1.198 schwarze 2027: macro.
1.178 kristaps 2028: .Pp
2029: This has no effect when invoked at the start of a macro line.
1.138 kristaps 2030: .Pp
2031: Examples:
1.198 schwarze 2032: .Dl ".Ar name Ns = Ns Ar value"
2033: .Dl ".Cm :M Ns Ar pattern"
2034: .Dl ".Fl o Ns Ar output"
1.138 kristaps 2035: .Pp
2036: See also
1.274 schwarze 2037: .Ic \&No
1.138 kristaps 2038: and
1.274 schwarze 2039: .Ic \&Sm .
1.287 schwarze 2040: .Tg Nx
1.274 schwarze 2041: .It Ic \&Nx Op Ar version
1.144 schwarze 2042: Format the
2043: .Nx
2044: version provided as an argument, or a default value if
1.65 kristaps 2045: no argument is provided.
2046: .Pp
2047: Examples:
1.173 kristaps 2048: .Dl \&.Nx 5.01
2049: .Dl \&.Nx
1.65 kristaps 2050: .Pp
2051: See also
1.274 schwarze 2052: .Ic \&At ,
2053: .Ic \&Bsx ,
2054: .Ic \&Bx ,
2055: .Ic \&Dx ,
2056: .Ic \&Fx ,
1.65 kristaps 2057: and
1.274 schwarze 2058: .Ic \&Ox .
2059: .It Ic \&Oc
1.141 kristaps 2060: Close multi-line
1.274 schwarze 2061: .Ic \&Oo
1.132 kristaps 2062: context.
1.274 schwarze 2063: .It Ic \&Oo Ar block
1.132 kristaps 2064: Multi-line version of
1.274 schwarze 2065: .Ic \&Op .
1.132 kristaps 2066: .Pp
2067: Examples:
1.138 kristaps 2068: .Bd -literal -offset indent -compact
1.132 kristaps 2069: \&.Oo
2070: \&.Op Fl flag Ns Ar value
2071: \&.Oc
2072: .Ed
1.287 schwarze 2073: .Tg Op
1.274 schwarze 2074: .It Ic \&Op Ar line
1.196 schwarze 2075: Optional part of a command line.
1.132 kristaps 2076: Prints the argument(s) in brackets.
1.196 schwarze 2077: This is most often used in the
2078: .Em SYNOPSIS
2079: section of section 1 and 8 manual pages.
1.132 kristaps 2080: .Pp
2081: Examples:
1.173 kristaps 2082: .Dl \&.Op \&Fl a \&Ar b
2083: .Dl \&.Op \&Ar a | b
1.132 kristaps 2084: .Pp
2085: See also
1.274 schwarze 2086: .Ic \&Oo .
1.287 schwarze 2087: .Tg Os
1.290 schwarze 2088: .It Ic \&Os Op Ar footer text
2089: The mandatory third macro of every
1.66 kristaps 2090: .Nm
1.120 kristaps 2091: file.
1.290 schwarze 2092: Usually, do not specify any arguments,
2093: in particular not the operating system name and/or version.
1.66 kristaps 2094: .Pp
1.290 schwarze 2095: If no argument is given,
1.246 schwarze 2096: .Xr mandoc 1
1.290 schwarze 2097: prints its
1.246 schwarze 2098: .Fl Ios
1.290 schwarze 2099: argument in the page footer, or
1.246 schwarze 2100: .Fa sysname
2101: and
2102: .Fa release
2103: as returned by
1.290 schwarze 2104: .Xr uname 3
2105: by default.
1.66 kristaps 2106: .Pp
1.290 schwarze 2107: Manual pages that are part of a portable software project can override
2108: the default by giving the project name and version number as arguments,
2109: but leaving it blank is never a bad choice.
1.66 kristaps 2110: .Pp
2111: See also
1.274 schwarze 2112: .Ic \&Dd
1.66 kristaps 2113: and
1.274 schwarze 2114: .Ic \&Dt .
2115: .It Ic \&Ot Ar functype
1.231 schwarze 2116: This macro is obsolete.
2117: Use
1.274 schwarze 2118: .Ic \&Ft
1.231 schwarze 2119: instead; with
2120: .Xr mandoc 1 ,
2121: both have the same effect.
1.66 kristaps 2122: .Pp
1.198 schwarze 2123: Historical
1.217 schwarze 2124: .Nm
1.198 schwarze 2125: packages described it as
2126: .Dq "old function type (FORTRAN)" .
1.287 schwarze 2127: .Tg Ox
1.274 schwarze 2128: .It Ic \&Ox Op Ar version
1.144 schwarze 2129: Format the
2130: .Ox
2131: version provided as an argument, or a default value
1.65 kristaps 2132: if no argument is provided.
2133: .Pp
2134: Examples:
1.173 kristaps 2135: .Dl \&.Ox 4.5
2136: .Dl \&.Ox
1.65 kristaps 2137: .Pp
2138: See also
1.274 schwarze 2139: .Ic \&At ,
2140: .Ic \&Bsx ,
2141: .Ic \&Bx ,
2142: .Ic \&Dx ,
2143: .Ic \&Fx ,
1.65 kristaps 2144: and
1.274 schwarze 2145: .Ic \&Nx .
1.287 schwarze 2146: .Tg Pa
1.274 schwarze 2147: .It Ic \&Pa Ar name ...
1.196 schwarze 2148: An absolute or relative file system path, or a file or directory name.
2149: If an argument is not provided, the character
2150: .Sq \(ti
1.165 kristaps 2151: is used as a default.
1.132 kristaps 2152: .Pp
2153: Examples:
1.173 kristaps 2154: .Dl \&.Pa /usr/bin/mandoc
2155: .Dl \&.Pa /usr/share/man/man7/mdoc.7
1.132 kristaps 2156: .Pp
2157: See also
1.274 schwarze 2158: .Ic \&Lk .
2159: .It Ic \&Pc
1.132 kristaps 2160: Close parenthesised context opened by
1.274 schwarze 2161: .Ic \&Po .
1.287 schwarze 2162: .Tg Pf
1.274 schwarze 2163: .It Ic \&Pf Ar prefix macro Op Ar argument ...
1.256 schwarze 2164: Removes the space between its argument and the following macro.
1.274 schwarze 2165: It is equivalent to:
1.132 kristaps 2166: .Pp
1.274 schwarze 2167: .D1 Ic \&No Pf \e& Ar prefix Ic \&Ns Ar macro Op Ar argument ...
1.256 schwarze 2168: .Pp
2169: The
2170: .Ar prefix
2171: argument is not parsed for macro names or delimiters,
2172: but used verbatim as if it were escaped.
1.132 kristaps 2173: .Pp
2174: Examples:
1.198 schwarze 2175: .Dl ".Pf $ Ar variable_name"
1.256 schwarze 2176: .Dl ".Pf . Ar macro_name"
1.198 schwarze 2177: .Dl ".Pf 0x Ar hex_digits"
2178: .Pp
2179: See also
1.274 schwarze 2180: .Ic \&Ns
1.198 schwarze 2181: and
1.274 schwarze 2182: .Ic \&Sm .
2183: .It Ic \&Po Ar block
1.132 kristaps 2184: Multi-line version of
1.274 schwarze 2185: .Ic \&Pq .
1.287 schwarze 2186: .Tg Pp
1.274 schwarze 2187: .It Ic \&Pp
1.132 kristaps 2188: Break a paragraph.
2189: This will assert vertical space between prior and subsequent macros
2190: and/or text.
1.198 schwarze 2191: .Pp
2192: Paragraph breaks are not needed before or after
1.274 schwarze 2193: .Ic \&Sh
1.198 schwarze 2194: or
1.274 schwarze 2195: .Ic \&Ss
1.198 schwarze 2196: macros or before displays
1.274 schwarze 2197: .Pq Ic \&Bd Ar line
1.198 schwarze 2198: or lists
1.274 schwarze 2199: .Pq Ic \&Bl
1.198 schwarze 2200: unless the
2201: .Fl compact
2202: flag is given.
1.287 schwarze 2203: .Tg Pq
1.274 schwarze 2204: .It Ic \&Pq Ar line
1.132 kristaps 2205: Parenthesised enclosure.
2206: .Pp
2207: See also
1.274 schwarze 2208: .Ic \&Po .
2209: .It Ic \&Qc
1.138 kristaps 2210: Close quoted context opened by
1.274 schwarze 2211: .Ic \&Qo .
1.287 schwarze 2212: .Tg Ql
1.274 schwarze 2213: .It Ic \&Ql Ar line
1.297 schwarze 2214: Normal in-line literal display, always set in constant-width font and
2215: additionally enclosed in quotes by many formatters in many cases.
1.273 schwarze 2216: This can be used for complete command invocations and for multi-word
2217: code examples when an indented display is not desired.
1.248 schwarze 2218: .Pp
1.138 kristaps 2219: See also
1.297 schwarze 2220: .Ic \&Dl ,
2221: .Ic \&Bd
2222: .Fl literal ,
1.138 kristaps 2223: and
1.297 schwarze 2224: .Ic \&Li .
1.274 schwarze 2225: .It Ic \&Qo Ar block
1.138 kristaps 2226: Multi-line version of
1.274 schwarze 2227: .Ic \&Qq .
1.287 schwarze 2228: .Tg Qq
1.274 schwarze 2229: .It Ic \&Qq Ar line
1.138 kristaps 2230: Encloses its arguments in
1.198 schwarze 2231: .Qq typewriter
1.138 kristaps 2232: double-quotes.
2233: Consider using
1.274 schwarze 2234: .Ic \&Dq .
1.138 kristaps 2235: .Pp
2236: See also
1.274 schwarze 2237: .Ic \&Dq ,
2238: .Ic \&Sq ,
1.138 kristaps 2239: and
1.274 schwarze 2240: .Ic \&Qo .
2241: .It Ic \&Re
1.141 kristaps 2242: Close an
1.274 schwarze 2243: .Ic \&Rs
1.100 kristaps 2244: block.
2245: Does not have any tail arguments.
1.287 schwarze 2246: .Tg Rs
1.274 schwarze 2247: .It Ic \&Rs
1.141 kristaps 2248: Begin a bibliographic
1.63 kristaps 2249: .Pq Dq reference
1.100 kristaps 2250: block.
2251: Does not have any head arguments.
2252: The block macro may only contain
1.274 schwarze 2253: .Ic \&%A ,
2254: .Ic \&%B ,
2255: .Ic \&%C ,
2256: .Ic \&%D ,
2257: .Ic \&%I ,
2258: .Ic \&%J ,
2259: .Ic \&%N ,
2260: .Ic \&%O ,
2261: .Ic \&%P ,
2262: .Ic \&%Q ,
2263: .Ic \&%R ,
2264: .Ic \&%T ,
2265: .Ic \&%U ,
1.63 kristaps 2266: and
1.274 schwarze 2267: .Ic \&%V
1.63 kristaps 2268: child macros (at least one must be specified).
2269: .Pp
1.64 kristaps 2270: Examples:
1.91 kristaps 2271: .Bd -literal -offset indent -compact
1.63 kristaps 2272: \&.Rs
2273: \&.%A J. E. Hopcroft
2274: \&.%A J. D. Ullman
2275: \&.%B Introduction to Automata Theory, Languages, and Computation
2276: \&.%I Addison-Wesley
1.255 schwarze 2277: \&.%C Reading, Massachusetts
1.63 kristaps 2278: \&.%D 1979
2279: \&.Re
2280: .Ed
2281: .Pp
2282: If an
1.274 schwarze 2283: .Ic \&Rs
1.63 kristaps 2284: block is used within a SEE ALSO section, a vertical space is asserted
2285: before the rendered output, else the block continues on the current
2286: line.
1.287 schwarze 2287: .Tg Rv
1.274 schwarze 2288: .It Ic \&Rv Fl std Op Ar function ...
1.193 schwarze 2289: Insert a standard sentence regarding a function call's return value of 0
1.191 kristaps 2290: on success and \-1 on error, with the
2291: .Va errno
2292: libc global variable set on error.
2293: .Pp
1.139 kristaps 2294: If
2295: .Ar function
1.191 kristaps 2296: is not specified, the document's name set by
1.274 schwarze 2297: .Ic \&Nm
1.191 kristaps 2298: is used.
2299: Multiple
2300: .Ar function
2301: arguments are treated as separate functions.
1.139 kristaps 2302: .Pp
2303: See also
1.274 schwarze 2304: .Ic \&Ex .
2305: .It Ic \&Sc
1.138 kristaps 2306: Close single-quoted context opened by
1.274 schwarze 2307: .Ic \&So .
1.287 schwarze 2308: .Tg Sh
1.274 schwarze 2309: .It Ic \&Sh Ar TITLE LINE
1.138 kristaps 2310: Begin a new section.
2311: For a list of conventional manual sections, see
2312: .Sx MANUAL STRUCTURE .
1.296 schwarze 2313: Use the conventional sections where applicable.
2314: For unusually long and complicated manual pages,
2315: adding custom sections is occasionally useful.
2316: .Pp
2317: Avoid using macros inside the
2318: .Ar TITLE LINE
2319: and keep that line unique within the manual page,
2320: such that it can be pointed to with
1.274 schwarze 2321: .Ic \&Sx .
1.138 kristaps 2322: .Pp
2323: See also
1.274 schwarze 2324: .Ic \&Pp ,
2325: .Ic \&Ss ,
1.138 kristaps 2326: and
1.274 schwarze 2327: .Ic \&Sx .
1.287 schwarze 2328: .Tg Sm
1.274 schwarze 2329: .It Ic \&Sm Op Cm on | off
1.134 schwarze 2330: Switches the spacing mode for output generated from macros.
2331: .Pp
2332: By default, spacing is
1.193 schwarze 2333: .Cm on .
1.134 schwarze 2334: When switched
1.193 schwarze 2335: .Cm off ,
1.134 schwarze 2336: no white space is inserted between macro arguments and between the
1.185 kristaps 2337: output generated from adjacent macros, but text lines
1.134 schwarze 2338: still get normal spacing between words and sentences.
1.234 schwarze 2339: .Pp
2340: When called without an argument, the
1.274 schwarze 2341: .Ic \&Sm
1.234 schwarze 2342: macro toggles the spacing mode.
2343: Using this is not recommended because it makes the code harder to read.
1.274 schwarze 2344: .It Ic \&So Ar block
1.138 kristaps 2345: Multi-line version of
1.274 schwarze 2346: .Ic \&Sq .
1.287 schwarze 2347: .Tg Sq
1.274 schwarze 2348: .It Ic \&Sq Ar line
1.138 kristaps 2349: Encloses its arguments in
1.198 schwarze 2350: .Sq typewriter
1.138 kristaps 2351: single-quotes.
2352: .Pp
2353: See also
1.274 schwarze 2354: .Ic \&Dq ,
2355: .Ic \&Qq ,
1.138 kristaps 2356: and
1.274 schwarze 2357: .Ic \&So .
1.287 schwarze 2358: .Tg Ss
1.274 schwarze 2359: .It Ic \&Ss Ar Title line
1.198 schwarze 2360: Begin a new subsection.
1.138 kristaps 2361: Unlike with
1.274 schwarze 2362: .Ic \&Sh ,
1.198 schwarze 2363: there is no convention for the naming of subsections.
2364: Except
2365: .Em DESCRIPTION ,
2366: the conventional sections described in
2367: .Sx MANUAL STRUCTURE
2368: rarely have subsections.
1.138 kristaps 2369: .Pp
1.296 schwarze 2370: Avoid using macros inside the
2371: .Ar Title line
2372: and keep that line unique within the manual page,
2373: such that it can be pointed to with
1.274 schwarze 2374: .Ic \&Sx .
1.138 kristaps 2375: .Pp
2376: See also
1.274 schwarze 2377: .Ic \&Pp ,
2378: .Ic \&Sh ,
1.138 kristaps 2379: and
1.274 schwarze 2380: .Ic \&Sx .
1.287 schwarze 2381: .Tg St
1.274 schwarze 2382: .It Ic \&St Fl Ns Ar abbreviation
1.139 kristaps 2383: Replace an abbreviation for a standard with the full form.
1.226 schwarze 2384: The following standards are recognised.
2385: Where multiple lines are given without a blank line in between,
2386: they all refer to the same standard, and using the first form
2387: is recommended.
2388: .Bl -tag -width 1n
2389: .It C language standards
1.139 kristaps 2390: .Pp
1.226 schwarze 2391: .Bl -tag -width "-p1003.1g-2000" -compact
2392: .It \-ansiC
2393: .St -ansiC
2394: .It \-ansiC-89
2395: .St -ansiC-89
1.139 kristaps 2396: .It \-isoC
2397: .St -isoC
2398: .It \-isoC-90
2399: .St -isoC-90
1.226 schwarze 2400: .br
2401: The original C standard.
2402: .Pp
1.139 kristaps 2403: .It \-isoC-amd1
2404: .St -isoC-amd1
1.226 schwarze 2405: .Pp
1.139 kristaps 2406: .It \-isoC-tcor1
2407: .St -isoC-tcor1
1.226 schwarze 2408: .Pp
1.211 schwarze 2409: .It \-isoC-tcor2
2410: .St -isoC-tcor2
1.226 schwarze 2411: .Pp
1.211 schwarze 2412: .It \-isoC-99
2413: .St -isoC-99
1.226 schwarze 2414: .br
1.295 schwarze 2415: Edition 2 of the C language standard.
1.226 schwarze 2416: .Pp
1.214 kristaps 2417: .It \-isoC-2011
2418: .St -isoC-2011
1.226 schwarze 2419: .br
1.295 schwarze 2420: Edition 3 of the C language standard.
2421: .Pp
2422: .It \-isoC-2023
2423: .St -isoC-2023
2424: .br
2425: Edition 5 of the C language standard.
1.226 schwarze 2426: .El
1.293 schwarze 2427: .It POSIX.1 before XPG4.2
1.226 schwarze 2428: .Pp
2429: .Bl -tag -width "-p1003.1g-2000" -compact
2430: .It \-p1003.1-88
2431: .St -p1003.1-88
2432: .It \-p1003.1
2433: .St -p1003.1
2434: .br
2435: The original POSIX standard, based on ANSI C.
2436: .Pp
2437: .It \-p1003.1-90
2438: .St -p1003.1-90
1.211 schwarze 2439: .It \-iso9945-1-90
2440: .St -iso9945-1-90
1.226 schwarze 2441: .br
2442: The first update of POSIX.1.
2443: .Pp
2444: .It \-p1003.1b-93
2445: .St -p1003.1b-93
2446: .It \-p1003.1b
2447: .St -p1003.1b
2448: .br
2449: Real-time extensions.
2450: .Pp
2451: .It \-p1003.1c-95
2452: .St -p1003.1c-95
2453: .br
2454: POSIX thread interfaces.
2455: .Pp
2456: .It \-p1003.1i-95
2457: .St -p1003.1i-95
2458: .br
2459: Technical Corrigendum.
2460: .Pp
2461: .It \-p1003.1-96
2462: .St -p1003.1-96
1.211 schwarze 2463: .It \-iso9945-1-96
2464: .St -iso9945-1-96
1.226 schwarze 2465: .br
2466: Includes POSIX.1-1990, 1b, 1c, and 1i.
2467: .El
1.293 schwarze 2468: .It X/Open Portability Guide before XPG4.2
1.226 schwarze 2469: .Pp
2470: .Bl -tag -width "-p1003.1g-2000" -compact
2471: .It \-xpg3
2472: .St -xpg3
2473: .br
2474: An XPG4 precursor, published in 1989.
2475: .Pp
2476: .It \-p1003.2
2477: .St -p1003.2
2478: .It \-p1003.2-92
2479: .St -p1003.2-92
1.211 schwarze 2480: .It \-iso9945-2-93
2481: .St -iso9945-2-93
1.226 schwarze 2482: .br
2483: An XCU4 precursor.
2484: .Pp
2485: .It \-p1003.2a-92
2486: .St -p1003.2a-92
2487: .br
2488: Updates to POSIX.2.
2489: .Pp
1.211 schwarze 2490: .It \-xpg4
2491: .St -xpg4
1.226 schwarze 2492: .br
2493: Based on POSIX.1 and POSIX.2, published in 1992.
2494: .El
1.293 schwarze 2495: .It X/Open Portability Guide Issue 4 Version 2 and related standards
1.226 schwarze 2496: .Pp
2497: .Bl -tag -width "-p1003.1g-2000" -compact
1.236 schwarze 2498: .It \-susv1
2499: .St -susv1
1.211 schwarze 2500: .It \-xpg4.2
2501: .St -xpg4.2
1.226 schwarze 2502: .br
1.236 schwarze 2503: This standard was published in 1994.
1.226 schwarze 2504: It was used as the basis for UNIX 95 certification.
1.289 schwarze 2505: The following two refer to parts of it.
1.226 schwarze 2506: .Pp
2507: .It \-xcurses4.2
2508: .St -xcurses4.2
2509: .Pp
2510: .It \-p1003.1g-2000
2511: .St -p1003.1g-2000
2512: .br
2513: Networking APIs, including sockets.
2514: .Pp
2515: .It \-svid4
2516: .St -svid4 ,
2517: .br
2518: Published in 1995.
2519: .El
1.293 schwarze 2520: .It X/Open Portability Guide Issue 5 and related standards
1.226 schwarze 2521: .Pp
2522: .Bl -tag -width "-p1003.1g-2000" -compact
2523: .It \-susv2
2524: .St -susv2
1.293 schwarze 2525: .br
1.226 schwarze 2526: This Standard was published in 1997
1.293 schwarze 2527: and is also called X/Open Portability Guide Issue 5.
1.226 schwarze 2528: It was used as the basis for UNIX 98 certification.
2529: The following refer to parts of it.
2530: .Pp
1.211 schwarze 2531: .It \-xbd5
2532: .St -xbd5
1.226 schwarze 2533: .Pp
2534: .It \-xsh5
2535: .St -xsh5
2536: .Pp
1.211 schwarze 2537: .It \-xcu5
2538: .St -xcu5
1.226 schwarze 2539: .Pp
1.211 schwarze 2540: .It \-xns5
2541: .St -xns5
2542: .It \-xns5.2
2543: .St -xns5.2
1.226 schwarze 2544: .El
1.293 schwarze 2545: .It POSIX Issue 6
1.226 schwarze 2546: .Pp
1.245 schwarze 2547: .Bl -tag -width "-p1003.1-2001" -compact
1.226 schwarze 2548: .It \-p1003.1-2001
2549: .St -p1003.1-2001
1.211 schwarze 2550: .It \-susv3
2551: .St -susv3
1.226 schwarze 2552: .br
2553: This standard is based on C99, SUSv2, POSIX.1-1996, 1d, and 1j.
1.293 schwarze 2554: It is also called X/Open Portability Guide Issue 6.
1.226 schwarze 2555: It is used as the basis for UNIX 03 certification.
2556: .Pp
2557: .It \-p1003.1-2004
2558: .St -p1003.1-2004
2559: .br
2560: The second and last Technical Corrigendum.
2561: .El
1.293 schwarze 2562: .It POSIX Issues 7 and 8
1.226 schwarze 2563: .Pp
2564: .Bl -tag -width "-p1003.1g-2000" -compact
2565: .It \-p1003.1-2008
2566: .St -p1003.1-2008
1.236 schwarze 2567: .It \-susv4
2568: .St -susv4
1.226 schwarze 2569: .br
1.292 schwarze 2570: This standard is based on C99.
2571: It is also called the
2572: Open Group Standard Base Specifications, Issue 7.
2573: .El
2574: .Pp
2575: .Bl -tag -width "-p1003.1g-2000" -compact
2576: .It \-p1003.1-2024
2577: .St -p1003.1-2024
2578: .br
2579: This standard is based on C17.
2580: It is also called the
2581: Open Group Standard Base Specifications, Issue 8.
1.226 schwarze 2582: .El
2583: .It Other standards
2584: .Pp
2585: .Bl -tag -width "-p1003.1g-2000" -compact
2586: .It \-ieee754
2587: .St -ieee754
2588: .br
2589: Floating-point arithmetic.
2590: .Pp
2591: .It \-iso8601
2592: .St -iso8601
2593: .br
2594: Representation of dates and times, published in 1988.
2595: .Pp
2596: .It \-iso8802-3
2597: .St -iso8802-3
2598: .br
2599: Ethernet local area networks.
2600: .Pp
2601: .It \-ieee1275-94
2602: .St -ieee1275-94
2603: .El
1.211 schwarze 2604: .El
1.287 schwarze 2605: .Tg Sx
1.274 schwarze 2606: .It Ic \&Sx Ar Title line
1.211 schwarze 2607: Reference a section or subsection in the same manual page.
2608: The referenced section or subsection name must be identical to the
2609: enclosed argument, including whitespace.
2610: .Pp
2611: Examples:
2612: .Dl \&.Sx MANUAL STRUCTURE
2613: .Pp
2614: See also
1.274 schwarze 2615: .Ic \&Sh
1.211 schwarze 2616: and
1.274 schwarze 2617: .Ic \&Ss .
1.287 schwarze 2618: .Tg Sy
1.274 schwarze 2619: .It Ic \&Sy Ar word ...
1.235 schwarze 2620: Request a boldface font.
2621: .Pp
2622: This is most often used to indicate importance or seriousness (not to be
2623: confused with stress emphasis, see
1.274 schwarze 2624: .Ic \&Em ) .
1.235 schwarze 2625: When none of the semantic macros fit, it is also adequate for syntax
2626: elements that have to be given or that appear verbatim.
2627: .Pp
2628: Examples:
2629: .Bd -literal -compact -offset indent
2630: \&.Sy Warning :
2631: If
2632: \&.Sy s
2633: appears in the owner permissions, set-user-ID mode is set.
2634: This utility replaces the former
2635: \&.Sy dumpdir
2636: program.
2637: .Ed
1.211 schwarze 2638: .Pp
2639: See also
1.274 schwarze 2640: .Ic \&Em ,
2641: .Ic \&No ,
1.211 schwarze 2642: and
1.274 schwarze 2643: .Ic \&Ql .
1.287 schwarze 2644: .Tg Ta
1.274 schwarze 2645: .It Ic \&Ta
1.211 schwarze 2646: Table cell separator in
1.274 schwarze 2647: .Ic \&Bl Fl column
1.211 schwarze 2648: lists; can only be used below
1.274 schwarze 2649: .Ic \&It .
1.287 schwarze 2650: .Tg Tg
1.280 schwarze 2651: .It Ic \&Tg Op Ar term
2652: Announce that the next input line starts a definition of the
2653: .Ar term .
2654: This macro must appear alone on its own input line.
2655: The argument defaults to the first argument of the first macro
2656: on the next line.
2657: The argument may not contain whitespace characters, not even when it is quoted.
2658: This macro is a
2659: .Xr mandoc 1
2660: extension and is typically ignored by other formatters.
2661: .Pp
2662: When viewing terminal output with
2663: .Xr less 1 ,
2664: the interactive
2665: .Ic :t
2666: command can be used to go to the definition of the
2667: .Ar term
2668: as described for the
2669: .Ev MANPAGER
2670: variable in
2671: .Xr man 1 ;
2672: when producing HTML output, a fragment identifier
2673: .Pq Ic id No attribute
2674: is generated, to be used for deep linking to this place of the document.
2675: .Pp
2676: In most cases, adding a
2677: .Ic \&Tg
2678: macro would be redundant because
2679: .Xr mandoc 1
2680: is able to automatically tag most definitions.
2681: This macro is intended for cases where automatic tagging of a
2682: .Ar term
2683: is unsatisfactory, for example if a definition is not tagged
2684: automatically (false negative) or if places are tagged that do
2685: not define the
2686: .Ar term
2687: (false positives).
2688: When there is at least one
2689: .Ic \&Tg
2690: macro for a
2691: .Ar term ,
2692: no other places are automatically marked as definitions of that
2693: .Ar term .
1.274 schwarze 2694: .It Ic \&Tn Ar word ...
1.230 schwarze 2695: Supported only for compatibility, do not use this in new manuals.
2696: Even though the macro name
2697: .Pq Dq tradename
2698: suggests a semantic function, historic usage is inconsistent, mostly
2699: using it as a presentation-level macro to request a small caps font.
1.274 schwarze 2700: .It Ic \&Ud
1.230 schwarze 2701: Supported only for compatibility, do not use this in new manuals.
1.211 schwarze 2702: Prints out
2703: .Dq currently under development.
1.274 schwarze 2704: .It Ic \&Ux
1.230 schwarze 2705: Supported only for compatibility, do not use this in new manuals.
2706: Prints out
2707: .Dq Ux .
1.287 schwarze 2708: .Tg Va
1.274 schwarze 2709: .It Ic \&Va Oo Ar type Oc Ar identifier ...
1.211 schwarze 2710: A variable name.
2711: .Pp
2712: Examples:
2713: .Dl \&.Va foo
2714: .Dl \&.Va const char *bar ;
1.239 schwarze 2715: .Pp
2716: For function arguments and parameters, use
1.274 schwarze 2717: .Ic \&Fa
1.239 schwarze 2718: instead.
2719: For declarations of global variables in the
2720: .Em SYNOPSIS
2721: section, use
1.274 schwarze 2722: .Ic \&Vt .
1.287 schwarze 2723: .Tg Vt
1.274 schwarze 2724: .It Ic \&Vt Ar type Op Ar identifier
1.211 schwarze 2725: A variable type.
1.239 schwarze 2726: .Pp
1.211 schwarze 2727: This is also used for indicating global variables in the
2728: .Em SYNOPSIS
2729: section, in which case a variable name is also specified.
2730: Note that it accepts
2731: .Sx Block partial-implicit
2732: syntax when invoked as the first macro on an input line in the
2733: .Em SYNOPSIS
2734: section, else it accepts ordinary
2735: .Sx In-line
2736: syntax.
2737: In the former case, this macro starts a new output line,
2738: and a blank line is inserted in front if there is a preceding
2739: function definition or include directive.
2740: .Pp
2741: Examples:
2742: .Dl \&.Vt unsigned char
2743: .Dl \&.Vt extern const char * const sys_signame[] \&;
2744: .Pp
1.239 schwarze 2745: For parameters in function prototypes, use
1.274 schwarze 2746: .Ic \&Fa
1.239 schwarze 2747: instead, for function return types
1.274 schwarze 2748: .Ic \&Ft ,
1.239 schwarze 2749: and for variable names outside the
2750: .Em SYNOPSIS
2751: section
1.274 schwarze 2752: .Ic \&Va ,
1.239 schwarze 2753: even when including a type with the name.
1.211 schwarze 2754: See also
1.239 schwarze 2755: .Sx MANUAL STRUCTURE .
1.274 schwarze 2756: .It Ic \&Xc
1.211 schwarze 2757: Close a scope opened by
1.274 schwarze 2758: .Ic \&Xo .
2759: .It Ic \&Xo Ar block
1.211 schwarze 2760: Extend the header of an
1.274 schwarze 2761: .Ic \&It
1.211 schwarze 2762: macro or the body of a partial-implicit block macro
2763: beyond the end of the input line.
2764: This macro originally existed to work around the 9-argument limit
2765: of historic
2766: .Xr roff 7 .
1.287 schwarze 2767: .Tg Xr
1.274 schwarze 2768: .It Ic \&Xr Ar name section
1.211 schwarze 2769: Link to another manual
2770: .Pq Qq cross-reference .
2771: .Pp
1.216 schwarze 2772: Cross reference the
1.211 schwarze 2773: .Ar name
2774: and
2775: .Ar section
1.259 schwarze 2776: number of another man page.
1.211 schwarze 2777: .Pp
2778: Examples:
2779: .Dl \&.Xr mandoc 1
2780: .Dl \&.Xr mandoc 1 \&;
2781: .Dl \&.Xr mandoc 1 \&Ns s behaviour
1.274 schwarze 2782: .El
1.211 schwarze 2783: .Sh MACRO SYNTAX
2784: The syntax of a macro depends on its classification.
2785: In this section,
2786: .Sq \-arg
2787: refers to macro arguments, which may be followed by zero or more
2788: .Sq parm
2789: parameters;
2790: .Sq \&Yo
2791: opens the scope of a macro; and if specified,
2792: .Sq \&Yc
2793: closes it out.
2794: .Pp
2795: The
2796: .Em Callable
2797: column indicates that the macro may also be called by passing its name
2798: as an argument to another macro.
2799: For example,
2800: .Sq \&.Op \&Fl O \&Ar file
2801: produces
2802: .Sq Op Fl O Ar file .
2803: To prevent a macro call and render the macro name literally,
2804: escape it by prepending a zero-width space,
2805: .Sq \e& .
2806: For example,
2807: .Sq \&Op \e&Fl O
2808: produces
2809: .Sq Op \&Fl O .
2810: If a macro is not callable but its name appears as an argument
2811: to another macro, it is interpreted as opaque text.
2812: For example,
2813: .Sq \&.Fl \&Sh
2814: produces
2815: .Sq Fl \&Sh .
2816: .Pp
2817: The
2818: .Em Parsed
2819: column indicates whether the macro may call other macros by receiving
2820: their names as arguments.
2821: If a macro is not parsed but the name of another macro appears
2822: as an argument, it is interpreted as opaque text.
2823: .Pp
2824: The
2825: .Em Scope
2826: column, if applicable, describes closure rules.
2827: .Ss Block full-explicit
2828: Multi-line scope closed by an explicit closing macro.
2829: All macros contains bodies; only
1.284 schwarze 2830: .Ic \&Bf
1.211 schwarze 2831: and
2832: .Pq optionally
1.274 schwarze 2833: .Ic \&Bl
1.211 schwarze 2834: contain a head.
2835: .Bd -literal -offset indent
2836: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
2837: \(lBbody...\(rB
2838: \&.Yc
2839: .Ed
2840: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent
2841: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.274 schwarze 2842: .It Ic \&Bd Ta \&No Ta \&No Ta closed by Ic \&Ed
2843: .It Ic \&Bf Ta \&No Ta \&No Ta closed by Ic \&Ef
2844: .It Ic \&Bk Ta \&No Ta \&No Ta closed by Ic \&Ek
2845: .It Ic \&Bl Ta \&No Ta \&No Ta closed by Ic \&El
2846: .It Ic \&Ed Ta \&No Ta \&No Ta opened by Ic \&Bd
2847: .It Ic \&Ef Ta \&No Ta \&No Ta opened by Ic \&Bf
2848: .It Ic \&Ek Ta \&No Ta \&No Ta opened by Ic \&Bk
2849: .It Ic \&El Ta \&No Ta \&No Ta opened by Ic \&Bl
1.211 schwarze 2850: .El
2851: .Ss Block full-implicit
2852: Multi-line scope closed by end-of-file or implicitly by another macro.
2853: All macros have bodies; some
2854: .Po
1.274 schwarze 2855: .Ic \&It Fl bullet ,
1.211 schwarze 2856: .Fl hyphen ,
2857: .Fl dash ,
2858: .Fl enum ,
2859: .Fl item
2860: .Pc
2861: don't have heads; only one
2862: .Po
1.274 schwarze 2863: .Ic \&It
1.211 schwarze 2864: in
1.274 schwarze 2865: .Ic \&Bl Fl column
1.211 schwarze 2866: .Pc
2867: has multiple heads.
2868: .Bd -literal -offset indent
2869: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
2870: \(lBbody...\(rB
2871: .Ed
2872: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent
2873: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.274 schwarze 2874: .It Ic \&It Ta \&No Ta Yes Ta closed by Ic \&It , Ic \&El
2875: .It Ic \&Nd Ta \&No Ta \&No Ta closed by Ic \&Sh
2876: .It Ic \&Nm Ta \&No Ta Yes Ta closed by Ic \&Nm , Ic \&Sh , Ic \&Ss
2877: .It Ic \&Sh Ta \&No Ta Yes Ta closed by Ic \&Sh
2878: .It Ic \&Ss Ta \&No Ta Yes Ta closed by Ic \&Sh , Ic \&Ss
1.211 schwarze 2879: .El
2880: .Pp
2881: Note that the
1.274 schwarze 2882: .Ic \&Nm
1.211 schwarze 2883: macro is a
2884: .Sx Block full-implicit
2885: macro only when invoked as the first macro
2886: in a
2887: .Em SYNOPSIS
2888: section line, else it is
2889: .Sx In-line .
2890: .Ss Block partial-explicit
2891: Like block full-explicit, but also with single-line scope.
2892: Each has at least a body and, in limited circumstances, a head
2893: .Po
1.274 schwarze 2894: .Ic \&Fo ,
2895: .Ic \&Eo
1.211 schwarze 2896: .Pc
2897: and/or tail
1.274 schwarze 2898: .Pq Ic \&Ec .
1.211 schwarze 2899: .Bd -literal -offset indent
2900: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
2901: \(lBbody...\(rB
2902: \&.Yc \(lBtail...\(rB
2903:
2904: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
2905: \(lBbody...\(rB \&Yc \(lBtail...\(rB
2906: .Ed
2907: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
2908: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.274 schwarze 2909: .It Ic \&Ac Ta Yes Ta Yes Ta opened by Ic \&Ao
2910: .It Ic \&Ao Ta Yes Ta Yes Ta closed by Ic \&Ac
2911: .It Ic \&Bc Ta Yes Ta Yes Ta closed by Ic \&Bo
2912: .It Ic \&Bo Ta Yes Ta Yes Ta opened by Ic \&Bc
2913: .It Ic \&Brc Ta Yes Ta Yes Ta opened by Ic \&Bro
2914: .It Ic \&Bro Ta Yes Ta Yes Ta closed by Ic \&Brc
2915: .It Ic \&Dc Ta Yes Ta Yes Ta opened by Ic \&Do
2916: .It Ic \&Do Ta Yes Ta Yes Ta closed by Ic \&Dc
2917: .It Ic \&Ec Ta Yes Ta Yes Ta opened by Ic \&Eo
2918: .It Ic \&Eo Ta Yes Ta Yes Ta closed by Ic \&Ec
2919: .It Ic \&Fc Ta Yes Ta Yes Ta opened by Ic \&Fo
2920: .It Ic \&Fo Ta \&No Ta \&No Ta closed by Ic \&Fc
2921: .It Ic \&Oc Ta Yes Ta Yes Ta closed by Ic \&Oo
2922: .It Ic \&Oo Ta Yes Ta Yes Ta opened by Ic \&Oc
2923: .It Ic \&Pc Ta Yes Ta Yes Ta closed by Ic \&Po
2924: .It Ic \&Po Ta Yes Ta Yes Ta opened by Ic \&Pc
2925: .It Ic \&Qc Ta Yes Ta Yes Ta opened by Ic \&Oo
2926: .It Ic \&Qo Ta Yes Ta Yes Ta closed by Ic \&Oc
2927: .It Ic \&Re Ta \&No Ta \&No Ta opened by Ic \&Rs
2928: .It Ic \&Rs Ta \&No Ta \&No Ta closed by Ic \&Re
2929: .It Ic \&Sc Ta Yes Ta Yes Ta opened by Ic \&So
2930: .It Ic \&So Ta Yes Ta Yes Ta closed by Ic \&Sc
2931: .It Ic \&Xc Ta Yes Ta Yes Ta opened by Ic \&Xo
2932: .It Ic \&Xo Ta Yes Ta Yes Ta closed by Ic \&Xc
1.211 schwarze 2933: .El
2934: .Ss Block partial-implicit
2935: Like block full-implicit, but with single-line scope closed by the
2936: end of the line.
2937: .Bd -literal -offset indent
2938: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
2939: .Ed
2940: .Bl -column "MacroX" "CallableX" "ParsedX" -offset indent
2941: .It Em Macro Ta Em Callable Ta Em Parsed
1.274 schwarze 2942: .It Ic \&Aq Ta Yes Ta Yes
2943: .It Ic \&Bq Ta Yes Ta Yes
2944: .It Ic \&Brq Ta Yes Ta Yes
2945: .It Ic \&D1 Ta \&No Ta \&Yes
2946: .It Ic \&Dl Ta \&No Ta Yes
2947: .It Ic \&Dq Ta Yes Ta Yes
2948: .It Ic \&En Ta Yes Ta Yes
2949: .It Ic \&Op Ta Yes Ta Yes
2950: .It Ic \&Pq Ta Yes Ta Yes
2951: .It Ic \&Ql Ta Yes Ta Yes
2952: .It Ic \&Qq Ta Yes Ta Yes
2953: .It Ic \&Sq Ta Yes Ta Yes
2954: .It Ic \&Vt Ta Yes Ta Yes
1.211 schwarze 2955: .El
2956: .Pp
2957: Note that the
1.274 schwarze 2958: .Ic \&Vt
1.211 schwarze 2959: macro is a
2960: .Sx Block partial-implicit
2961: only when invoked as the first macro
2962: in a
2963: .Em SYNOPSIS
2964: section line, else it is
2965: .Sx In-line .
2966: .Ss Special block macro
2967: The
1.274 schwarze 2968: .Ic \&Ta
1.211 schwarze 2969: macro can only be used below
1.274 schwarze 2970: .Ic \&It
1.211 schwarze 2971: in
1.274 schwarze 2972: .Ic \&Bl Fl column
1.211 schwarze 2973: lists.
2974: It delimits blocks representing table cells;
2975: these blocks have bodies, but no heads.
2976: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
2977: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.274 schwarze 2978: .It Ic \&Ta Ta Yes Ta Yes Ta closed by Ic \&Ta , Ic \&It
1.211 schwarze 2979: .El
2980: .Ss In-line
2981: Closed by the end of the line, fixed argument lengths,
2982: and/or subsequent macros.
2983: In-line macros have only text children.
2984: If a number (or inequality) of arguments is
2985: .Pq n ,
2986: then the macro accepts an arbitrary number of arguments.
2987: .Bd -literal -offset indent
2988: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB
2989:
2990: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
2991:
2992: \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
2993: .Ed
2994: .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent
2995: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
1.274 schwarze 2996: .It Ic \&%A Ta \&No Ta \&No Ta >0
2997: .It Ic \&%B Ta \&No Ta \&No Ta >0
2998: .It Ic \&%C Ta \&No Ta \&No Ta >0
2999: .It Ic \&%D Ta \&No Ta \&No Ta >0
3000: .It Ic \&%I Ta \&No Ta \&No Ta >0
3001: .It Ic \&%J Ta \&No Ta \&No Ta >0
3002: .It Ic \&%N Ta \&No Ta \&No Ta >0
3003: .It Ic \&%O Ta \&No Ta \&No Ta >0
3004: .It Ic \&%P Ta \&No Ta \&No Ta >0
3005: .It Ic \&%Q Ta \&No Ta \&No Ta >0
3006: .It Ic \&%R Ta \&No Ta \&No Ta >0
3007: .It Ic \&%T Ta \&No Ta \&No Ta >0
3008: .It Ic \&%U Ta \&No Ta \&No Ta >0
3009: .It Ic \&%V Ta \&No Ta \&No Ta >0
3010: .It Ic \&Ad Ta Yes Ta Yes Ta >0
3011: .It Ic \&An Ta Yes Ta Yes Ta >0
3012: .It Ic \&Ap Ta Yes Ta Yes Ta 0
3013: .It Ic \&Ar Ta Yes Ta Yes Ta n
3014: .It Ic \&At Ta Yes Ta Yes Ta 1
3015: .It Ic \&Bsx Ta Yes Ta Yes Ta n
3016: .It Ic \&Bt Ta \&No Ta \&No Ta 0
3017: .It Ic \&Bx Ta Yes Ta Yes Ta n
3018: .It Ic \&Cd Ta Yes Ta Yes Ta >0
3019: .It Ic \&Cm Ta Yes Ta Yes Ta >0
3020: .It Ic \&Db Ta \&No Ta \&No Ta 1
3021: .It Ic \&Dd Ta \&No Ta \&No Ta n
3022: .It Ic \&Dt Ta \&No Ta \&No Ta n
3023: .It Ic \&Dv Ta Yes Ta Yes Ta >0
3024: .It Ic \&Dx Ta Yes Ta Yes Ta n
3025: .It Ic \&Em Ta Yes Ta Yes Ta >0
3026: .It Ic \&Er Ta Yes Ta Yes Ta >0
3027: .It Ic \&Es Ta Yes Ta Yes Ta 2
3028: .It Ic \&Ev Ta Yes Ta Yes Ta >0
3029: .It Ic \&Ex Ta \&No Ta \&No Ta n
3030: .It Ic \&Fa Ta Yes Ta Yes Ta >0
3031: .It Ic \&Fd Ta \&No Ta \&No Ta >0
3032: .It Ic \&Fl Ta Yes Ta Yes Ta n
3033: .It Ic \&Fn Ta Yes Ta Yes Ta >0
3034: .It Ic \&Fr Ta Yes Ta Yes Ta >0
3035: .It Ic \&Ft Ta Yes Ta Yes Ta >0
3036: .It Ic \&Fx Ta Yes Ta Yes Ta n
3037: .It Ic \&Hf Ta \&No Ta \&No Ta n
3038: .It Ic \&Ic Ta Yes Ta Yes Ta >0
1.294 schwarze 3039: .It Ic \&In Ta Yes Ta Yes Ta 1
1.298 schwarze 3040: .It Ic \&Lb Ta \&No Ta \&No Ta >0
1.274 schwarze 3041: .It Ic \&Li Ta Yes Ta Yes Ta >0
3042: .It Ic \&Lk Ta Yes Ta Yes Ta >0
3043: .It Ic \&Lp Ta \&No Ta \&No Ta 0
3044: .It Ic \&Ms Ta Yes Ta Yes Ta >0
3045: .It Ic \&Mt Ta Yes Ta Yes Ta >0
3046: .It Ic \&Nm Ta Yes Ta Yes Ta n
1.275 schwarze 3047: .It Ic \&No Ta Yes Ta Yes Ta >0
1.274 schwarze 3048: .It Ic \&Ns Ta Yes Ta Yes Ta 0
3049: .It Ic \&Nx Ta Yes Ta Yes Ta n
3050: .It Ic \&Os Ta \&No Ta \&No Ta n
3051: .It Ic \&Ot Ta Yes Ta Yes Ta >0
3052: .It Ic \&Ox Ta Yes Ta Yes Ta n
3053: .It Ic \&Pa Ta Yes Ta Yes Ta n
3054: .It Ic \&Pf Ta Yes Ta Yes Ta 1
3055: .It Ic \&Pp Ta \&No Ta \&No Ta 0
3056: .It Ic \&Rv Ta \&No Ta \&No Ta n
3057: .It Ic \&Sm Ta \&No Ta \&No Ta <2
3058: .It Ic \&St Ta \&No Ta Yes Ta 1
3059: .It Ic \&Sx Ta Yes Ta Yes Ta >0
3060: .It Ic \&Sy Ta Yes Ta Yes Ta >0
1.280 schwarze 3061: .It Ic \&Tg Ta \&No Ta \&No Ta <2
1.274 schwarze 3062: .It Ic \&Tn Ta Yes Ta Yes Ta >0
3063: .It Ic \&Ud Ta \&No Ta \&No Ta 0
3064: .It Ic \&Ux Ta Yes Ta Yes Ta n
3065: .It Ic \&Va Ta Yes Ta Yes Ta n
3066: .It Ic \&Vt Ta Yes Ta Yes Ta >0
3067: .It Ic \&Xr Ta Yes Ta Yes Ta 2
1.139 kristaps 3068: .El
1.211 schwarze 3069: .Ss Delimiters
3070: When a macro argument consists of one single input character
3071: considered as a delimiter, the argument gets special handling.
3072: This does not apply when delimiters appear in arguments containing
3073: more than one character.
3074: Consequently, to prevent special handling and just handle it
3075: like any other argument, a delimiter can be escaped by prepending
3076: a zero-width space
3077: .Pq Sq \e& .
3078: In text lines, delimiters never need escaping, but may be used
3079: as normal punctuation.
1.138 kristaps 3080: .Pp
1.211 schwarze 3081: For many macros, when the leading arguments are opening delimiters,
3082: these delimiters are put before the macro scope,
3083: and when the trailing arguments are closing delimiters,
3084: these delimiters are put after the macro scope.
1.261 schwarze 3085: Spacing is suppressed after opening delimiters
3086: and before closing delimiters.
1.211 schwarze 3087: For example,
1.172 kristaps 3088: .Pp
1.211 schwarze 3089: .D1 Pf \. \&Aq "( [ word ] ) ."
1.138 kristaps 3090: .Pp
1.211 schwarze 3091: renders as:
1.138 kristaps 3092: .Pp
1.211 schwarze 3093: .D1 Aq ( [ word ] ) .
1.198 schwarze 3094: .Pp
1.211 schwarze 3095: Opening delimiters are:
1.65 kristaps 3096: .Pp
1.211 schwarze 3097: .Bl -tag -width Ds -offset indent -compact
3098: .It \&(
3099: left parenthesis
3100: .It \&[
3101: left bracket
3102: .El
1.65 kristaps 3103: .Pp
1.211 schwarze 3104: Closing delimiters are:
1.132 kristaps 3105: .Pp
1.211 schwarze 3106: .Bl -tag -width Ds -offset indent -compact
3107: .It \&.
3108: period
3109: .It \&,
3110: comma
3111: .It \&:
3112: colon
3113: .It \&;
3114: semicolon
3115: .It \&)
3116: right parenthesis
3117: .It \&]
3118: right bracket
3119: .It \&?
3120: question mark
3121: .It \&!
3122: exclamation mark
3123: .El
1.83 kristaps 3124: .Pp
1.211 schwarze 3125: Note that even a period preceded by a backslash
3126: .Pq Sq \e.\&
3127: gets this special handling; use
1.277 schwarze 3128: .Sq \e&.\&
1.211 schwarze 3129: to prevent that.
1.83 kristaps 3130: .Pp
1.211 schwarze 3131: Many in-line macros interrupt their scope when they encounter
3132: delimiters, and resume their scope when more arguments follow that
3133: are not delimiters.
3134: For example,
1.83 kristaps 3135: .Pp
1.211 schwarze 3136: .D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e"
1.84 kristaps 3137: .Pp
1.211 schwarze 3138: renders as:
1.84 kristaps 3139: .Pp
1.211 schwarze 3140: .D1 Fl a ( b | c \*(Ba d ) e
1.84 kristaps 3141: .Pp
1.211 schwarze 3142: This applies to both opening and closing delimiters,
1.261 schwarze 3143: and also to the middle delimiter, which does not suppress spacing:
1.140 kristaps 3144: .Pp
1.211 schwarze 3145: .Bl -tag -width Ds -offset indent -compact
3146: .It \&|
3147: vertical bar
3148: .El
1.140 kristaps 3149: .Pp
1.211 schwarze 3150: As a special case, the predefined string \e*(Ba is handled and rendered
3151: in the same way as a plain
3152: .Sq \&|
3153: character.
3154: Using this predefined string is not recommended in new manuals.
1.279 schwarze 3155: .Pp
3156: Appending a zero-width space
3157: .Pq Sq \e&
3158: to the end of an input line is also useful to prevent the interpretation
3159: of a trailing period, exclamation or question mark as the end of a
3160: sentence, for example when an abbreviation happens to occur
3161: at the end of a text or macro input line.
1.211 schwarze 3162: .Ss Font handling
3163: In
3164: .Nm
3165: documents, usage of semantic markup is recommended in order to have
3166: proper fonts automatically selected; only when no fitting semantic markup
3167: is available, consider falling back to
3168: .Sx Physical markup
3169: macros.
3170: Whenever any
3171: .Nm
3172: macro switches the
3173: .Xr roff 7
3174: font mode, it will automatically restore the previous font when exiting
3175: its scope.
3176: Manually switching the font using the
3177: .Xr roff 7
3178: .Ql \ef
3179: font escape sequences is never required.
1.4 kristaps 3180: .Sh COMPATIBILITY
1.229 schwarze 3181: This section provides an incomplete list of compatibility issues
1.250 schwarze 3182: between mandoc and GNU troff
1.93 kristaps 3183: .Pq Qq groff .
3184: .Pp
1.150 kristaps 3185: The following problematic behaviour is found in groff:
3186: .Pp
1.57 kristaps 3187: .Bl -dash -compact
1.168 kristaps 3188: .It
1.274 schwarze 3189: .Ic \&Pa
1.150 kristaps 3190: does not format its arguments when used in the FILES section under
1.100 kristaps 3191: certain list types.
1.80 kristaps 3192: .It
1.274 schwarze 3193: .Ic \&Ta
1.150 kristaps 3194: can only be called by other macros, but not at the beginning of a line.
1.166 schwarze 3195: .It
1.77 kristaps 3196: .Sq \ef
1.150 kristaps 3197: .Pq font face
3198: and
1.229 schwarze 3199: .Sq \eF
1.150 kristaps 3200: .Pq font family face
1.93 kristaps 3201: .Sx Text Decoration
1.150 kristaps 3202: escapes behave irregularly when specified within line-macro scopes.
1.77 kristaps 3203: .It
1.150 kristaps 3204: Negative scaling units return to prior lines.
3205: Instead, mandoc truncates them to zero.
3206: .El
3207: .Pp
3208: The following features are unimplemented in mandoc:
3209: .Pp
3210: .Bl -dash -compact
1.61 kristaps 3211: .It
1.274 schwarze 3212: .Ic \&Bd Fl file Ar file
1.250 schwarze 3213: is unsupported for security reasons.
3214: .It
1.274 schwarze 3215: .Ic \&Bd
1.250 schwarze 3216: .Fl filled
3217: does not adjust the right margin, but is an alias for
1.274 schwarze 3218: .Ic \&Bd
1.250 schwarze 3219: .Fl ragged .
3220: .It
1.274 schwarze 3221: .Ic \&Bd
1.250 schwarze 3222: .Fl literal
3223: does not use a literal font, but is an alias for
1.274 schwarze 3224: .Ic \&Bd
1.250 schwarze 3225: .Fl unfilled .
1.57 kristaps 3226: .It
1.274 schwarze 3227: .Ic \&Bd
1.225 schwarze 3228: .Fl offset Cm center
1.64 kristaps 3229: and
1.250 schwarze 3230: .Fl offset Cm right
3231: don't work.
1.249 schwarze 3232: Groff does not implement centered and flush-right rendering either,
1.150 kristaps 3233: but produces large indentations.
1.57 kristaps 3234: .El
1.2 kristaps 3235: .Sh SEE ALSO
1.159 schwarze 3236: .Xr man 1 ,
1.57 kristaps 3237: .Xr mandoc 1 ,
1.180 kristaps 3238: .Xr eqn 7 ,
1.174 kristaps 3239: .Xr man 7 ,
1.198 schwarze 3240: .Xr mandoc_char 7 ,
1.174 kristaps 3241: .Xr roff 7 ,
3242: .Xr tbl 7
1.258 schwarze 3243: .Pp
3244: The web page
1.282 schwarze 3245: .Lk https://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language"
1.258 schwarze 3246: provides a few tutorial-style pages for beginners, an extensive style
3247: guide for advanced authors, and an alphabetic index helping to choose
3248: the best macros for various kinds of content.
1.282 schwarze 3249: .Pp
3250: The manual page
3251: .Lk https://man.voidlinux.org/groff_mdoc "groff_mdoc(7)"
3252: contained in the
3253: .Dq groff
1.283 schwarze 3254: package documents exactly the same language in a somewhat different style.
1.151 kristaps 3255: .Sh HISTORY
3256: The
3257: .Nm
3258: language first appeared as a troff macro package in
3259: .Bx 4.4 .
3260: It was later significantly updated by Werner Lemberg and Ruslan Ermilov
1.155 kristaps 3261: in groff-1.17.
1.151 kristaps 3262: The standalone implementation that is part of the
3263: .Xr mandoc 1
3264: utility written by Kristaps Dzonsons appeared in
3265: .Ox 4.6 .
1.2 kristaps 3266: .Sh AUTHORS
3267: The
1.57 kristaps 3268: .Nm
1.50 kristaps 3269: reference was written by
1.219 schwarze 3270: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
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