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