Annotation of mandoc/man.7, Revision 1.126
1.126 ! schwarze 1: .\" $Id: man.7,v 1.125 2014/03/17 06:57:48 schwarze Exp $
1.1 kristaps 2: .\"
1.115 schwarze 3: .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.121 schwarze 4: .\" Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
1.122 schwarze 5: .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
1.1 kristaps 6: .\"
7: .\" Permission to use, copy, modify, and distribute this software for any
1.10 kristaps 8: .\" purpose with or without fee is hereby granted, provided that the above
9: .\" copyright notice and this permission notice appear in all copies.
10: .\"
11: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 18: .\"
1.126 ! schwarze 19: .Dd $Mdocdate: March 17 2014 $
1.9 kristaps 20: .Dt MAN 7
1.1 kristaps 21: .Os
22: .Sh NAME
1.32 kristaps 23: .Nm man
1.111 schwarze 24: .Nd legacy formatting language for manual pages
1.1 kristaps 25: .Sh DESCRIPTION
1.111 schwarze 26: Traditionally, the
1.32 kristaps 27: .Nm man
1.111 schwarze 28: language has been used to write
1.32 kristaps 29: .Ux
1.111 schwarze 30: manuals for the
31: .Xr man 1
32: utility.
33: It supports limited control of presentational details like fonts,
34: indentation and spacing.
35: This reference document describes the structure of manual pages
36: and the syntax and usage of the man language.
1.32 kristaps 37: .Pp
38: .Bf -emphasis
1.20 kristaps 39: Do not use
1.32 kristaps 40: .Nm
1.111 schwarze 41: to write your manuals:
1.32 kristaps 42: .Ef
1.111 schwarze 43: It lacks support for semantic markup.
1.19 kristaps 44: Use the
1.32 kristaps 45: .Xr mdoc 7
1.1 kristaps 46: language, instead.
1.32 kristaps 47: .Pp
1.111 schwarze 48: In a
1.32 kristaps 49: .Nm
1.111 schwarze 50: document, lines beginning with the control character
1.32 kristaps 51: .Sq \&.
1.111 schwarze 52: are called
53: .Dq macro lines .
54: The first word is the macro name.
55: It usually consists of two capital letters.
56: For a list of available macros, see
57: .Sx MACRO OVERVIEW .
58: The words following the macro name are arguments to the macro.
59: .Pp
60: Lines not beginning with the control character are called
61: .Dq text lines .
62: They provide free-form text to be printed; the formatting of the text
63: depends on the respective processing context:
1.32 kristaps 64: .Bd -literal -offset indent
1.1 kristaps 65: \&.SH Macro lines change control state.
1.106 kristaps 66: Text lines are interpreted within the current state.
1.32 kristaps 67: .Ed
1.103 kristaps 68: .Pp
1.111 schwarze 69: Many aspects of the basic syntax of the
1.103 kristaps 70: .Nm
1.111 schwarze 71: language are based on the
72: .Xr roff 7
73: language; see the
74: .Em LANGUAGE SYNTAX
1.106 kristaps 75: and
1.111 schwarze 76: .Em MACRO SYNTAX
77: sections in the
78: .Xr roff 7
79: manual for details, in particular regarding
80: comments, escape sequences, whitespace, and quoting.
1.22 kristaps 81: .Sh MANUAL STRUCTURE
1.16 kristaps 82: Each
1.32 kristaps 83: .Nm
1.80 kristaps 84: document must contain the
1.39 kristaps 85: .Sx \&TH
1.68 kristaps 86: macro describing the document's section and title.
1.80 kristaps 87: It may occur anywhere in the document, although conventionally it
1.68 kristaps 88: appears as the first macro.
1.32 kristaps 89: .Pp
1.22 kristaps 90: Beyond
1.39 kristaps 91: .Sx \&TH ,
1.111 schwarze 92: at least one macro or text line must appear in the document.
1.100 kristaps 93: .Pp
94: The following is a well-formed skeleton
95: .Nm
96: file for a utility
97: .Qq progname :
1.32 kristaps 98: .Bd -literal -offset indent
1.100 kristaps 99: \&.TH PROGNAME 1 2009-10-10
1.22 kristaps 100: \&.SH NAME
1.124 schwarze 101: \efBprogname\efR \e(en one line about what it does
1.106 kristaps 102: \&.\e\(dq .SH LIBRARY
1.124 schwarze 103: \&.\e\(dq For sections 2, 3, and 9 only.
1.106 kristaps 104: \&.\e\(dq Not used in OpenBSD.
1.22 kristaps 105: \&.SH SYNOPSIS
1.124 schwarze 106: \efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR
1.22 kristaps 107: \&.SH DESCRIPTION
1.124 schwarze 108: The \efBfoo\efR utility processes files ...
1.126 ! schwarze 109: \&.\e\(dq .Sh CONTEXT
! 110: \&.\e\(dq For section 9 functions only.
1.106 kristaps 111: \&.\e\(dq .SH IMPLEMENTATION NOTES
112: \&.\e\(dq Not used in OpenBSD.
113: \&.\e\(dq .SH RETURN VALUES
1.124 schwarze 114: \&.\e\(dq For sections 2, 3, and 9 function return values only.
1.106 kristaps 115: \&.\e\(dq .SH ENVIRONMENT
1.124 schwarze 116: \&.\e\(dq For sections 1, 6, 7, and 8 only.
1.106 kristaps 117: \&.\e\(dq .SH FILES
118: \&.\e\(dq .SH EXIT STATUS
1.124 schwarze 119: \&.\e\(dq For sections 1, 6, and 8 only.
1.106 kristaps 120: \&.\e\(dq .SH EXAMPLES
121: \&.\e\(dq .SH DIAGNOSTICS
1.124 schwarze 122: \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
1.106 kristaps 123: \&.\e\(dq .SH ERRORS
1.124 schwarze 124: \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
1.106 kristaps 125: \&.\e\(dq .SH SEE ALSO
1.124 schwarze 126: \&.\e\(dq .BR foobar ( 1 )
1.106 kristaps 127: \&.\e\(dq .SH STANDARDS
128: \&.\e\(dq .SH HISTORY
129: \&.\e\(dq .SH AUTHORS
130: \&.\e\(dq .SH CAVEATS
131: \&.\e\(dq .SH BUGS
132: \&.\e\(dq .SH SECURITY CONSIDERATIONS
133: \&.\e\(dq Not used in OpenBSD.
1.32 kristaps 134: .Ed
1.41 kristaps 135: .Pp
136: The sections in a
137: .Nm
1.68 kristaps 138: document are conventionally ordered as they appear above.
139: Sections should be composed as follows:
1.42 kristaps 140: .Bl -ohang -offset indent
141: .It Em NAME
1.68 kristaps 142: The name(s) and a short description of the documented material.
143: The syntax for this is generally as follows:
1.41 kristaps 144: .Pp
145: .D1 \efBname\efR \e(en description
1.42 kristaps 146: .It Em LIBRARY
1.41 kristaps 147: The name of the library containing the documented material, which is
1.68 kristaps 148: assumed to be a function in a section 2 or 3 manual.
149: For functions in the C library, this may be as follows:
1.41 kristaps 150: .Pp
151: .D1 Standard C Library (libc, -lc)
1.42 kristaps 152: .It Em SYNOPSIS
1.41 kristaps 153: Documents the utility invocation syntax, function call syntax, or device
1.55 kristaps 154: configuration.
1.41 kristaps 155: .Pp
156: For the first, utilities (sections 1, 6, and 8), this is
157: generally structured as follows:
158: .Pp
159: .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
160: .Pp
161: For the second, function calls (sections 2, 3, 9):
162: .Pp
1.44 kristaps 163: .D1 \&.B char *name(char *\efIarg\efR);
1.41 kristaps 164: .Pp
165: And for the third, configurations (section 4):
166: .Pp
1.44 kristaps 167: .D1 \&.B name* at cardbus ? function ?
1.41 kristaps 168: .Pp
1.55 kristaps 169: Manuals not in these sections generally don't need a
1.42 kristaps 170: .Em SYNOPSIS .
171: .It Em DESCRIPTION
1.55 kristaps 172: This expands upon the brief, one-line description in
1.42 kristaps 173: .Em NAME .
174: It usually contains a break-down of the options (if documenting a
175: command).
1.126 ! schwarze 176: .It Em CONTEXT
! 177: This section lists the contexts in which functions can be called in section 9.
! 178: The contexts are autoconf, process, or interrupt.
1.42 kristaps 179: .It Em IMPLEMENTATION NOTES
1.68 kristaps 180: Implementation-specific notes should be kept here.
181: This is useful when implementing standard functions that may have side
182: effects or notable algorithmic implications.
1.42 kristaps 183: .It Em RETURN VALUES
1.80 kristaps 184: This section documents the return values of functions in sections 2, 3, and 9.
1.42 kristaps 185: .It Em ENVIRONMENT
186: Documents any usages of environment variables, e.g.,
187: .Xr environ 7 .
188: .It Em FILES
1.68 kristaps 189: Documents files used.
1.78 schwarze 190: It's helpful to document both the file name and a short description of how
1.68 kristaps 191: the file is used (created, modified, etc.).
1.67 kristaps 192: .It Em EXIT STATUS
1.80 kristaps 193: This section documents the command exit status for
194: section 1, 6, and 8 utilities.
1.68 kristaps 195: Historically, this information was described in
1.67 kristaps 196: .Em DIAGNOSTICS ,
197: a practise that is now discouraged.
1.42 kristaps 198: .It Em EXAMPLES
1.68 kristaps 199: Example usages.
200: This often contains snippets of well-formed,
201: well-tested invocations.
1.80 kristaps 202: Make sure that examples work properly!
1.42 kristaps 203: .It Em DIAGNOSTICS
1.68 kristaps 204: Documents error conditions.
1.124 schwarze 205: In section 4 and 9 manuals, these are usually messages
206: printed by the kernel to the console and to the kernel log.
207: In section 1, 6, 7, and 8, these are usually messages
208: printed by userland programs to the standard error output.
209: .Pp
1.42 kristaps 210: Historically, this section was used in place of
211: .Em EXIT STATUS
212: for manuals in sections 1, 6, and 8; however, this practise is
213: discouraged.
214: .It Em ERRORS
1.124 schwarze 215: Documents
216: .Xr errno 2
217: settings in sections 2, 3, 4, and 9.
1.42 kristaps 218: .It Em SEE ALSO
1.68 kristaps 219: References other manuals with related topics.
220: This section should exist for most manuals.
1.44 kristaps 221: .Pp
222: .D1 \&.BR bar \&( 1 \&),
223: .Pp
224: Cross-references should conventionally be ordered
1.42 kristaps 225: first by section, then alphabetically.
226: .It Em STANDARDS
227: References any standards implemented or used, such as
228: .Pp
229: .D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
230: .Pp
231: If not adhering to any standards, the
232: .Em HISTORY
233: section should be used.
234: .It Em HISTORY
1.81 schwarze 235: A brief history of the subject, including where support first appeared.
1.42 kristaps 236: .It Em AUTHORS
1.81 schwarze 237: Credits to the person or persons who wrote the code and/or documentation.
1.78 schwarze 238: Authors should generally be noted by both name and email address.
1.42 kristaps 239: .It Em CAVEATS
1.78 schwarze 240: Common misuses and misunderstandings should be explained
1.42 kristaps 241: in this section.
242: .It Em BUGS
1.80 kristaps 243: Known bugs, limitations, and work-arounds should be described
1.78 schwarze 244: in this section.
1.42 kristaps 245: .It Em SECURITY CONSIDERATIONS
246: Documents any security precautions that operators should consider.
1.41 kristaps 247: .El
1.110 schwarze 248: .Sh MACRO OVERVIEW
249: This overview is sorted such that macros of similar purpose are listed
250: together, to help find the best macro for any given purpose.
251: Deprecated macros are not included in the overview, but can be found
252: in the alphabetical reference below.
253: .Ss Page header and footer meta-data
254: .Bl -column "PP, LP, P" description
255: .It Sx TH Ta set the title: Ar title section date Op Ar source Op Ar volume
256: .It Sx AT Ta display AT&T UNIX version in the page footer (<= 1 argument)
257: .It Sx UC Ta display BSD version in the page footer (<= 1 argument)
258: .El
259: .Ss Sections and paragraphs
260: .Bl -column "PP, LP, P" description
261: .It Sx SH Ta section header (one line)
262: .It Sx SS Ta subsection header (one line)
263: .It Sx PP , LP , P Ta start an undecorated paragraph (no arguments)
264: .It Sx RS , RE Ta reset the left margin: Op Ar width
265: .It Sx IP Ta indented paragraph: Op Ar head Op Ar width
266: .It Sx TP Ta tagged paragraph: Op Ar width
267: .It Sx HP Ta hanged paragraph: Op Ar width
1.118 schwarze 268: .It Sx PD Ta set vertical paragraph distance: Op Ar height
1.110 schwarze 269: .It Sx \&br Ta force output line break in text mode (no arguments)
270: .It Sx \&sp Ta force vertical space: Op Ar height
271: .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)
272: .It Sx in Ta additional indent: Op Ar width
273: .El
274: .Ss Physical markup
275: .Bl -column "PP, LP, P" description
276: .It Sx B Ta boldface font
277: .It Sx I Ta italic font
278: .It Sx R Ta roman (default) font
279: .It Sx SB Ta small boldface font
280: .It Sx SM Ta small roman font
281: .It Sx BI Ta alternate between boldface and italic fonts
282: .It Sx BR Ta alternate between boldface and roman fonts
283: .It Sx IB Ta alternate between italic and boldface fonts
284: .It Sx IR Ta alternate between italic and roman fonts
285: .It Sx RB Ta alternate between roman and boldface fonts
286: .It Sx RI Ta alternate between roman and italic fonts
287: .El
1.111 schwarze 288: .Sh MACRO REFERENCE
1.22 kristaps 289: This section is a canonical reference to all macros, arranged
1.68 kristaps 290: alphabetically.
291: For the scoping of individual macros, see
1.32 kristaps 292: .Sx MACRO SYNTAX .
1.72 joerg 293: .Ss \&AT
294: Sets the volume for the footer for compatibility with man pages from
1.123 schwarze 295: .At
1.72 joerg 296: releases.
297: The optional arguments specify which release it is from.
1.39 kristaps 298: .Ss \&B
1.22 kristaps 299: Text is rendered in bold face.
1.44 kristaps 300: .Pp
301: See also
1.92 kristaps 302: .Sx \&I
1.44 kristaps 303: and
1.92 kristaps 304: .Sx \&R .
1.39 kristaps 305: .Ss \&BI
1.68 kristaps 306: Text is rendered alternately in bold face and italic.
307: Thus,
1.32 kristaps 308: .Sq .BI this word and that
1.22 kristaps 309: causes
1.32 kristaps 310: .Sq this
1.22 kristaps 311: and
1.32 kristaps 312: .Sq and
1.55 kristaps 313: to render in bold face, while
1.32 kristaps 314: .Sq word
1.22 kristaps 315: and
1.32 kristaps 316: .Sq that
1.68 kristaps 317: render in italics.
318: Whitespace between arguments is omitted in output.
1.44 kristaps 319: .Pp
320: Examples:
1.46 kristaps 321: .Pp
1.93 kristaps 322: .Dl \&.BI bold italic bold italic
1.44 kristaps 323: .Pp
324: The output of this example will be emboldened
325: .Dq bold
326: and italicised
327: .Dq italic ,
328: with spaces stripped between arguments.
329: .Pp
330: See also
331: .Sx \&IB ,
332: .Sx \&BR ,
333: .Sx \&RB ,
334: .Sx \&RI ,
335: and
336: .Sx \&IR .
1.39 kristaps 337: .Ss \&BR
1.22 kristaps 338: Text is rendered alternately in bold face and roman (the default font).
339: Whitespace between arguments is omitted in output.
1.44 kristaps 340: .Pp
341: See
342: .Sx \&BI
343: for an equivalent example.
344: .Pp
345: See also
346: .Sx \&BI ,
347: .Sx \&IB ,
348: .Sx \&RB ,
349: .Sx \&RI ,
350: and
351: .Sx \&IR .
1.39 kristaps 352: .Ss \&DT
1.68 kristaps 353: Has no effect.
354: Included for compatibility.
1.116 schwarze 355: .Ss \&EE
356: This is a non-standard GNU extension, included only for compatibility.
357: In
358: .Xr mandoc 1 ,
359: it does the same as
360: .Sx \&fi .
361: .Ss \&EX
362: This is a non-standard GNU extension, included only for compatibility.
363: In
364: .Xr mandoc 1 ,
365: it does the same as
366: .Sx \&nf .
1.39 kristaps 367: .Ss \&HP
1.23 kristaps 368: Begin a paragraph whose initial output line is left-justified, but
1.27 kristaps 369: subsequent output lines are indented, with the following syntax:
1.44 kristaps 370: .Bd -filled -offset indent
371: .Pf \. Sx \&HP
372: .Op Cm width
1.32 kristaps 373: .Ed
1.44 kristaps 374: .Pp
375: The
376: .Cm width
1.117 schwarze 377: argument is a
378: .Xr roff 7
379: scaling width.
1.44 kristaps 380: If specified, it's saved for later paragraph left-margins; if unspecified, the
381: saved or default width is used.
382: .Pp
383: See also
1.45 kristaps 384: .Sx \&IP ,
385: .Sx \&LP ,
386: .Sx \&P ,
387: .Sx \&PP ,
1.44 kristaps 388: and
1.45 kristaps 389: .Sx \&TP .
1.39 kristaps 390: .Ss \&I
1.22 kristaps 391: Text is rendered in italics.
1.44 kristaps 392: .Pp
393: See also
1.92 kristaps 394: .Sx \&B
1.44 kristaps 395: and
1.92 kristaps 396: .Sx \&R .
1.39 kristaps 397: .Ss \&IB
1.80 kristaps 398: Text is rendered alternately in italics and bold face.
399: Whitespace between arguments is omitted in output.
1.44 kristaps 400: .Pp
401: See
402: .Sx \&BI
403: for an equivalent example.
404: .Pp
405: See also
406: .Sx \&BI ,
407: .Sx \&BR ,
408: .Sx \&RB ,
409: .Sx \&RI ,
410: and
411: .Sx \&IR .
1.39 kristaps 412: .Ss \&IP
1.44 kristaps 413: Begin an indented paragraph with the following syntax:
414: .Bd -filled -offset indent
415: .Pf \. Sx \&IP
416: .Op Cm head Op Cm width
1.32 kristaps 417: .Ed
1.44 kristaps 418: .Pp
419: The
420: .Cm width
1.117 schwarze 421: argument is a
422: .Xr roff 7
423: scaling width defining the left margin.
1.44 kristaps 424: It's saved for later paragraph left-margins; if unspecified, the saved or
425: default width is used.
426: .Pp
427: The
428: .Cm head
1.68 kristaps 429: argument is used as a leading term, flushed to the left margin.
430: This is useful for bulleted paragraphs and so on.
1.44 kristaps 431: .Pp
432: See also
1.45 kristaps 433: .Sx \&HP ,
434: .Sx \&LP ,
435: .Sx \&P ,
436: .Sx \&PP ,
1.44 kristaps 437: and
1.45 kristaps 438: .Sx \&TP .
1.39 kristaps 439: .Ss \&IR
1.22 kristaps 440: Text is rendered alternately in italics and roman (the default font).
441: Whitespace between arguments is omitted in output.
1.44 kristaps 442: .Pp
443: See
444: .Sx \&BI
445: for an equivalent example.
446: .Pp
447: See also
448: .Sx \&BI ,
449: .Sx \&IB ,
450: .Sx \&BR ,
451: .Sx \&RB ,
452: and
453: .Sx \&RI .
1.39 kristaps 454: .Ss \&LP
1.68 kristaps 455: Begin an undecorated paragraph.
456: The scope of a paragraph is closed by a subsequent paragraph,
457: sub-section, section, or end of file.
1.78 schwarze 458: The saved paragraph left-margin width is reset to the default.
1.44 kristaps 459: .Pp
460: See also
1.45 kristaps 461: .Sx \&HP ,
462: .Sx \&IP ,
463: .Sx \&P ,
464: .Sx \&PP ,
1.44 kristaps 465: and
1.45 kristaps 466: .Sx \&TP .
1.113 kristaps 467: .Ss \&OP
468: Optional command-line argument.
1.114 schwarze 469: This is a non-standard GNU extension, included only for compatibility.
470: It has the following syntax:
1.113 kristaps 471: .Bd -filled -offset indent
472: .Pf \. Sx \&OP
473: .Cm key Op Cm value
474: .Ed
475: .Pp
476: The
477: .Cm key
478: is usually a command-line flag and
479: .Cm value
480: its argument.
1.39 kristaps 481: .Ss \&P
482: Synonym for
483: .Sx \&LP .
1.44 kristaps 484: .Pp
485: See also
1.45 kristaps 486: .Sx \&HP ,
487: .Sx \&IP ,
488: .Sx \&LP ,
489: .Sx \&PP ,
1.118 schwarze 490: and
491: .Sx \&TP .
492: .Ss \&PD
493: Specify the vertical space to be inserted before each new paragraph.
494: .br
495: The syntax is as follows:
496: .Bd -filled -offset indent
497: .Pf \. Sx \&PD
498: .Op Cm height
499: .Ed
500: .Pp
501: The
502: .Cm height
503: argument is a
504: .Xr roff 7
505: scaling width.
506: It defaults to
507: .Cm 1v .
508: If the unit is omitted,
509: .Cm v
510: is assumed.
511: .Pp
512: This macro affects the spacing before any subsequent instances of
513: .Sx \&HP ,
514: .Sx \&IP ,
515: .Sx \&LP ,
516: .Sx \&P ,
517: .Sx \&PP ,
518: .Sx \&SH ,
519: .Sx \&SS ,
1.44 kristaps 520: and
1.45 kristaps 521: .Sx \&TP .
1.39 kristaps 522: .Ss \&PP
523: Synonym for
524: .Sx \&LP .
1.44 kristaps 525: .Pp
526: See also
1.45 kristaps 527: .Sx \&HP ,
528: .Sx \&IP ,
529: .Sx \&LP ,
530: .Sx \&P ,
1.44 kristaps 531: and
1.45 kristaps 532: .Sx \&TP .
1.39 kristaps 533: .Ss \&R
1.22 kristaps 534: Text is rendered in roman (the default font).
1.44 kristaps 535: .Pp
536: See also
1.92 kristaps 537: .Sx \&I
1.44 kristaps 538: and
1.92 kristaps 539: .Sx \&B .
1.39 kristaps 540: .Ss \&RB
1.22 kristaps 541: Text is rendered alternately in roman (the default font) and bold face.
542: Whitespace between arguments is omitted in output.
1.44 kristaps 543: .Pp
544: See
545: .Sx \&BI
546: for an equivalent example.
547: .Pp
548: See also
549: .Sx \&BI ,
550: .Sx \&IB ,
551: .Sx \&BR ,
552: .Sx \&RI ,
553: and
554: .Sx \&IR .
1.39 kristaps 555: .Ss \&RE
1.30 kristaps 556: Explicitly close out the scope of a prior
1.39 kristaps 557: .Sx \&RS .
1.102 kristaps 558: The default left margin is restored to the state of the original
559: .Sx \&RS
560: invocation.
1.39 kristaps 561: .Ss \&RI
1.22 kristaps 562: Text is rendered alternately in roman (the default font) and italics.
563: Whitespace between arguments is omitted in output.
1.44 kristaps 564: .Pp
565: See
566: .Sx \&BI
567: for an equivalent example.
568: .Pp
569: See also
570: .Sx \&BI ,
571: .Sx \&IB ,
572: .Sx \&BR ,
573: .Sx \&RB ,
574: and
575: .Sx \&IR .
1.39 kristaps 576: .Ss \&RS
1.102 kristaps 577: Temporarily reset the default left margin.
1.44 kristaps 578: This has the following syntax:
579: .Bd -filled -offset indent
1.102 kristaps 580: .Pf \. Sx \&RS
1.44 kristaps 581: .Op Cm width
1.32 kristaps 582: .Ed
1.44 kristaps 583: .Pp
584: The
585: .Cm width
1.117 schwarze 586: argument is a
587: .Xr roff 7
588: scaling width.
1.55 kristaps 589: If not specified, the saved or default width is used.
1.102 kristaps 590: .Pp
591: See also
592: .Sx \&RE .
1.39 kristaps 593: .Ss \&SB
1.22 kristaps 594: Text is rendered in small size (one point smaller than the default font)
595: bold face.
1.39 kristaps 596: .Ss \&SH
1.68 kristaps 597: Begin a section.
598: The scope of a section is only closed by another section or the end of
599: file.
1.78 schwarze 600: The paragraph left-margin width is reset to the default.
1.39 kristaps 601: .Ss \&SM
1.22 kristaps 602: Text is rendered in small size (one point smaller than the default
603: font).
1.39 kristaps 604: .Ss \&SS
1.68 kristaps 605: Begin a sub-section.
606: The scope of a sub-section is closed by a subsequent sub-section,
607: section, or end of file.
1.78 schwarze 608: The paragraph left-margin width is reset to the default.
1.39 kristaps 609: .Ss \&TH
1.22 kristaps 610: Sets the title of the manual page with the following syntax:
1.44 kristaps 611: .Bd -filled -offset indent
612: .Pf \. Sx \&TH
1.99 schwarze 613: .Ar title section date
614: .Op Ar source Op Ar volume
1.44 kristaps 615: .Ed
1.43 kristaps 616: .Pp
1.99 schwarze 617: Conventionally, the document
618: .Ar title
619: is given in all caps.
620: The recommended
621: .Ar date
622: format is
623: .Sy YYYY-MM-DD
624: as specified in the ISO-8601 standard;
625: if the argument does not conform, it is printed verbatim.
626: If the
627: .Ar date
628: is empty or not specified, the current date is used.
629: The optional
630: .Ar source
1.68 kristaps 631: string specifies the organisation providing the utility.
632: The
1.99 schwarze 633: .Ar volume
1.43 kristaps 634: string replaces the default rendered volume, which is dictated by the
635: manual section.
636: .Pp
637: Examples:
1.46 kristaps 638: .Pp
1.93 kristaps 639: .Dl \&.TH CVS 5 "1992-02-12" GNU
1.39 kristaps 640: .Ss \&TP
1.25 kristaps 641: Begin a paragraph where the head, if exceeding the indentation width, is
1.24 kristaps 642: followed by a newline; if not, the body follows on the same line after a
1.68 kristaps 643: buffer to the indentation width.
644: Subsequent output lines are indented.
1.44 kristaps 645: The syntax is as follows:
646: .Bd -filled -offset indent
647: .Pf \. Sx \&TP
648: .Op Cm width
1.32 kristaps 649: .Ed
650: .Pp
1.44 kristaps 651: The
652: .Cm width
1.117 schwarze 653: argument is a
654: .Xr roff 7
655: scaling width.
1.44 kristaps 656: If specified, it's saved for later paragraph left-margins; if
1.27 kristaps 657: unspecified, the saved or default width is used.
1.44 kristaps 658: .Pp
659: See also
1.45 kristaps 660: .Sx \&HP ,
661: .Sx \&IP ,
662: .Sx \&LP ,
663: .Sx \&P ,
1.44 kristaps 664: and
1.45 kristaps 665: .Sx \&PP .
1.72 joerg 666: .Ss \&UC
667: Sets the volume for the footer for compatibility with man pages from
1.120 schwarze 668: .Bx
669: releases.
1.72 joerg 670: The optional first argument specifies which release it is from.
1.121 schwarze 671: .Ss \&UE
672: End a uniform resource identifier block.
673: This is a non-standard GNU extension, included only for compatibility.
674: See
675: .Sx \&UE .
676: .Ss \&UR
677: Begin a uniform resource identifier block.
678: This is a non-standard GNU extension, included only for compatibility.
679: It has the following syntax:
680: .Bd -literal -offset indent
681: .Pf \. Sx \&UR Ar uri
682: link description to be shown
683: .Pf \. Sx UE
684: .Ed
1.39 kristaps 685: .Ss \&br
1.68 kristaps 686: Breaks the current line.
687: Consecutive invocations have no further effect.
1.44 kristaps 688: .Pp
689: See also
690: .Sx \&sp .
1.39 kristaps 691: .Ss \&fi
1.22 kristaps 692: End literal mode begun by
1.39 kristaps 693: .Sx \&nf .
1.79 kristaps 694: .Ss \&in
695: Indent relative to the current indentation:
696: .Pp
697: .D1 Pf \. Sx \&in Op Cm width
698: .Pp
699: If
700: .Cm width
701: is signed, the new offset is relative.
702: Otherwise, it is absolute.
703: This value is reset upon the next paragraph, section, or sub-section.
1.39 kristaps 704: .Ss \&na
1.36 kristaps 705: Don't align to the right margin.
1.39 kristaps 706: .Ss \&nf
1.22 kristaps 707: Begin literal mode: all subsequent free-form lines have their end of
1.68 kristaps 708: line boundaries preserved.
709: May be ended by
1.39 kristaps 710: .Sx \&fi .
1.101 kristaps 711: Literal mode is implicitly ended by
712: .Sx \&SH
713: or
714: .Sx \&SS .
1.39 kristaps 715: .Ss \&sp
1.44 kristaps 716: Insert vertical spaces into output with the following syntax:
717: .Bd -filled -offset indent
718: .Pf \. Sx \&sp
719: .Op Cm height
720: .Ed
721: .Pp
1.117 schwarze 722: The
1.44 kristaps 723: .Cm height
1.117 schwarze 724: argument is a scaling width as described in
725: .Xr roff 7 .
1.44 kristaps 726: If 0, this is equivalent to the
1.39 kristaps 727: .Sx \&br
1.68 kristaps 728: macro.
729: Defaults to 1, if unspecified.
1.44 kristaps 730: .Pp
731: See also
732: .Sx \&br .
1.111 schwarze 733: .Sh MACRO SYNTAX
734: The
735: .Nm
736: macros are classified by scope: line scope or block scope.
737: Line macros are only scoped to the current line (and, in some
738: situations, the subsequent line).
739: Block macros are scoped to the current line and subsequent lines until
740: closed by another block macro.
741: .Ss Line Macros
742: Line macros are generally scoped to the current line, with the body
743: consisting of zero or more arguments.
744: If a macro is scoped to the next line and the line arguments are empty,
745: the next line, which must be text, is used instead.
746: Thus:
747: .Bd -literal -offset indent
748: \&.I
749: foo
750: .Ed
751: .Pp
752: is equivalent to
753: .Sq \&.I foo .
754: If next-line macros are invoked consecutively, only the last is used.
755: If a next-line macro is followed by a non-next-line macro, an error is
756: raised, except for
757: .Sx \&br ,
758: .Sx \&sp ,
759: and
760: .Sx \&na .
761: .Pp
762: The syntax is as follows:
763: .Bd -literal -offset indent
764: \&.YO \(lBbody...\(rB
765: \(lBbody...\(rB
766: .Ed
767: .Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent
768: .It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes
769: .It Sx \&AT Ta <=1 Ta current Ta \&
770: .It Sx \&B Ta n Ta next-line Ta \&
771: .It Sx \&BI Ta n Ta current Ta \&
772: .It Sx \&BR Ta n Ta current Ta \&
773: .It Sx \&DT Ta 0 Ta current Ta \&
1.121 schwarze 774: .It Sx \&EE Ta 0 Ta current Ta compat
775: .It Sx \&EX Ta 0 Ta current Ta compat
1.111 schwarze 776: .It Sx \&I Ta n Ta next-line Ta \&
777: .It Sx \&IB Ta n Ta current Ta \&
778: .It Sx \&IR Ta n Ta current Ta \&
1.113 kristaps 779: .It Sx \&OP Ta 0, 1 Ta current Ta compat
1.121 schwarze 780: .It Sx \&PD Ta 1 Ta current Ta \&
1.111 schwarze 781: .It Sx \&R Ta n Ta next-line Ta \&
782: .It Sx \&RB Ta n Ta current Ta \&
783: .It Sx \&RI Ta n Ta current Ta \&
784: .It Sx \&SB Ta n Ta next-line Ta \&
785: .It Sx \&SM Ta n Ta next-line Ta \&
786: .It Sx \&TH Ta >1, <6 Ta current Ta \&
787: .It Sx \&UC Ta <=1 Ta current Ta \&
788: .It Sx \&br Ta 0 Ta current Ta compat
789: .It Sx \&fi Ta 0 Ta current Ta compat
790: .It Sx \&in Ta 1 Ta current Ta compat
791: .It Sx \&na Ta 0 Ta current Ta compat
792: .It Sx \&nf Ta 0 Ta current Ta compat
793: .It Sx \&sp Ta 1 Ta current Ta compat
794: .El
795: .Pp
796: Macros marked as
797: .Qq compat
798: are included for compatibility with the significant corpus of existing
799: manuals that mix dialects of roff.
800: These macros should not be used for portable
801: .Nm
802: manuals.
803: .Ss Block Macros
804: Block macros comprise a head and body.
805: As with in-line macros, the head is scoped to the current line and, in
806: one circumstance, the next line (the next-line stipulations as in
807: .Sx Line Macros
808: apply here as well).
809: .Pp
810: The syntax is as follows:
811: .Bd -literal -offset indent
812: \&.YO \(lBhead...\(rB
813: \(lBhead...\(rB
814: \(lBbody...\(rB
815: .Ed
816: .Pp
817: The closure of body scope may be to the section, where a macro is closed
818: by
819: .Sx \&SH ;
820: sub-section, closed by a section or
821: .Sx \&SS ;
822: part, closed by a section, sub-section, or
823: .Sx \&RE ;
824: or paragraph, closed by a section, sub-section, part,
825: .Sx \&HP ,
826: .Sx \&IP ,
827: .Sx \&LP ,
828: .Sx \&P ,
829: .Sx \&PP ,
830: or
831: .Sx \&TP .
832: No closure refers to an explicit block closing macro.
833: .Pp
834: As a rule, block macros may not be nested; thus, calling a block macro
835: while another block macro scope is open, and the open scope is not
836: implicitly closed, is syntactically incorrect.
837: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent
838: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes
839: .It Sx \&HP Ta <2 Ta current Ta paragraph Ta \&
840: .It Sx \&IP Ta <3 Ta current Ta paragraph Ta \&
841: .It Sx \&LP Ta 0 Ta current Ta paragraph Ta \&
842: .It Sx \&P Ta 0 Ta current Ta paragraph Ta \&
843: .It Sx \&PP Ta 0 Ta current Ta paragraph Ta \&
844: .It Sx \&RE Ta 0 Ta current Ta none Ta compat
845: .It Sx \&RS Ta 1 Ta current Ta part Ta compat
846: .It Sx \&SH Ta >0 Ta next-line Ta section Ta \&
847: .It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \&
848: .It Sx \&TP Ta n Ta next-line Ta paragraph Ta \&
1.121 schwarze 849: .It Sx \&UE Ta 0 Ta current Ta none Ta compat
850: .It Sx \&UR Ta 1 Ta current Ta part Ta compat
1.111 schwarze 851: .El
852: .Pp
853: Macros marked
854: .Qq compat
855: are as mentioned in
856: .Sx Line Macros .
857: .Pp
858: If a block macro is next-line scoped, it may only be followed by in-line
859: macros for decorating text.
860: .Ss Font handling
861: In
862: .Nm
863: documents, both
864: .Sx Physical markup
865: macros and
866: .Xr roff 7
867: .Ql \ef
868: font escape sequences can be used to choose fonts.
869: In text lines, the effect of manual font selection by escape sequences
870: only lasts until the next macro invocation; in macro lines, it only lasts
871: until the end of the macro scope.
872: Note that macros like
873: .Sx \&BR
874: open and close a font scope for each argument.
1.18 kristaps 875: .Sh COMPATIBILITY
1.58 kristaps 876: This section documents areas of questionable portability between
877: implementations of the
878: .Nm
879: language.
1.51 kristaps 880: .Pp
881: .Bl -dash -compact
1.109 kristaps 882: .It
883: Do not depend on
884: .Sx \&SH
885: or
886: .Sx \&SS
887: to close out a literal context opened with
888: .Sx \&nf .
889: This behaviour may not be portable.
1.77 kristaps 890: .It
1.58 kristaps 891: In quoted literals, GNU troff allowed pair-wise double-quotes to produce
1.68 kristaps 892: a standalone double-quote in formatted output.
893: It is not known whether this behaviour is exhibited by other formatters.
1.32 kristaps 894: .It
1.82 kristaps 895: troff suppresses a newline before
896: .Sq \(aq
897: macro output; in mandoc, it is an alias for the standard
898: .Sq \&.
899: control character.
900: .It
901: The
902: .Sq \eh
903: .Pq horizontal position ,
904: .Sq \ev
905: .Pq vertical position ,
906: .Sq \em
907: .Pq text colour ,
908: .Sq \eM
909: .Pq text filling colour ,
1.83 kristaps 910: .Sq \ez
911: .Pq zero-length character ,
1.84 kristaps 912: .Sq \ew
913: .Pq string length ,
1.85 kristaps 914: .Sq \ek
915: .Pq horizontal position marker ,
1.87 kristaps 916: .Sq \eo
917: .Pq text overstrike ,
1.82 kristaps 918: and
919: .Sq \es
920: .Pq text size
1.84 kristaps 921: escape sequences are all discarded in mandoc.
1.82 kristaps 922: .It
923: The
924: .Sq \ef
925: scaling unit is accepted by mandoc, but rendered as the default unit.
926: .It
1.23 kristaps 927: The
1.51 kristaps 928: .Sx \&sp
1.68 kristaps 929: macro does not accept negative values in mandoc.
930: In GNU troff, this would result in strange behaviour.
1.112 schwarze 931: .It
932: In page header lines, GNU troff versions up to and including 1.21
933: only print
934: .Ar volume
935: names explicitly specified in the
936: .Sx \&TH
937: macro; mandoc and newer groff print the default volume name
938: corresponding to the
939: .Ar section
940: number when no
941: .Ar volume
942: is given, like in
943: .Xr mdoc 7 .
1.32 kristaps 944: .El
1.113 kristaps 945: .Pp
946: The
947: .Sx OP
948: macro is part of the extended
949: .Nm
950: macro set, and may not be portable to non-GNU troff implementations.
1.1 kristaps 951: .Sh SEE ALSO
1.89 schwarze 952: .Xr man 1 ,
1.32 kristaps 953: .Xr mandoc 1 ,
1.98 kristaps 954: .Xr eqn 7 ,
1.89 schwarze 955: .Xr mandoc_char 7 ,
1.94 kristaps 956: .Xr mdoc 7 ,
957: .Xr roff 7 ,
958: .Xr tbl 7
1.78 schwarze 959: .Sh HISTORY
960: The
961: .Nm
962: language first appeared as a macro package for the roff typesetting
963: system in
964: .At v7 .
965: It was later rewritten by James Clark as a macro package for groff.
1.113 kristaps 966: Eric S. Raymond wrote the extended
967: .Nm
968: macros for groff in 2007.
1.78 schwarze 969: The stand-alone implementation that is part of the
970: .Xr mandoc 1
971: utility written by Kristaps Dzonsons appeared in
1.80 kristaps 972: .Ox 4.6 .
1.1 kristaps 973: .Sh AUTHORS
1.78 schwarze 974: This
1.32 kristaps 975: .Nm
1.23 kristaps 976: reference was written by
1.119 schwarze 977: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.1 kristaps 978: .Sh CAVEATS
1.68 kristaps 979: Do not use this language.
980: Use
1.32 kristaps 981: .Xr mdoc 7 ,
1.1 kristaps 982: instead.
CVSweb