Annotation of mandoc/man.7, Revision 1.138
1.138 ! schwarze 1: .\" $Id: man.7,v 1.137 2018/04/05 22:12:33 schwarze Exp $
1.1 kristaps 2: .\"
1.115 schwarze 3: .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.129 schwarze 4: .\" Copyright (c) 2011-2015 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.138 ! schwarze 19: .Dd $Mdocdate: April 5 2018 $
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 fi , nf Ta fill mode and no-fill mode (no arguments)
270: .It Sx in Ta additional indent: Op Ar width
271: .El
272: .Ss Physical markup
273: .Bl -column "PP, LP, P" description
274: .It Sx B Ta boldface font
275: .It Sx I Ta italic font
276: .It Sx SB Ta small boldface font
277: .It Sx SM Ta small roman font
278: .It Sx BI Ta alternate between boldface and italic fonts
279: .It Sx BR Ta alternate between boldface and roman fonts
280: .It Sx IB Ta alternate between italic and boldface fonts
281: .It Sx IR Ta alternate between italic and roman fonts
282: .It Sx RB Ta alternate between roman and boldface fonts
283: .It Sx RI Ta alternate between roman and italic fonts
284: .El
1.111 schwarze 285: .Sh MACRO REFERENCE
1.22 kristaps 286: This section is a canonical reference to all macros, arranged
1.68 kristaps 287: alphabetically.
288: For the scoping of individual macros, see
1.32 kristaps 289: .Sx MACRO SYNTAX .
1.72 joerg 290: .Ss \&AT
291: Sets the volume for the footer for compatibility with man pages from
1.123 schwarze 292: .At
1.72 joerg 293: releases.
294: The optional arguments specify which release it is from.
1.39 kristaps 295: .Ss \&B
1.22 kristaps 296: Text is rendered in bold face.
1.44 kristaps 297: .Pp
298: See also
1.137 schwarze 299: .Sx \&I .
1.39 kristaps 300: .Ss \&BI
1.68 kristaps 301: Text is rendered alternately in bold face and italic.
302: Thus,
1.32 kristaps 303: .Sq .BI this word and that
1.22 kristaps 304: causes
1.32 kristaps 305: .Sq this
1.22 kristaps 306: and
1.32 kristaps 307: .Sq and
1.55 kristaps 308: to render in bold face, while
1.32 kristaps 309: .Sq word
1.22 kristaps 310: and
1.32 kristaps 311: .Sq that
1.68 kristaps 312: render in italics.
313: Whitespace between arguments is omitted in output.
1.44 kristaps 314: .Pp
315: Examples:
1.46 kristaps 316: .Pp
1.93 kristaps 317: .Dl \&.BI bold italic bold italic
1.44 kristaps 318: .Pp
319: The output of this example will be emboldened
320: .Dq bold
321: and italicised
322: .Dq italic ,
323: with spaces stripped between arguments.
324: .Pp
325: See also
326: .Sx \&IB ,
327: .Sx \&BR ,
328: .Sx \&RB ,
329: .Sx \&RI ,
330: and
331: .Sx \&IR .
1.39 kristaps 332: .Ss \&BR
1.22 kristaps 333: Text is rendered alternately in bold face and roman (the default font).
334: Whitespace between arguments is omitted in output.
1.44 kristaps 335: .Pp
336: See
337: .Sx \&BI
338: for an equivalent example.
339: .Pp
340: See also
341: .Sx \&BI ,
342: .Sx \&IB ,
343: .Sx \&RB ,
344: .Sx \&RI ,
345: and
346: .Sx \&IR .
1.39 kristaps 347: .Ss \&DT
1.135 schwarze 348: Restore the default tabulator positions.
349: They are at intervals of 0.5 inches.
350: This has no effect unless the tabulator positions were changed with the
351: .Xr roff 7
352: .Ic \&ta
353: request.
1.116 schwarze 354: .Ss \&EE
355: This is a non-standard GNU extension, included only for compatibility.
356: In
357: .Xr mandoc 1 ,
358: it does the same as
359: .Sx \&fi .
360: .Ss \&EX
361: This is a non-standard GNU extension, included only for compatibility.
362: In
363: .Xr mandoc 1 ,
364: it does the same as
365: .Sx \&nf .
1.39 kristaps 366: .Ss \&HP
1.23 kristaps 367: Begin a paragraph whose initial output line is left-justified, but
1.27 kristaps 368: subsequent output lines are indented, with the following syntax:
1.44 kristaps 369: .Bd -filled -offset indent
370: .Pf \. Sx \&HP
1.130 schwarze 371: .Op Ar width
1.32 kristaps 372: .Ed
1.44 kristaps 373: .Pp
374: The
1.130 schwarze 375: .Ar width
1.117 schwarze 376: argument is a
377: .Xr roff 7
378: scaling width.
1.44 kristaps 379: If specified, it's saved for later paragraph left-margins; if unspecified, the
380: saved or default width is used.
381: .Pp
382: See also
1.45 kristaps 383: .Sx \&IP ,
384: .Sx \&LP ,
385: .Sx \&P ,
386: .Sx \&PP ,
1.44 kristaps 387: and
1.45 kristaps 388: .Sx \&TP .
1.39 kristaps 389: .Ss \&I
1.22 kristaps 390: Text is rendered in italics.
1.44 kristaps 391: .Pp
392: See also
1.137 schwarze 393: .Sx \&B .
1.39 kristaps 394: .Ss \&IB
1.80 kristaps 395: Text is rendered alternately in italics and bold face.
396: Whitespace between arguments is omitted in output.
1.44 kristaps 397: .Pp
398: See
399: .Sx \&BI
400: for an equivalent example.
401: .Pp
402: See also
403: .Sx \&BI ,
404: .Sx \&BR ,
405: .Sx \&RB ,
406: .Sx \&RI ,
407: and
408: .Sx \&IR .
1.39 kristaps 409: .Ss \&IP
1.44 kristaps 410: Begin an indented paragraph with the following syntax:
411: .Bd -filled -offset indent
412: .Pf \. Sx \&IP
1.130 schwarze 413: .Op Ar head Op Ar width
1.32 kristaps 414: .Ed
1.44 kristaps 415: .Pp
416: The
1.130 schwarze 417: .Ar width
1.117 schwarze 418: argument is a
419: .Xr roff 7
420: scaling width defining the left margin.
1.44 kristaps 421: It's saved for later paragraph left-margins; if unspecified, the saved or
422: default width is used.
423: .Pp
424: The
1.130 schwarze 425: .Ar head
1.68 kristaps 426: argument is used as a leading term, flushed to the left margin.
427: This is useful for bulleted paragraphs and so on.
1.44 kristaps 428: .Pp
429: See also
1.45 kristaps 430: .Sx \&HP ,
431: .Sx \&LP ,
432: .Sx \&P ,
433: .Sx \&PP ,
1.44 kristaps 434: and
1.45 kristaps 435: .Sx \&TP .
1.39 kristaps 436: .Ss \&IR
1.22 kristaps 437: Text is rendered alternately in italics and roman (the default font).
438: Whitespace between arguments is omitted in output.
1.44 kristaps 439: .Pp
440: See
441: .Sx \&BI
442: for an equivalent example.
443: .Pp
444: See also
445: .Sx \&BI ,
446: .Sx \&IB ,
447: .Sx \&BR ,
448: .Sx \&RB ,
449: and
450: .Sx \&RI .
1.39 kristaps 451: .Ss \&LP
1.68 kristaps 452: Begin an undecorated paragraph.
453: The scope of a paragraph is closed by a subsequent paragraph,
454: sub-section, section, or end of file.
1.78 schwarze 455: The saved paragraph left-margin width is reset to the default.
1.44 kristaps 456: .Pp
457: See also
1.45 kristaps 458: .Sx \&HP ,
459: .Sx \&IP ,
460: .Sx \&P ,
461: .Sx \&PP ,
1.44 kristaps 462: and
1.45 kristaps 463: .Sx \&TP .
1.136 schwarze 464: .Ss \&ME
465: End a mailto block.
466: This is a non-standard GNU extension, included only for compatibility.
467: See
468: .Sx \&MT .
469: .Ss \&MT
470: Begin a mailto block.
471: This is a non-standard GNU extension, included only for compatibility.
472: It has the following syntax:
473: .Bd -literal -offset indent
474: .Pf \. Sx \&MT Ar address
475: link description to be shown
476: .Pf \. Sx ME
477: .Ed
1.113 kristaps 478: .Ss \&OP
479: Optional command-line argument.
1.114 schwarze 480: This is a non-standard GNU extension, included only for compatibility.
481: It has the following syntax:
1.113 kristaps 482: .Bd -filled -offset indent
483: .Pf \. Sx \&OP
1.130 schwarze 484: .Ar key Op Ar value
1.113 kristaps 485: .Ed
486: .Pp
487: The
1.130 schwarze 488: .Ar key
1.113 kristaps 489: is usually a command-line flag and
1.130 schwarze 490: .Ar value
1.113 kristaps 491: its argument.
1.39 kristaps 492: .Ss \&P
493: Synonym for
494: .Sx \&LP .
1.44 kristaps 495: .Pp
496: See also
1.45 kristaps 497: .Sx \&HP ,
498: .Sx \&IP ,
499: .Sx \&LP ,
500: .Sx \&PP ,
1.118 schwarze 501: and
502: .Sx \&TP .
503: .Ss \&PD
504: Specify the vertical space to be inserted before each new paragraph.
505: .br
506: The syntax is as follows:
507: .Bd -filled -offset indent
508: .Pf \. Sx \&PD
1.130 schwarze 509: .Op Ar height
1.118 schwarze 510: .Ed
511: .Pp
512: The
1.130 schwarze 513: .Ar height
1.118 schwarze 514: argument is a
515: .Xr roff 7
516: scaling width.
517: It defaults to
518: .Cm 1v .
519: If the unit is omitted,
520: .Cm v
521: is assumed.
522: .Pp
523: This macro affects the spacing before any subsequent instances of
524: .Sx \&HP ,
525: .Sx \&IP ,
526: .Sx \&LP ,
527: .Sx \&P ,
528: .Sx \&PP ,
529: .Sx \&SH ,
530: .Sx \&SS ,
1.44 kristaps 531: and
1.45 kristaps 532: .Sx \&TP .
1.39 kristaps 533: .Ss \&PP
534: Synonym for
535: .Sx \&LP .
1.44 kristaps 536: .Pp
537: See also
1.45 kristaps 538: .Sx \&HP ,
539: .Sx \&IP ,
540: .Sx \&LP ,
541: .Sx \&P ,
1.44 kristaps 542: and
1.45 kristaps 543: .Sx \&TP .
1.39 kristaps 544: .Ss \&RB
1.22 kristaps 545: Text is rendered alternately in roman (the default font) and bold face.
546: Whitespace between arguments is omitted in output.
1.44 kristaps 547: .Pp
548: See
549: .Sx \&BI
550: for an equivalent example.
551: .Pp
552: See also
553: .Sx \&BI ,
554: .Sx \&IB ,
555: .Sx \&BR ,
556: .Sx \&RI ,
557: and
558: .Sx \&IR .
1.39 kristaps 559: .Ss \&RE
1.30 kristaps 560: Explicitly close out the scope of a prior
1.39 kristaps 561: .Sx \&RS .
1.129 schwarze 562: The default left margin is restored to the state before that
1.102 kristaps 563: .Sx \&RS
564: invocation.
1.129 schwarze 565: .Pp
566: The syntax is as follows:
567: .Bd -filled -offset indent
568: .Pf \. Sx \&RE
569: .Op Ar level
570: .Ed
571: .Pp
572: Without an argument, the most recent
573: .Sx \&RS
574: block is closed out.
575: If
576: .Ar level
577: is 1, all open
578: .Sx \&RS
579: blocks are closed out.
580: Otherwise,
581: .Ar level No \(mi 1
582: nested
583: .Sx \&RS
584: blocks remain open.
1.39 kristaps 585: .Ss \&RI
1.22 kristaps 586: Text is rendered alternately in roman (the default font) and italics.
587: Whitespace between arguments is omitted in output.
1.44 kristaps 588: .Pp
589: See
590: .Sx \&BI
591: for an equivalent example.
592: .Pp
593: See also
594: .Sx \&BI ,
595: .Sx \&IB ,
596: .Sx \&BR ,
597: .Sx \&RB ,
598: and
599: .Sx \&IR .
1.39 kristaps 600: .Ss \&RS
1.102 kristaps 601: Temporarily reset the default left margin.
1.44 kristaps 602: This has the following syntax:
603: .Bd -filled -offset indent
1.102 kristaps 604: .Pf \. Sx \&RS
1.130 schwarze 605: .Op Ar width
1.32 kristaps 606: .Ed
1.44 kristaps 607: .Pp
608: The
1.130 schwarze 609: .Ar width
1.117 schwarze 610: argument is a
611: .Xr roff 7
612: scaling width.
1.55 kristaps 613: If not specified, the saved or default width is used.
1.102 kristaps 614: .Pp
615: See also
616: .Sx \&RE .
1.39 kristaps 617: .Ss \&SB
1.22 kristaps 618: Text is rendered in small size (one point smaller than the default font)
619: bold face.
1.39 kristaps 620: .Ss \&SH
1.68 kristaps 621: Begin a section.
622: The scope of a section is only closed by another section or the end of
623: file.
1.78 schwarze 624: The paragraph left-margin width is reset to the default.
1.39 kristaps 625: .Ss \&SM
1.22 kristaps 626: Text is rendered in small size (one point smaller than the default
627: font).
1.39 kristaps 628: .Ss \&SS
1.68 kristaps 629: Begin a sub-section.
630: The scope of a sub-section is closed by a subsequent sub-section,
631: section, or end of file.
1.78 schwarze 632: The paragraph left-margin width is reset to the default.
1.39 kristaps 633: .Ss \&TH
1.128 schwarze 634: Sets the title of the manual page for use in the page header
635: and footer with the following syntax:
1.44 kristaps 636: .Bd -filled -offset indent
637: .Pf \. Sx \&TH
1.99 schwarze 638: .Ar title section date
639: .Op Ar source Op Ar volume
1.44 kristaps 640: .Ed
1.43 kristaps 641: .Pp
1.99 schwarze 642: Conventionally, the document
643: .Ar title
644: is given in all caps.
645: The recommended
646: .Ar date
647: format is
648: .Sy YYYY-MM-DD
649: as specified in the ISO-8601 standard;
650: if the argument does not conform, it is printed verbatim.
651: If the
652: .Ar date
653: is empty or not specified, the current date is used.
654: The optional
655: .Ar source
1.68 kristaps 656: string specifies the organisation providing the utility.
1.128 schwarze 657: When unspecified,
658: .Xr mandoc 1
659: uses its
660: .Fl Ios
661: argument.
1.68 kristaps 662: The
1.99 schwarze 663: .Ar volume
1.43 kristaps 664: string replaces the default rendered volume, which is dictated by the
665: manual section.
666: .Pp
667: Examples:
1.46 kristaps 668: .Pp
1.93 kristaps 669: .Dl \&.TH CVS 5 "1992-02-12" GNU
1.39 kristaps 670: .Ss \&TP
1.25 kristaps 671: Begin a paragraph where the head, if exceeding the indentation width, is
1.24 kristaps 672: followed by a newline; if not, the body follows on the same line after a
1.68 kristaps 673: buffer to the indentation width.
674: Subsequent output lines are indented.
1.44 kristaps 675: The syntax is as follows:
676: .Bd -filled -offset indent
677: .Pf \. Sx \&TP
1.130 schwarze 678: .Op Ar width
1.32 kristaps 679: .Ed
680: .Pp
1.44 kristaps 681: The
1.130 schwarze 682: .Ar width
1.117 schwarze 683: argument is a
684: .Xr roff 7
685: scaling width.
1.44 kristaps 686: If specified, it's saved for later paragraph left-margins; if
1.27 kristaps 687: unspecified, the saved or default width is used.
1.44 kristaps 688: .Pp
689: See also
1.45 kristaps 690: .Sx \&HP ,
691: .Sx \&IP ,
692: .Sx \&LP ,
693: .Sx \&P ,
1.44 kristaps 694: and
1.45 kristaps 695: .Sx \&PP .
1.138 ! schwarze 696: .Ss \&TQ
! 697: Like
! 698: .Sx \&TP ,
! 699: except that no vertical spacing is inserted before the paragraph.
! 700: This is a non-standard GNU extension and rarely used even by GNU
! 701: manual pages.
1.72 joerg 702: .Ss \&UC
703: Sets the volume for the footer for compatibility with man pages from
1.120 schwarze 704: .Bx
705: releases.
1.72 joerg 706: The optional first argument specifies which release it is from.
1.121 schwarze 707: .Ss \&UE
708: End a uniform resource identifier block.
709: This is a non-standard GNU extension, included only for compatibility.
710: See
711: .Sx \&UE .
712: .Ss \&UR
713: Begin a uniform resource identifier block.
714: This is a non-standard GNU extension, included only for compatibility.
715: It has the following syntax:
716: .Bd -literal -offset indent
717: .Pf \. Sx \&UR Ar uri
718: link description to be shown
719: .Pf \. Sx UE
720: .Ed
1.39 kristaps 721: .Ss \&fi
1.22 kristaps 722: End literal mode begun by
1.39 kristaps 723: .Sx \&nf .
1.79 kristaps 724: .Ss \&in
725: Indent relative to the current indentation:
726: .Pp
1.130 schwarze 727: .D1 Pf \. Sx \&in Op Ar width
1.79 kristaps 728: .Pp
729: If
1.130 schwarze 730: .Ar width
1.79 kristaps 731: is signed, the new offset is relative.
732: Otherwise, it is absolute.
733: This value is reset upon the next paragraph, section, or sub-section.
1.39 kristaps 734: .Ss \&nf
1.22 kristaps 735: Begin literal mode: all subsequent free-form lines have their end of
1.68 kristaps 736: line boundaries preserved.
737: May be ended by
1.39 kristaps 738: .Sx \&fi .
1.101 kristaps 739: Literal mode is implicitly ended by
740: .Sx \&SH
741: or
742: .Sx \&SS .
1.111 schwarze 743: .Sh MACRO SYNTAX
744: The
745: .Nm
746: macros are classified by scope: line scope or block scope.
747: Line macros are only scoped to the current line (and, in some
748: situations, the subsequent line).
749: Block macros are scoped to the current line and subsequent lines until
750: closed by another block macro.
751: .Ss Line Macros
752: Line macros are generally scoped to the current line, with the body
753: consisting of zero or more arguments.
754: If a macro is scoped to the next line and the line arguments are empty,
755: the next line, which must be text, is used instead.
756: Thus:
757: .Bd -literal -offset indent
758: \&.I
759: foo
760: .Ed
761: .Pp
762: is equivalent to
763: .Sq \&.I foo .
764: If next-line macros are invoked consecutively, only the last is used.
765: If a next-line macro is followed by a non-next-line macro, an error is
1.134 schwarze 766: raised.
1.111 schwarze 767: .Pp
768: The syntax is as follows:
769: .Bd -literal -offset indent
770: \&.YO \(lBbody...\(rB
771: \(lBbody...\(rB
772: .Ed
773: .Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent
774: .It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes
775: .It Sx \&AT Ta <=1 Ta current Ta \&
776: .It Sx \&B Ta n Ta next-line Ta \&
777: .It Sx \&BI Ta n Ta current Ta \&
778: .It Sx \&BR Ta n Ta current Ta \&
779: .It Sx \&DT Ta 0 Ta current Ta \&
1.121 schwarze 780: .It Sx \&EE Ta 0 Ta current Ta compat
781: .It Sx \&EX Ta 0 Ta current Ta compat
1.111 schwarze 782: .It Sx \&I Ta n Ta next-line Ta \&
783: .It Sx \&IB Ta n Ta current Ta \&
784: .It Sx \&IR Ta n Ta current Ta \&
1.113 kristaps 785: .It Sx \&OP Ta 0, 1 Ta current Ta compat
1.121 schwarze 786: .It Sx \&PD Ta 1 Ta current Ta \&
1.111 schwarze 787: .It Sx \&RB Ta n Ta current Ta \&
788: .It Sx \&RI Ta n Ta current Ta \&
789: .It Sx \&SB Ta n Ta next-line Ta \&
790: .It Sx \&SM Ta n Ta next-line Ta \&
791: .It Sx \&TH Ta >1, <6 Ta current Ta \&
792: .It Sx \&UC Ta <=1 Ta current Ta \&
793: .It Sx \&fi Ta 0 Ta current Ta compat
794: .It Sx \&in Ta 1 Ta current Ta compat
795: .It Sx \&nf Ta 0 Ta current Ta compat
796: .El
797: .Pp
798: Macros marked as
799: .Qq compat
800: are included for compatibility with the significant corpus of existing
801: manuals that mix dialects of roff.
802: These macros should not be used for portable
803: .Nm
804: manuals.
805: .Ss Block Macros
806: Block macros comprise a head and body.
807: As with in-line macros, the head is scoped to the current line and, in
808: one circumstance, the next line (the next-line stipulations as in
809: .Sx Line Macros
810: apply here as well).
811: .Pp
812: The syntax is as follows:
813: .Bd -literal -offset indent
814: \&.YO \(lBhead...\(rB
815: \(lBhead...\(rB
816: \(lBbody...\(rB
817: .Ed
818: .Pp
819: The closure of body scope may be to the section, where a macro is closed
820: by
821: .Sx \&SH ;
822: sub-section, closed by a section or
823: .Sx \&SS ;
824: part, closed by a section, sub-section, or
825: .Sx \&RE ;
826: or paragraph, closed by a section, sub-section, part,
827: .Sx \&HP ,
828: .Sx \&IP ,
829: .Sx \&LP ,
830: .Sx \&P ,
831: .Sx \&PP ,
832: or
833: .Sx \&TP .
834: No closure refers to an explicit block closing macro.
835: .Pp
836: As a rule, block macros may not be nested; thus, calling a block macro
837: while another block macro scope is open, and the open scope is not
838: implicitly closed, is syntactically incorrect.
839: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent
840: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes
841: .It Sx \&HP Ta <2 Ta current Ta paragraph Ta \&
842: .It Sx \&IP Ta <3 Ta current Ta paragraph Ta \&
843: .It Sx \&LP Ta 0 Ta current Ta paragraph Ta \&
844: .It Sx \&P Ta 0 Ta current Ta paragraph Ta \&
845: .It Sx \&PP Ta 0 Ta current Ta paragraph Ta \&
846: .It Sx \&RE Ta 0 Ta current Ta none Ta compat
847: .It Sx \&RS Ta 1 Ta current Ta part Ta compat
848: .It Sx \&SH Ta >0 Ta next-line Ta section Ta \&
849: .It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \&
850: .It Sx \&TP Ta n Ta next-line Ta paragraph Ta \&
1.121 schwarze 851: .It Sx \&UE Ta 0 Ta current Ta none Ta compat
852: .It Sx \&UR Ta 1 Ta current Ta part Ta compat
1.111 schwarze 853: .El
854: .Pp
855: Macros marked
856: .Qq compat
857: are as mentioned in
858: .Sx Line Macros .
859: .Pp
860: If a block macro is next-line scoped, it may only be followed by in-line
861: macros for decorating text.
862: .Ss Font handling
863: In
864: .Nm
865: documents, both
866: .Sx Physical markup
867: macros and
868: .Xr roff 7
869: .Ql \ef
870: font escape sequences can be used to choose fonts.
871: In text lines, the effect of manual font selection by escape sequences
872: only lasts until the next macro invocation; in macro lines, it only lasts
873: until the end of the macro scope.
874: Note that macros like
875: .Sx \&BR
876: open and close a font scope for each argument.
1.1 kristaps 877: .Sh SEE ALSO
1.89 schwarze 878: .Xr man 1 ,
1.32 kristaps 879: .Xr mandoc 1 ,
1.98 kristaps 880: .Xr eqn 7 ,
1.89 schwarze 881: .Xr mandoc_char 7 ,
1.94 kristaps 882: .Xr mdoc 7 ,
883: .Xr roff 7 ,
884: .Xr tbl 7
1.78 schwarze 885: .Sh HISTORY
886: The
887: .Nm
888: language first appeared as a macro package for the roff typesetting
889: system in
890: .At v7 .
891: It was later rewritten by James Clark as a macro package for groff.
1.113 kristaps 892: Eric S. Raymond wrote the extended
893: .Nm
894: macros for groff in 2007.
1.78 schwarze 895: The stand-alone implementation that is part of the
896: .Xr mandoc 1
897: utility written by Kristaps Dzonsons appeared in
1.80 kristaps 898: .Ox 4.6 .
1.1 kristaps 899: .Sh AUTHORS
1.78 schwarze 900: This
1.32 kristaps 901: .Nm
1.23 kristaps 902: reference was written by
1.119 schwarze 903: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.1 kristaps 904: .Sh CAVEATS
1.68 kristaps 905: Do not use this language.
906: Use
1.32 kristaps 907: .Xr mdoc 7 ,
1.1 kristaps 908: instead.
CVSweb