Annotation of src/usr.bin/mandoc/man.7, Revision 1.14
1.14 ! schwarze 1: .\" $Id: man.7,v 1.13 2009/10/27 21:40:07 schwarze Exp $
1.1 kristaps 2: .\"
1.2 schwarze 3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: .\"
1.14 ! schwarze 17: .Dd $Mdocdate: October 27 2009 $
1.2 schwarze 18: .Dt MAN 7
1.1 kristaps 19: .Os
1.9 schwarze 20: .
21: .
1.1 kristaps 22: .Sh NAME
1.10 schwarze 23: .Nm man
24: .Nd man language reference
1.9 schwarze 25: .
26: .
1.1 kristaps 27: .Sh DESCRIPTION
28: The
1.10 schwarze 29: .Nm man
1.7 schwarze 30: language was historically used to format
1.10 schwarze 31: .Ux
1.6 schwarze 32: manuals. This reference document describes its syntax, structure, and
33: usage.
1.10 schwarze 34: .
35: .Pp
36: .Bf -emphasis
1.7 schwarze 37: Do not use
1.10 schwarze 38: .Nm
1.7 schwarze 39: to write your manuals.
1.10 schwarze 40: .Ef
1.6 schwarze 41: Use the
1.10 schwarze 42: .Xr mdoc 7
1.1 kristaps 43: language, instead.
1.10 schwarze 44: .
45: .Pp
1.1 kristaps 46: An
1.10 schwarze 47: .Nm
1.1 kristaps 48: document follows simple rules: lines beginning with the control
1.7 schwarze 49: character
1.10 schwarze 50: .Sq \&.
1.1 kristaps 51: are parsed for macros. Other lines are interpreted within the scope of
52: prior macros:
1.10 schwarze 53: .Bd -literal -offset indent
1.1 kristaps 54: \&.SH Macro lines change control state.
55: Other lines are interpreted within the current state.
1.10 schwarze 56: .Ed
1.9 schwarze 57: .
58: .
1.1 kristaps 59: .Sh INPUT ENCODING
1.10 schwarze 60: .Nm
1.4 schwarze 61: documents may contain only graphable 7-bit ASCII characters, the
1.6 schwarze 62: space character, and the tabs character. All manuals must have
1.10 schwarze 63: .Ux
1.7 schwarze 64: line termination.
1.10 schwarze 65: .
66: .Pp
1.1 kristaps 67: Blank lines are acceptable; where found, the output will assert a
68: vertical space.
1.10 schwarze 69: .
70: .Pp
1.1 kristaps 71: The
1.10 schwarze 72: .Sq \ec
1.1 kristaps 73: escape is common in historical
1.10 schwarze 74: .Nm
1.1 kristaps 75: documents; if encountered at the end of a word, it ensures that the
76: subsequent word isn't off-set by whitespace.
1.9 schwarze 77: .
78: .
1.10 schwarze 79: .Ss Comments
1.8 schwarze 80: Text following a
1.10 schwarze 81: .Sq \e\*" ,
1.8 schwarze 82: whether in a macro or free-form text line, is ignored to the end of
83: line. A macro line with only a control character and comment escape,
1.10 schwarze 84: .Sq \&.\e" ,
1.14 ! schwarze 85: is also ignored. Macro lines with only a control character and
1.9 schwarze 86: optionally whitespace are stripped from input.
87: .
88: .
1.10 schwarze 89: .Ss Special Characters
1.8 schwarze 90: Special characters may occur in both macro and free-form lines.
91: Sequences begin with the escape character
1.10 schwarze 92: .Sq \e
1.7 schwarze 93: followed by either an open-parenthesis
1.10 schwarze 94: .Sq \&(
1.1 kristaps 95: for two-character sequences; an open-bracket
1.10 schwarze 96: .Sq \&[
1.1 kristaps 97: for n-character sequences (terminated at a close-bracket
1.10 schwarze 98: .Sq \&] ) ;
1.8 schwarze 99: or a single one-character sequence. See
1.10 schwarze 100: .Xr mandoc_char 7
1.8 schwarze 101: for a complete list. Examples include
1.10 schwarze 102: .Sq \e(em
103: .Pq em-dash
1.8 schwarze 104: and
1.10 schwarze 105: .Sq \ee
106: .Pq back-slash .
1.9 schwarze 107: .
108: .
1.10 schwarze 109: .Ss Text Decoration
1.8 schwarze 110: Terms may be text-decorated using the
1.10 schwarze 111: .Sq \ef
1.8 schwarze 112: escape followed by an indicator: B (bold), I, (italic), or P and R
113: (Roman, or reset).
1.9 schwarze 114: .
115: .
1.10 schwarze 116: .Ss Whitespace
1.5 schwarze 117: Unless specifically escaped, consecutive blocks of whitespace are pruned
118: from input. These are later re-added, if applicable, by a front-end
119: utility such as
1.10 schwarze 120: .Xr mandoc 1 .
1.9 schwarze 121: .
1.14 ! schwarze 122: .
! 123: .Ss Dates
! 124: The
! 125: .Sx \&TH
! 126: macro is the only
! 127: .Nm
! 128: macro that requires a date. The form for this date is the ISO-8601
! 129: standard
! 130: .Cm YYYY-MM-DD .
! 131: .
! 132: .
1.12 schwarze 133: .Ss Scaling Widths
134: Many macros support scaled widths for their arguments, such as
135: stipulating a two-inch paragraph indentation with the following:
136: .Bd -literal -offset indent
137: \&.HP 2i
138: .Ed
139: .
140: .Pp
141: The syntax for scaled widths is
142: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,
143: where a decimal must be preceded or proceeded by at least one digit.
144: Negative numbers, while accepted, are truncated to zero. The following
145: scaling units are accepted:
146: .
147: .Pp
148: .Bl -tag -width Ds -offset indent -compact
149: .It c
150: centimetre
151: .It i
152: inch
153: .It P
154: pica (~1/6 inch)
155: .It p
156: point (~1/72 inch)
157: .It f
158: synonym for
159: .Sq u
160: .It v
161: default vertical span
162: .It m
163: width of rendered
164: .Sq m
165: .Pq em
166: character
167: .It n
168: width of rendered
169: .Sq n
170: .Pq en
171: character
172: .It u
173: default horizontal span
174: .It M
175: mini-em (~1/100 em)
176: .El
177: .Pp
178: Using anything other than
179: .Sq m ,
180: .Sq n ,
181: .Sq u ,
182: or
183: .Sq v
1.14 ! schwarze 184: is necessarily non-portable across output media.
1.12 schwarze 185: .
186: .Pp
187: If a scaling unit is not provided, the numerical value is interpreted
188: under the default rules of
189: .Sq v
190: for vertical spaces and
191: .Sq u
192: for horizontal ones.
193: .Em Note :
194: this differs from
195: .Xr mdoc 7 ,
196: which, if a unit is not provided, will instead interpret the string as
197: literal text.
198: .
1.9 schwarze 199: .
200: .Sh MANUAL STRUCTURE
1.5 schwarze 201: Each
1.10 schwarze 202: .Nm
1.5 schwarze 203: document must contain contains at least the
1.12 schwarze 204: .Sx \&TH
1.5 schwarze 205: macro describing the document's section and title. It may occur
206: anywhere in the document, although conventionally, it appears as the
207: first macro.
1.10 schwarze 208: .
209: .Pp
1.9 schwarze 210: Beyond
1.12 schwarze 211: .Sx \&TH ,
1.9 schwarze 212: at least one macro or text node must appear in the document. Documents
213: are generally structured as follows:
1.10 schwarze 214: .Bd -literal -offset indent
1.14 ! schwarze 215: \&.TH FOO 1 2009-10-10
1.9 schwarze 216: \&.
217: \&.SH NAME
1.10 schwarze 218: \efBfoo\efR \e(en a description goes here
219: \&.\e\*q The next is for sections 2 & 3 only.
220: \&.\e\*q .SH LIBRARY
1.9 schwarze 221: \&.
222: \&.SH SYNOPSIS
223: \efBfoo\efR [\efB\e-options\efR] arguments...
224: \&.
225: \&.SH DESCRIPTION
1.10 schwarze 226: The \efBfoo\efR utility processes files...
1.9 schwarze 227: \&.
1.10 schwarze 228: \&.\e\*q .SH IMPLEMENTATION NOTES
229: \&.\e\*q The next is for sections 1 & 8 only.
230: \&.\e\*q .SH EXIT STATUS
231: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.9 schwarze 232: \&.\e\*q .SH RETURN VALUES
1.10 schwarze 233: \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
1.9 schwarze 234: \&.\e\*q .SH ENVIRONMENT
235: \&.\e\*q .SH FILES
236: \&.\e\*q .SH EXAMPLES
1.10 schwarze 237: \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
1.9 schwarze 238: \&.\e\*q .SH DIAGNOSTICS
1.10 schwarze 239: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.9 schwarze 240: \&.\e\*q .SH ERRORS
241: \&.\e\*q .SH SEE ALSO
1.14 ! schwarze 242: \&.\e\*q .BR foo ( 1 )
1.9 schwarze 243: \&.\e\*q .SH STANDARDS
244: \&.\e\*q .SH HISTORY
245: \&.\e\*q .SH AUTHORS
246: \&.\e\*q .SH CAVEATS
247: \&.\e\*q .SH BUGS
1.10 schwarze 248: \&.\e\*q .SH SECURITY CONSIDERATIONS
249: .Ed
1.13 schwarze 250: .Pp
251: The sections in a
252: .Nm
253: document are conventionally ordered as they appear above. Sections
254: should be composed as follows:
1.14 ! schwarze 255: .Bl -ohang -offset indent
! 256: .It Em NAME
1.13 schwarze 257: The name(s) and a short description of the documented material. The
258: syntax for this is generally as follows:
259: .Pp
260: .D1 \efBname\efR \e(en description
1.14 ! schwarze 261: .It Em LIBRARY
1.13 schwarze 262: The name of the library containing the documented material, which is
263: assumed to be a function in a section 2 or 3 manual. For functions in
264: the C library, this may be as follows:
265: .Pp
266: .D1 Standard C Library (libc, -lc)
1.14 ! schwarze 267: .It Em SYNOPSIS
1.13 schwarze 268: Documents the utility invocation syntax, function call syntax, or device
269: configuration.
270: .Pp
271: For the first, utilities (sections 1, 6, and 8), this is
272: generally structured as follows:
273: .Pp
274: .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
275: .Pp
276: For the second, function calls (sections 2, 3, 9):
277: .Pp
1.14 ! schwarze 278: .D1 \&.B char *name(char *\efIarg\efR);
1.13 schwarze 279: .Pp
280: And for the third, configurations (section 4):
281: .Pp
1.14 ! schwarze 282: .D1 \&.B name* at cardbus ? function ?
1.13 schwarze 283: .Pp
1.14 ! schwarze 284: Manuals not in these sections generally don't need a
! 285: .Em SYNOPSIS .
! 286: .It Em DESCRIPTION
! 287: This expands upon the brief, one-line description in
! 288: .Em NAME .
! 289: It usually contains a break-down of the options (if documenting a
! 290: command).
! 291: .It Em IMPLEMENTATION NOTES
1.13 schwarze 292: Implementation-specific notes should be kept here. This is useful when
293: implementing standard functions that may have side effects or notable
294: algorithmic implications.
1.14 ! schwarze 295: .It Em EXIT STATUS
! 296: Command exit status for section 1, 6, and 8 manuals. This section is
! 297: the dual of
! 298: .Em RETURN VALUES ,
! 299: which is used for functions. Historically, this information was
! 300: described in
! 301: .Em DIAGNOSTICS ,
! 302: a practise that is now discouraged.
! 303: .
! 304: .It Em RETURN VALUES
! 305: This section is the dual of
! 306: .Em EXIT STATUS ,
! 307: which is used for commands. It documents the return values of functions
! 308: in sections 2, 3, and 9.
! 309: .
! 310: .It Em ENVIRONMENT
! 311: Documents any usages of environment variables, e.g.,
! 312: .Xr environ 7 .
! 313: .
! 314: .It Em FILES
! 315: Documents files used. It's helpful to document both the file and a
! 316: short description of how the file is used (created, modified, etc.).
! 317: .
! 318: .It Em EXAMPLES
! 319: Example usages. This often contains snippets of well-formed,
! 320: well-tested invocations. Make doubly sure that your examples work
! 321: properly!
! 322: .
! 323: .It Em DIAGNOSTICS
! 324: Documents error conditions. This is most useful in section 4 manuals.
! 325: Historically, this section was used in place of
! 326: .Em EXIT STATUS
! 327: for manuals in sections 1, 6, and 8; however, this practise is
! 328: discouraged.
! 329: .
! 330: .It Em ERRORS
! 331: Documents error handling in sections 2, 3, and 9.
! 332: .
! 333: .It Em SEE ALSO
! 334: References other manuals with related topics. This section should exist
! 335: for most manuals.
! 336: .Pp
! 337: .D1 \&.BR bar \&( 1 \&),
! 338: .Pp
! 339: Cross-references should conventionally be ordered
! 340: first by section, then alphabetically.
! 341: .
! 342: .It Em STANDARDS
! 343: References any standards implemented or used, such as
! 344: .Pp
! 345: .D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
! 346: .Pp
! 347: If not adhering to any standards, the
! 348: .Em HISTORY
! 349: section should be used.
! 350: .
! 351: .It Em HISTORY
! 352: The history of any manual without a
! 353: .Em STANDARDS
! 354: section should be described in this section.
! 355: .
! 356: .It Em AUTHORS
! 357: Credits to authors, if applicable, should appear in this section.
! 358: Authors should generally be noted by both name and an e-mail address.
! 359: .
! 360: .It Em CAVEATS
! 361: Explanations of common misuses and misunderstandings should be explained
! 362: in this section.
! 363: .
! 364: .It Em BUGS
! 365: Extant bugs should be described in this section.
! 366: .
! 367: .It Em SECURITY CONSIDERATIONS
! 368: Documents any security precautions that operators should consider.
! 369: .
1.13 schwarze 370: .El
1.9 schwarze 371: .
372: .
373: .Sh MACRO SYNTAX
1.1 kristaps 374: Macros are one to three three characters in length and begin with a
375: control character ,
1.10 schwarze 376: .Sq \&. ,
1.1 kristaps 377: at the beginning of the line. An arbitrary amount of whitespace may
1.12 schwarze 378: sit between the control character and the macro name. Thus, the
379: following are equivalent:
380: .Bd -literal -offset indent
381: \&.PP
382: \&.\ \ \ PP
383: .Ed
1.10 schwarze 384: .
385: .Pp
1.1 kristaps 386: The
1.10 schwarze 387: .Nm
388: macros are classified by scope: line scope or block scope. Line
1.9 schwarze 389: macros are only scoped to the current line (and, in some situations,
390: the subsequent line). Block macros are scoped to the current line and
391: subsequent lines until closed by another block macro.
392: .
393: .
1.10 schwarze 394: .Ss Line Macros
395: Line macros are generally scoped to the current line, with the body
396: consisting of zero or more arguments. If a macro is scoped to the next
397: line and the line arguments are empty, the next line is used instead,
398: else the general syntax is used. Thus:
399: .Bd -literal -offset indent
400: \&.I
1.1 kristaps 401: foo
1.10 schwarze 402: .Ed
403: .
404: .Pp
1.7 schwarze 405: is equivalent to
1.10 schwarze 406: .Sq \&.I foo .
1.14 ! schwarze 407: If next-line macros are invoked consecutively, only the last is used; in
! 408: other words, if a next-line macro is preceded by a block macro, it is
! 409: ignored.
1.10 schwarze 410: .Bd -literal -offset indent
1.9 schwarze 411: \&.YO \(lBbody...\(rB
412: \(lBbody...\(rB
1.10 schwarze 413: .Ed
414: .
415: .Pp
416: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
417: .It Em Macro Ta Em Arguments Ta Em Scope
1.12 schwarze 418: .It Sx \&B Ta n Ta next-line
419: .It Sx \&BI Ta n Ta current
420: .It Sx \&BR Ta n Ta current
421: .It Sx \&DT Ta 0 Ta current
422: .It Sx \&I Ta n Ta next-line
423: .It Sx \&IB Ta n Ta current
424: .It Sx \&IR Ta n Ta current
1.13 schwarze 425: .It Sx \&PD Ta n Ta current
1.12 schwarze 426: .It Sx \&R Ta n Ta next-line
427: .It Sx \&RB Ta n Ta current
428: .It Sx \&RI Ta n Ta current
429: .It Sx \&SB Ta n Ta next-line
430: .It Sx \&SM Ta n Ta next-line
431: .It Sx \&TH Ta >1, <6 Ta current
432: .It Sx \&UC Ta n Ta current
433: .It Sx \&br Ta 0 Ta current
434: .It Sx \&fi Ta 0 Ta current
435: .It Sx \&i Ta n Ta current
436: .It Sx \&na Ta 0 Ta current
437: .It Sx \&nf Ta 0 Ta current
438: .It Sx \&r Ta 0 Ta current
439: .It Sx \&sp Ta 1 Ta current
1.10 schwarze 440: .El
441: .
442: .Pp
443: The
1.13 schwarze 444: .Sx \&PD ,
1.12 schwarze 445: .Sx \&RS ,
446: .Sx \&RE ,
447: .Sx \&UC ,
448: .Sx \&br ,
449: .Sx \&fi ,
450: .Sx \&i ,
451: .Sx \&na ,
452: .Sx \&nf ,
453: .Sx \&r ,
1.9 schwarze 454: and
1.12 schwarze 455: .Sx \&sp
1.11 schwarze 456: macros should not be used. They're included for compatibility.
1.9 schwarze 457: .
458: .
1.10 schwarze 459: .Ss Block Macros
460: Block macros are comprised of a head and body. Like for in-line macros,
461: the head is scoped to the current line and, in one circumstance, the
462: next line; the body is scoped to subsequent lines and is closed out by a
463: subsequent block macro invocation.
464: .Bd -literal -offset indent
1.9 schwarze 465: \&.YO \(lBhead...\(rB
466: \(lBhead...\(rB
467: \(lBbody...\(rB
1.10 schwarze 468: .Ed
469: .
470: .Pp
471: The closure of body scope may be to the section, where a macro is closed
472: by
1.12 schwarze 473: .Sx \&SH ;
1.10 schwarze 474: sub-section, closed by a section or
1.12 schwarze 475: .Sx \&SS ;
1.10 schwarze 476: part, closed by a section, sub-section, or
1.12 schwarze 477: .Sx \&RE ;
1.10 schwarze 478: or paragraph, closed by a section, sub-section, part,
1.12 schwarze 479: .Sx \&HP ,
480: .Sx \&IP ,
481: .Sx \&LP ,
482: .Sx \&P ,
483: .Sx \&PP ,
1.10 schwarze 484: or
1.12 schwarze 485: .Sx \&TP .
1.10 schwarze 486: No closure refers to an explicit block closing macro.
487: .
488: .Pp
489: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
490: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
1.12 schwarze 491: .It Sx \&HP Ta <2 Ta current Ta paragraph
492: .It Sx \&IP Ta <3 Ta current Ta paragraph
493: .It Sx \&LP Ta 0 Ta current Ta paragraph
494: .It Sx \&P Ta 0 Ta current Ta paragraph
495: .It Sx \&PP Ta 0 Ta current Ta paragraph
496: .It Sx \&RE Ta 0 Ta current Ta none
497: .It Sx \&RS Ta 1 Ta current Ta part
498: .It Sx \&SH Ta >0 Ta next-line Ta section
499: .It Sx \&SS Ta >0 Ta next-line Ta sub-section
500: .It Sx \&TP Ta n Ta next-line Ta paragraph
1.10 schwarze 501: .El
502: .
503: .Pp
1.9 schwarze 504: If a block macro is next-line scoped, it may only be followed by in-line
505: macros (excluding
1.12 schwarze 506: .Sx \&DT ,
1.13 schwarze 507: .Sx \&PD ,
1.12 schwarze 508: .Sx \&TH ,
509: .Sx \&UC ,
510: .Sx \&br ,
511: .Sx \&na ,
512: .Sx \&sp ,
513: .Sx \&nf ,
1.9 schwarze 514: and
1.12 schwarze 515: .Sx \&fi ) .
1.9 schwarze 516: .
517: .
518: .Sh REFERENCE
519: This section is a canonical reference to all macros, arranged
520: alphabetically. For the scoping of individual macros, see
1.10 schwarze 521: .Sx MACRO SYNTAX .
1.9 schwarze 522: .
1.14 ! schwarze 523: .
1.12 schwarze 524: .Ss \&B
1.9 schwarze 525: Text is rendered in bold face.
1.14 ! schwarze 526: .Pp
! 527: See also
! 528: .Sx \&I ,
! 529: .Sx \&R ,
! 530: .Sx \&b ,
! 531: .Sx \&i ,
! 532: and
! 533: .Sx \&r .
! 534: .
! 535: .
1.12 schwarze 536: .Ss \&BI
1.9 schwarze 537: Text is rendered alternately in bold face and italic. Thus,
1.10 schwarze 538: .Sq .BI this word and that
1.9 schwarze 539: causes
1.10 schwarze 540: .Sq this
1.9 schwarze 541: and
1.10 schwarze 542: .Sq and
1.9 schwarze 543: to render in bold face, while
1.10 schwarze 544: .Sq word
1.9 schwarze 545: and
1.10 schwarze 546: .Sq that
1.9 schwarze 547: render in italics. Whitespace between arguments is omitted in output.
1.14 ! schwarze 548: .Pp
! 549: Examples:
! 550: .Pp
! 551: .D1 \&.BI bold italic bold italic
! 552: .Pp
! 553: The output of this example will be emboldened
! 554: .Dq bold
! 555: and italicised
! 556: .Dq italic ,
! 557: with spaces stripped between arguments.
! 558: .Pp
! 559: See also
! 560: .Sx \&IB ,
! 561: .Sx \&BR ,
! 562: .Sx \&RB ,
! 563: .Sx \&RI ,
! 564: and
! 565: .Sx \&IR .
! 566: .
! 567: .
1.12 schwarze 568: .Ss \&BR
1.9 schwarze 569: Text is rendered alternately in bold face and roman (the default font).
570: Whitespace between arguments is omitted in output.
1.14 ! schwarze 571: .Pp
! 572: See
! 573: .Sx \&BI
! 574: for an equivalent example.
! 575: .Pp
! 576: See also
! 577: .Sx \&BI ,
! 578: .Sx \&IB ,
! 579: .Sx \&RB ,
! 580: .Sx \&RI ,
! 581: and
! 582: .Sx \&IR .
! 583: .
! 584: .
1.12 schwarze 585: .Ss \&DT
1.11 schwarze 586: Has no effect. Included for compatibility.
1.14 ! schwarze 587: .
! 588: .
1.12 schwarze 589: .Ss \&HP
1.9 schwarze 590: Begin a paragraph whose initial output line is left-justified, but
591: subsequent output lines are indented, with the following syntax:
1.14 ! schwarze 592: .Bd -filled -offset indent
! 593: .Pf \. Sx \&HP
! 594: .Op Cm width
1.10 schwarze 595: .Ed
1.14 ! schwarze 596: .Pp
! 597: The
! 598: .Cm width
! 599: argument must conform to
! 600: .Sx Scaling Widths .
! 601: If specified, it's saved for later paragraph left-margins; if unspecified, the
! 602: saved or default width is used.
! 603: .Pp
! 604: See also
! 605: .Sx \&IP ,
! 606: .Sx \&LP ,
! 607: .Sx \&P ,
! 608: .Sx \&PP ,
! 609: and
! 610: .Sx \&TP .
! 611: .
1.10 schwarze 612: .
1.12 schwarze 613: .Ss \&I
1.9 schwarze 614: Text is rendered in italics.
1.14 ! schwarze 615: .Pp
! 616: See also
! 617: .Sx \&B ,
! 618: .Sx \&R ,
! 619: .Sx \&b ,
! 620: .Sx \&i ,
! 621: and
! 622: .Sx \&r .
! 623: .
! 624: .
1.12 schwarze 625: .Ss \&IB
1.9 schwarze 626: Text is rendered alternately in italics and bold face. Whitespace
627: between arguments is omitted in output.
1.14 ! schwarze 628: .Pp
! 629: See
! 630: .Sx \&BI
! 631: for an equivalent example.
! 632: .Pp
! 633: See also
! 634: .Sx \&BI ,
! 635: .Sx \&BR ,
! 636: .Sx \&RB ,
! 637: .Sx \&RI ,
! 638: and
! 639: .Sx \&IR .
! 640: .
! 641: .
1.12 schwarze 642: .Ss \&IP
1.14 ! schwarze 643: Begin an indented paragraph with the following syntax:
! 644: .Bd -filled -offset indent
! 645: .Pf \. Sx \&IP
! 646: .Op Cm head Op Cm width
1.10 schwarze 647: .Ed
1.14 ! schwarze 648: .Pp
! 649: The
! 650: .Cm width
! 651: argument defines the width of the left margin and is defined by
! 652: .Sx Scaling Widths ,
! 653: It's saved for later paragraph left-margins; if unspecified, the saved or
! 654: default width is used.
! 655: .Pp
! 656: The
! 657: .Cm head
! 658: argument is used as a leading term, flushed to the left margin. This is
! 659: useful for bulleted paragraphs and so on.
! 660: .Pp
! 661: See also
! 662: .Sx \&HP ,
! 663: .Sx \&LP ,
! 664: .Sx \&P ,
! 665: .Sx \&PP ,
! 666: and
! 667: .Sx \&TP .
! 668: .
1.10 schwarze 669: .
1.12 schwarze 670: .Ss \&IR
1.9 schwarze 671: Text is rendered alternately in italics and roman (the default font).
672: Whitespace between arguments is omitted in output.
1.14 ! schwarze 673: .Pp
! 674: See
! 675: .Sx \&BI
! 676: for an equivalent example.
! 677: .Pp
! 678: See also
! 679: .Sx \&BI ,
! 680: .Sx \&IB ,
! 681: .Sx \&BR ,
! 682: .Sx \&RB ,
! 683: and
! 684: .Sx \&RI .
! 685: .
! 686: .
1.12 schwarze 687: .Ss \&LP
1.9 schwarze 688: Begin an undecorated paragraph. The scope of a paragraph is closed by a
689: subsequent paragraph, sub-section, section, or end of file. The saved
690: paragraph left-margin width is re-set to the default.
1.14 ! schwarze 691: .Pp
! 692: See also
! 693: .Sx \&HP ,
! 694: .Sx \&IP ,
! 695: .Sx \&P ,
! 696: .Sx \&PP ,
! 697: and
! 698: .Sx \&TP .
! 699: .
! 700: .
1.12 schwarze 701: .Ss \&P
702: Synonym for
703: .Sx \&LP .
1.14 ! schwarze 704: .Pp
! 705: See also
! 706: .Sx \&HP ,
! 707: .Sx \&IP ,
! 708: .Sx \&LP ,
! 709: .Sx \&PP ,
! 710: and
! 711: .Sx \&TP .
! 712: .
! 713: .
1.12 schwarze 714: .Ss \&PP
715: Synonym for
716: .Sx \&LP .
1.14 ! schwarze 717: .Pp
! 718: See also
! 719: .Sx \&HP ,
! 720: .Sx \&IP ,
! 721: .Sx \&LP ,
! 722: .Sx \&P ,
! 723: and
! 724: .Sx \&TP .
! 725: .
! 726: .
1.12 schwarze 727: .Ss \&R
1.9 schwarze 728: Text is rendered in roman (the default font).
1.14 ! schwarze 729: .Pp
! 730: See also
! 731: .Sx \&I ,
! 732: .Sx \&B ,
! 733: .Sx \&b ,
! 734: .Sx \&i ,
! 735: and
! 736: .Sx \&r .
! 737: .
! 738: .
1.12 schwarze 739: .Ss \&RB
1.9 schwarze 740: Text is rendered alternately in roman (the default font) and bold face.
741: Whitespace between arguments is omitted in output.
1.14 ! schwarze 742: .Pp
! 743: See
! 744: .Sx \&BI
! 745: for an equivalent example.
! 746: .Pp
! 747: See also
! 748: .Sx \&BI ,
! 749: .Sx \&IB ,
! 750: .Sx \&BR ,
! 751: .Sx \&RI ,
! 752: and
! 753: .Sx \&IR .
! 754: .
! 755: .
1.12 schwarze 756: .Ss \&RE
1.10 schwarze 757: Explicitly close out the scope of a prior
1.12 schwarze 758: .Sx \&RS .
1.14 ! schwarze 759: .
! 760: .
1.12 schwarze 761: .Ss \&RI
1.9 schwarze 762: Text is rendered alternately in roman (the default font) and italics.
763: Whitespace between arguments is omitted in output.
1.14 ! schwarze 764: .Pp
! 765: See
! 766: .Sx \&BI
! 767: for an equivalent example.
! 768: .Pp
! 769: See also
! 770: .Sx \&BI ,
! 771: .Sx \&IB ,
! 772: .Sx \&BR ,
! 773: .Sx \&RB ,
! 774: and
! 775: .Sx \&IR .
! 776: .
! 777: .
1.12 schwarze 778: .Ss \&RS
1.10 schwarze 779: Begin a part setting the left margin. The left margin controls the
780: offset, following an initial indentation, to un-indented text such as
781: that of
1.12 schwarze 782: .Sx \&PP .
1.14 ! schwarze 783: This has the following syntax:
! 784: .Bd -filled -offset indent
! 785: .Pf \. Sx \&Rs
! 786: .Op Cm width
1.10 schwarze 787: .Ed
1.14 ! schwarze 788: .Pp
! 789: The
! 790: .Cm width
! 791: argument must conform to
! 792: .Sx Scaling Widths .
! 793: If not specified, the saved or default width is used.
! 794: .
1.10 schwarze 795: .
1.12 schwarze 796: .Ss \&SB
1.9 schwarze 797: Text is rendered in small size (one point smaller than the default font)
798: bold face.
1.14 ! schwarze 799: .
! 800: .
1.12 schwarze 801: .Ss \&SH
1.9 schwarze 802: Begin a section. The scope of a section is only closed by another
803: section or the end of file. The paragraph left-margin width is re-set
804: to the default.
1.14 ! schwarze 805: .
! 806: .
1.12 schwarze 807: .Ss \&SM
1.9 schwarze 808: Text is rendered in small size (one point smaller than the default
809: font).
1.14 ! schwarze 810: .
! 811: .
1.12 schwarze 812: .Ss \&SS
1.9 schwarze 813: Begin a sub-section. The scope of a sub-section is closed by a
814: subsequent sub-section, section, or end of file. The paragraph
815: left-margin width is re-set to the default.
1.14 ! schwarze 816: .
! 817: .
1.12 schwarze 818: .Ss \&TH
1.9 schwarze 819: Sets the title of the manual page with the following syntax:
1.14 ! schwarze 820: .Bd -filled -offset indent
! 821: .Pf \. Sx \&TH
! 822: .Cm title section
! 823: .Op Cm date Op Cm source Op Cm volume
1.10 schwarze 824: .Ed
825: .Pp
1.14 ! schwarze 826: At least the upper-case document title
! 827: .Cm title
! 828: and numeric manual section
! 829: .Cm section
1.9 schwarze 830: arguments must be provided. The
1.14 ! schwarze 831: .Cm date
! 832: argument should be formatted as described in
! 833: .Sx Dates :
! 834: if it does not conform, the current date is used instead. The
! 835: .Cm source
1.9 schwarze 836: string specifies the organisation providing the utility. The
1.14 ! schwarze 837: .Cm volume
! 838: string replaces the default rendered volume, which is dictated by the
! 839: manual section.
! 840: .Pp
! 841: Examples:
! 842: .Pp
! 843: .D1 \&.TH CVS 5 "1992-02-12" GNU
! 844: .
! 845: .
1.12 schwarze 846: .Ss \&TP
1.9 schwarze 847: Begin a paragraph where the head, if exceeding the indentation width, is
848: followed by a newline; if not, the body follows on the same line after a
849: buffer to the indentation width. Subsequent output lines are indented.
1.14 ! schwarze 850: The syntax is as follows:
! 851: .Bd -filled -offset indent
! 852: .Pf \. Sx \&TP
! 853: .Op Cm width
1.10 schwarze 854: .Ed
855: .Pp
1.14 ! schwarze 856: The
! 857: .Cm width
! 858: argument must conform to
! 859: .Sx Scaling Widths .
! 860: If specified, it's saved for later paragraph left-margins; if
1.9 schwarze 861: unspecified, the saved or default width is used.
1.14 ! schwarze 862: .Pp
! 863: See also
! 864: .Sx \&HP ,
! 865: .Sx \&IP ,
! 866: .Sx \&LP ,
! 867: .Sx \&P ,
! 868: and
! 869: .Sx \&PP .
! 870: .
! 871: .
1.13 schwarze 872: .Ss \&PD
873: Has no effect. Included for compatibility.
1.14 ! schwarze 874: .
! 875: .
1.12 schwarze 876: .Ss \&UC
1.11 schwarze 877: Has no effect. Included for compatibility.
1.14 ! schwarze 878: .
! 879: .
1.12 schwarze 880: .Ss \&br
1.9 schwarze 881: Breaks the current line. Consecutive invocations have no further effect.
1.14 ! schwarze 882: .Pp
! 883: See also
! 884: .Sx \&sp .
! 885: .
! 886: .
1.12 schwarze 887: .Ss \&fi
1.9 schwarze 888: End literal mode begun by
1.12 schwarze 889: .Sx \&nf .
1.14 ! schwarze 890: .
! 891: .
1.12 schwarze 892: .Ss \&i
1.9 schwarze 893: Italicise arguments. If no arguments are specified, all subsequent text
894: is italicised.
1.14 ! schwarze 895: .Pp
! 896: See also
! 897: .Sx \&B ,
! 898: .Sx \&I ,
! 899: .Sx \&R .
! 900: .Sx \&b ,
! 901: and
! 902: .Sx \&r .
! 903: .
! 904: .
1.12 schwarze 905: .Ss \&na
1.11 schwarze 906: Don't align to the right margin.
1.14 ! schwarze 907: .
! 908: .
1.12 schwarze 909: .Ss \&nf
1.9 schwarze 910: Begin literal mode: all subsequent free-form lines have their end of
911: line boundaries preserved. May be ended by
1.12 schwarze 912: .Sx \&fi .
1.14 ! schwarze 913: .
! 914: .
1.12 schwarze 915: .Ss \&r
1.9 schwarze 916: Fonts and styles (bold face, italics) reset to roman (default font).
1.14 ! schwarze 917: .Pp
! 918: See also
! 919: .Sx \&B ,
! 920: .Sx \&I ,
! 921: .Sx \&R ,
! 922: .Sx \&b ,
! 923: and
! 924: .Sx \&i .
! 925: .
! 926: .
1.12 schwarze 927: .Ss \&sp
1.14 ! schwarze 928: Insert vertical spaces into output with the following syntax:
! 929: .Bd -filled -offset indent
! 930: .Pf \. Sx \&sp
! 931: .Op Cm height
! 932: .Ed
! 933: .Pp
! 934: Insert
! 935: .Cm height
! 936: spaces, which must conform to
! 937: .Sx Scaling Widths .
! 938: If 0, this is equivalent to the
1.12 schwarze 939: .Sx \&br
1.14 ! schwarze 940: macro. Defaults to 1, if unspecified.
! 941: .Pp
! 942: See also
! 943: .Sx \&br .
1.9 schwarze 944: .
945: .
1.5 schwarze 946: .Sh COMPATIBILITY
1.9 schwarze 947: This section documents compatibility with other roff implementations, at
948: this time limited to
1.10 schwarze 949: .Xr groff 1 .
950: .Bl -hyphen
951: .It
1.9 schwarze 952: In quoted literals, groff allowed pair-wise double-quotes to produce a
953: standalone double-quote in formatted output. This idiosyncratic
954: behaviour is no longer applicable.
1.10 schwarze 955: .It
1.9 schwarze 956: The
1.10 schwarze 957: .Sq sp
1.9 schwarze 958: macro does not accept negative numbers.
1.10 schwarze 959: .It
1.9 schwarze 960: Blocks of whitespace are stripped from both macro and free-form text
961: lines (except when in literal mode), while groff would retain whitespace
962: in free-form text lines.
1.10 schwarze 963: .El
1.9 schwarze 964: .
965: .
1.1 kristaps 966: .Sh SEE ALSO
1.10 schwarze 967: .Xr mandoc 1 ,
968: .Xr mandoc_char 7
1.9 schwarze 969: .
970: .
1.1 kristaps 971: .Sh AUTHORS
972: The
1.10 schwarze 973: .Nm
1.9 schwarze 974: reference was written by
1.10 schwarze 975: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.9 schwarze 976: .
977: .
1.1 kristaps 978: .Sh CAVEATS
979: Do not use this language. Use
1.10 schwarze 980: .Xr mdoc 7 ,
1.1 kristaps 981: instead.
1.9 schwarze 982: .
![[BACK]](/icons/back.gif){kind=icon}
Return to man.7 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc