Annotation of mandoc/man.7, Revision 1.92
1.92 ! kristaps 1: .\" $Id: man.7,v 1.91 2010/12/06 15:31:19 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.92 ! kristaps 17: .Dd $Mdocdate: December 6 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.80 kristaps 114: In free-form lines, whitespace is preserved within a line; unescaped
1.64 kristaps 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
1.80 kristaps 193: When composing a manual, make sure that sentences end at the end of
1.69 kristaps 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
1.80 kristaps 198: delimiters
199: .Po
200: .Sq \&) ,
1.71 kristaps 201: .Sq \&] ,
202: .Sq \&' ,
1.80 kristaps 203: .Sq \&"
204: .Pc .
1.22 kristaps 205: .Sh MANUAL STRUCTURE
1.16 kristaps 206: Each
1.32 kristaps 207: .Nm
1.80 kristaps 208: document must contain the
1.39 kristaps 209: .Sx \&TH
1.68 kristaps 210: macro describing the document's section and title.
1.80 kristaps 211: It may occur anywhere in the document, although conventionally it
1.68 kristaps 212: appears as the first macro.
1.32 kristaps 213: .Pp
1.22 kristaps 214: Beyond
1.39 kristaps 215: .Sx \&TH ,
1.68 kristaps 216: at least one macro or text node must appear in the document.
217: Documents are generally structured as follows:
1.32 kristaps 218: .Bd -literal -offset indent
1.43 kristaps 219: \&.TH FOO 1 2009-10-10
1.22 kristaps 220: \&.SH NAME
1.29 kristaps 221: \efBfoo\efR \e(en a description goes here
1.33 kristaps 222: \&.\e\*q .SH LIBRARY
1.86 kristaps 223: \&.\e\*q For sections 2 & 3 only.
224: \&.\e\*q Not used in OpenBSD.
1.22 kristaps 225: \&.SH SYNOPSIS
226: \efBfoo\efR [\efB\e-options\efR] arguments...
227: \&.SH DESCRIPTION
1.33 kristaps 228: The \efBfoo\efR utility processes files...
229: \&.\e\*q .SH IMPLEMENTATION NOTES
1.89 schwarze 230: \&.\e\*q Not used in OpenBSD.
1.22 kristaps 231: \&.\e\*q .SH RETURN VALUES
1.86 kristaps 232: \&.\e\*q For sections 2, 3, & 9 only.
1.22 kristaps 233: \&.\e\*q .SH ENVIRONMENT
1.86 kristaps 234: \&.\e\*q For sections 1, 6, 7, & 8 only.
1.22 kristaps 235: \&.\e\*q .SH FILES
1.67 kristaps 236: \&.\e\*q .SH EXIT STATUS
1.89 schwarze 237: \&.\e\*q For sections 1, 6, & 8 only.
1.22 kristaps 238: \&.\e\*q .SH EXAMPLES
239: \&.\e\*q .SH DIAGNOSTICS
1.86 kristaps 240: \&.\e\*q For sections 1, 4, 6, 7, & 8 only.
1.22 kristaps 241: \&.\e\*q .SH ERRORS
1.86 kristaps 242: \&.\e\*q For sections 2, 3, & 9 only.
1.22 kristaps 243: \&.\e\*q .SH SEE ALSO
1.42 kristaps 244: \&.\e\*q .BR foo ( 1 )
1.22 kristaps 245: \&.\e\*q .SH STANDARDS
246: \&.\e\*q .SH HISTORY
247: \&.\e\*q .SH AUTHORS
248: \&.\e\*q .SH CAVEATS
249: \&.\e\*q .SH BUGS
1.33 kristaps 250: \&.\e\*q .SH SECURITY CONSIDERATIONS
1.86 kristaps 251: \&.\e\*q Not used in OpenBSD.
1.32 kristaps 252: .Ed
1.41 kristaps 253: .Pp
254: The sections in a
255: .Nm
1.68 kristaps 256: document are conventionally ordered as they appear above.
257: Sections should be composed as follows:
1.42 kristaps 258: .Bl -ohang -offset indent
259: .It Em NAME
1.68 kristaps 260: The name(s) and a short description of the documented material.
261: The syntax for this is generally as follows:
1.41 kristaps 262: .Pp
263: .D1 \efBname\efR \e(en description
1.42 kristaps 264: .It Em LIBRARY
1.41 kristaps 265: The name of the library containing the documented material, which is
1.68 kristaps 266: assumed to be a function in a section 2 or 3 manual.
267: For functions in the C library, this may be as follows:
1.41 kristaps 268: .Pp
269: .D1 Standard C Library (libc, -lc)
1.42 kristaps 270: .It Em SYNOPSIS
1.41 kristaps 271: Documents the utility invocation syntax, function call syntax, or device
1.55 kristaps 272: configuration.
1.41 kristaps 273: .Pp
274: For the first, utilities (sections 1, 6, and 8), this is
275: generally structured as follows:
276: .Pp
277: .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
278: .Pp
279: For the second, function calls (sections 2, 3, 9):
280: .Pp
1.44 kristaps 281: .D1 \&.B char *name(char *\efIarg\efR);
1.41 kristaps 282: .Pp
283: And for the third, configurations (section 4):
284: .Pp
1.44 kristaps 285: .D1 \&.B name* at cardbus ? function ?
1.41 kristaps 286: .Pp
1.55 kristaps 287: Manuals not in these sections generally don't need a
1.42 kristaps 288: .Em SYNOPSIS .
289: .It Em DESCRIPTION
1.55 kristaps 290: This expands upon the brief, one-line description in
1.42 kristaps 291: .Em NAME .
292: It usually contains a break-down of the options (if documenting a
293: command).
294: .It Em IMPLEMENTATION NOTES
1.68 kristaps 295: Implementation-specific notes should be kept here.
296: This is useful when implementing standard functions that may have side
297: effects or notable algorithmic implications.
1.42 kristaps 298: .It Em RETURN VALUES
1.80 kristaps 299: This section documents the return values of functions in sections 2, 3, and 9.
1.42 kristaps 300: .It Em ENVIRONMENT
301: Documents any usages of environment variables, e.g.,
302: .Xr environ 7 .
303: .It Em FILES
1.68 kristaps 304: Documents files used.
1.78 schwarze 305: It's helpful to document both the file name and a short description of how
1.68 kristaps 306: the file is used (created, modified, etc.).
1.67 kristaps 307: .It Em EXIT STATUS
1.80 kristaps 308: This section documents the command exit status for
309: section 1, 6, and 8 utilities.
1.68 kristaps 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.
1.80 kristaps 317: Make sure that 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
1.81 schwarze 344: A brief history of the subject, including where support first appeared.
1.42 kristaps 345: .It Em AUTHORS
1.81 schwarze 346: Credits to the person or persons who wrote the code and/or documentation.
1.78 schwarze 347: Authors should generally be noted by both name and email address.
1.42 kristaps 348: .It Em CAVEATS
1.78 schwarze 349: Common misuses and misunderstandings should be explained
1.42 kristaps 350: in this section.
351: .It Em BUGS
1.80 kristaps 352: Known bugs, limitations, and work-arounds should be described
1.78 schwarze 353: in this section.
1.42 kristaps 354: .It Em SECURITY CONSIDERATIONS
355: Documents any security precautions that operators should consider.
1.41 kristaps 356: .El
1.22 kristaps 357: .Sh MACRO SYNTAX
1.80 kristaps 358: Macros are one to three characters in length and begin with a
1.78 schwarze 359: control character,
1.32 kristaps 360: .Sq \&. ,
1.68 kristaps 361: at the beginning of the line.
362: The
1.59 kristaps 363: .Sq \(aq
1.68 kristaps 364: macro control character is also accepted.
365: An arbitrary amount of whitespace (spaces or tabs) may sit between the
366: control character and the macro name.
367: Thus, the following are equivalent:
1.39 kristaps 368: .Bd -literal -offset indent
369: \&.PP
370: \&.\ \ \ PP
371: .Ed
1.32 kristaps 372: .Pp
1.1 kristaps 373: The
1.32 kristaps 374: .Nm
1.68 kristaps 375: macros are classified by scope: line scope or block scope.
376: Line macros are only scoped to the current line (and, in some
377: situations, the subsequent line).
378: Block macros are scoped to the current line and subsequent lines until
379: closed by another block macro.
1.32 kristaps 380: .Ss Line Macros
1.30 kristaps 381: Line macros are generally scoped to the current line, with the body
1.68 kristaps 382: consisting of zero or more arguments.
383: If a macro is scoped to the next line and the line arguments are empty,
384: the next line, which must be text, is used instead.
385: Thus:
1.32 kristaps 386: .Bd -literal -offset indent
1.30 kristaps 387: \&.I
1.4 kristaps 388: foo
1.32 kristaps 389: .Ed
390: .Pp
1.20 kristaps 391: is equivalent to
1.32 kristaps 392: .Sq \&.I foo .
1.56 kristaps 393: If next-line macros are invoked consecutively, only the last is used.
394: If a next-line macro is followed by a non-next-line macro, an error is
1.78 schwarze 395: raised, except for
1.56 kristaps 396: .Sx \&br ,
397: .Sx \&sp ,
1.78 schwarze 398: and
399: .Sx \&na .
1.56 kristaps 400: .Pp
401: The syntax is as follows:
1.32 kristaps 402: .Bd -literal -offset indent
1.22 kristaps 403: \&.YO \(lBbody...\(rB
404: \(lBbody...\(rB
1.32 kristaps 405: .Ed
406: .Pp
1.57 kristaps 407: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX"
408: .It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes
1.73 kristaps 409: .It Sx \&AT Ta <=1 Ta current Ta \&
1.57 kristaps 410: .It Sx \&B Ta n Ta next-line Ta \&
411: .It Sx \&BI Ta n Ta current Ta \&
412: .It Sx \&BR Ta n Ta current Ta \&
413: .It Sx \&DT Ta 0 Ta current Ta \&
414: .It Sx \&I Ta n Ta next-line Ta \&
415: .It Sx \&IB Ta n Ta current Ta \&
416: .It Sx \&IR Ta n Ta current Ta \&
417: .It Sx \&R Ta n Ta next-line Ta \&
418: .It Sx \&RB Ta n Ta current Ta \&
419: .It Sx \&RI Ta n Ta current Ta \&
420: .It Sx \&SB Ta n Ta next-line Ta \&
421: .It Sx \&SM Ta n Ta next-line Ta \&
422: .It Sx \&TH Ta >1, <6 Ta current Ta \&
1.73 kristaps 423: .It Sx \&UC Ta <=1 Ta current Ta \&
1.57 kristaps 424: .It Sx \&br Ta 0 Ta current Ta compat
425: .It Sx \&fi Ta 0 Ta current Ta compat
1.91 kristaps 426: .It Sx \&ft Ta 1 Ta current Ta compat
1.79 kristaps 427: .It Sx \&in Ta 1 Ta current Ta compat
1.57 kristaps 428: .It Sx \&na Ta 0 Ta current Ta compat
429: .It Sx \&nf Ta 0 Ta current Ta compat
430: .It Sx \&sp Ta 1 Ta current Ta compat
1.32 kristaps 431: .El
432: .Pp
1.57 kristaps 433: Macros marked as
434: .Qq compat
435: are included for compatibility with the significant corpus of existing
1.68 kristaps 436: manuals that mix dialects of roff.
437: These macros should not be used for portable
1.58 kristaps 438: .Nm
439: manuals.
1.32 kristaps 440: .Ss Block Macros
1.80 kristaps 441: Block macros comprise a head and body.
442: As with in-line macros, the head is scoped to the current line and, in
1.68 kristaps 443: one circumstance, the next line (the next-line stipulations as in
1.57 kristaps 444: .Sx Line Macros
445: apply here as well).
1.56 kristaps 446: .Pp
447: The syntax is as follows:
1.32 kristaps 448: .Bd -literal -offset indent
1.22 kristaps 449: \&.YO \(lBhead...\(rB
450: \(lBhead...\(rB
451: \(lBbody...\(rB
1.32 kristaps 452: .Ed
453: .Pp
1.30 kristaps 454: The closure of body scope may be to the section, where a macro is closed
455: by
1.39 kristaps 456: .Sx \&SH ;
1.30 kristaps 457: sub-section, closed by a section or
1.39 kristaps 458: .Sx \&SS ;
1.30 kristaps 459: part, closed by a section, sub-section, or
1.39 kristaps 460: .Sx \&RE ;
1.55 kristaps 461: or paragraph, closed by a section, sub-section, part,
1.39 kristaps 462: .Sx \&HP ,
463: .Sx \&IP ,
464: .Sx \&LP ,
465: .Sx \&P ,
466: .Sx \&PP ,
1.30 kristaps 467: or
1.39 kristaps 468: .Sx \&TP .
1.30 kristaps 469: No closure refers to an explicit block closing macro.
1.32 kristaps 470: .Pp
1.58 kristaps 471: As a rule, block macros may not be nested; thus, calling a block macro
472: while another block macro scope is open, and the open scope is not
473: implicitly closed, is syntactically incorrect.
474: .Pp
1.57 kristaps 475: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX"
476: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes
477: .It Sx \&HP Ta <2 Ta current Ta paragraph Ta \&
478: .It Sx \&IP Ta <3 Ta current Ta paragraph Ta \&
479: .It Sx \&LP Ta 0 Ta current Ta paragraph Ta \&
480: .It Sx \&P Ta 0 Ta current Ta paragraph Ta \&
481: .It Sx \&PP Ta 0 Ta current Ta paragraph Ta \&
482: .It Sx \&RE Ta 0 Ta current Ta none Ta compat
483: .It Sx \&RS Ta 1 Ta current Ta part Ta compat
484: .It Sx \&SH Ta >0 Ta next-line Ta section Ta \&
485: .It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \&
486: .It Sx \&TP Ta n Ta next-line Ta paragraph Ta \&
1.32 kristaps 487: .El
1.57 kristaps 488: .Pp
489: Macros marked
490: .Qq compat
491: are as mentioned in
492: .Sx Line Macros .
1.32 kristaps 493: .Pp
1.22 kristaps 494: If a block macro is next-line scoped, it may only be followed by in-line
1.57 kristaps 495: macros for decorating text.
1.22 kristaps 496: .Sh REFERENCE
497: This section is a canonical reference to all macros, arranged
1.68 kristaps 498: alphabetically.
499: For the scoping of individual macros, see
1.32 kristaps 500: .Sx MACRO SYNTAX .
1.72 joerg 501: .Ss \&AT
502: Sets the volume for the footer for compatibility with man pages from
503: .Tn AT&T UNIX
504: releases.
505: The optional arguments specify which release it is from.
1.39 kristaps 506: .Ss \&B
1.22 kristaps 507: Text is rendered in bold face.
1.44 kristaps 508: .Pp
509: See also
1.92 ! kristaps 510: .Sx \&I
1.44 kristaps 511: and
1.92 ! kristaps 512: .Sx \&R .
1.39 kristaps 513: .Ss \&BI
1.68 kristaps 514: Text is rendered alternately in bold face and italic.
515: Thus,
1.32 kristaps 516: .Sq .BI this word and that
1.22 kristaps 517: causes
1.32 kristaps 518: .Sq this
1.22 kristaps 519: and
1.32 kristaps 520: .Sq and
1.55 kristaps 521: to render in bold face, while
1.32 kristaps 522: .Sq word
1.22 kristaps 523: and
1.32 kristaps 524: .Sq that
1.68 kristaps 525: render in italics.
526: Whitespace between arguments is omitted in output.
1.44 kristaps 527: .Pp
528: Examples:
1.46 kristaps 529: .Pp
530: .D1 \&.BI bold italic bold italic
1.44 kristaps 531: .Pp
532: The output of this example will be emboldened
533: .Dq bold
534: and italicised
535: .Dq italic ,
536: with spaces stripped between arguments.
537: .Pp
538: See also
539: .Sx \&IB ,
540: .Sx \&BR ,
541: .Sx \&RB ,
542: .Sx \&RI ,
543: and
544: .Sx \&IR .
1.39 kristaps 545: .Ss \&BR
1.22 kristaps 546: Text is rendered alternately in bold face and roman (the default font).
547: Whitespace between arguments is omitted in output.
1.44 kristaps 548: .Pp
549: See
550: .Sx \&BI
551: for an equivalent example.
552: .Pp
553: See also
554: .Sx \&BI ,
555: .Sx \&IB ,
556: .Sx \&RB ,
557: .Sx \&RI ,
558: and
559: .Sx \&IR .
1.39 kristaps 560: .Ss \&DT
1.68 kristaps 561: Has no effect.
562: Included for compatibility.
1.39 kristaps 563: .Ss \&HP
1.23 kristaps 564: Begin a paragraph whose initial output line is left-justified, but
1.27 kristaps 565: subsequent output lines are indented, with the following syntax:
1.44 kristaps 566: .Bd -filled -offset indent
567: .Pf \. Sx \&HP
568: .Op Cm width
1.32 kristaps 569: .Ed
1.44 kristaps 570: .Pp
571: The
572: .Cm width
573: argument must conform to
574: .Sx Scaling Widths .
575: If specified, it's saved for later paragraph left-margins; if unspecified, the
576: saved or default width is used.
577: .Pp
578: See also
1.45 kristaps 579: .Sx \&IP ,
580: .Sx \&LP ,
581: .Sx \&P ,
582: .Sx \&PP ,
1.44 kristaps 583: and
1.45 kristaps 584: .Sx \&TP .
1.39 kristaps 585: .Ss \&I
1.22 kristaps 586: Text is rendered in italics.
1.44 kristaps 587: .Pp
588: See also
1.92 ! kristaps 589: .Sx \&B
1.44 kristaps 590: and
1.92 ! kristaps 591: .Sx \&R .
1.39 kristaps 592: .Ss \&IB
1.80 kristaps 593: Text is rendered alternately in italics and bold face.
594: Whitespace between arguments is omitted in output.
1.44 kristaps 595: .Pp
596: See
597: .Sx \&BI
598: for an equivalent example.
599: .Pp
600: See also
601: .Sx \&BI ,
602: .Sx \&BR ,
603: .Sx \&RB ,
604: .Sx \&RI ,
605: and
606: .Sx \&IR .
1.39 kristaps 607: .Ss \&IP
1.44 kristaps 608: Begin an indented paragraph with the following syntax:
609: .Bd -filled -offset indent
610: .Pf \. Sx \&IP
611: .Op Cm head Op Cm width
1.32 kristaps 612: .Ed
1.44 kristaps 613: .Pp
614: The
615: .Cm width
616: argument defines the width of the left margin and is defined by
1.80 kristaps 617: .Sx Scaling Widths .
1.44 kristaps 618: It's saved for later paragraph left-margins; if unspecified, the saved or
619: default width is used.
620: .Pp
621: The
622: .Cm head
1.68 kristaps 623: argument is used as a leading term, flushed to the left margin.
624: This is useful for bulleted paragraphs and so on.
1.44 kristaps 625: .Pp
626: See also
1.45 kristaps 627: .Sx \&HP ,
628: .Sx \&LP ,
629: .Sx \&P ,
630: .Sx \&PP ,
1.44 kristaps 631: and
1.45 kristaps 632: .Sx \&TP .
1.39 kristaps 633: .Ss \&IR
1.22 kristaps 634: Text is rendered alternately in italics and roman (the default font).
635: Whitespace between arguments is omitted in output.
1.44 kristaps 636: .Pp
637: See
638: .Sx \&BI
639: for an equivalent example.
640: .Pp
641: See also
642: .Sx \&BI ,
643: .Sx \&IB ,
644: .Sx \&BR ,
645: .Sx \&RB ,
646: and
647: .Sx \&RI .
1.39 kristaps 648: .Ss \&LP
1.68 kristaps 649: Begin an undecorated paragraph.
650: The scope of a paragraph is closed by a subsequent paragraph,
651: sub-section, section, or end of file.
1.78 schwarze 652: The saved paragraph left-margin width is reset to the default.
1.44 kristaps 653: .Pp
654: See also
1.45 kristaps 655: .Sx \&HP ,
656: .Sx \&IP ,
657: .Sx \&P ,
658: .Sx \&PP ,
1.44 kristaps 659: and
1.45 kristaps 660: .Sx \&TP .
1.39 kristaps 661: .Ss \&P
662: Synonym for
663: .Sx \&LP .
1.44 kristaps 664: .Pp
665: See also
1.45 kristaps 666: .Sx \&HP ,
667: .Sx \&IP ,
668: .Sx \&LP ,
669: .Sx \&PP ,
1.44 kristaps 670: and
1.45 kristaps 671: .Sx \&TP .
1.39 kristaps 672: .Ss \&PP
673: Synonym for
674: .Sx \&LP .
1.44 kristaps 675: .Pp
676: See also
1.45 kristaps 677: .Sx \&HP ,
678: .Sx \&IP ,
679: .Sx \&LP ,
680: .Sx \&P ,
1.44 kristaps 681: and
1.45 kristaps 682: .Sx \&TP .
1.39 kristaps 683: .Ss \&R
1.22 kristaps 684: Text is rendered in roman (the default font).
1.44 kristaps 685: .Pp
686: See also
1.92 ! kristaps 687: .Sx \&I
1.44 kristaps 688: and
1.92 ! kristaps 689: .Sx \&B .
1.39 kristaps 690: .Ss \&RB
1.22 kristaps 691: Text is rendered alternately in roman (the default font) and bold face.
692: Whitespace between arguments is omitted in output.
1.44 kristaps 693: .Pp
694: See
695: .Sx \&BI
696: for an equivalent example.
697: .Pp
698: See also
699: .Sx \&BI ,
700: .Sx \&IB ,
701: .Sx \&BR ,
702: .Sx \&RI ,
703: and
704: .Sx \&IR .
1.39 kristaps 705: .Ss \&RE
1.30 kristaps 706: Explicitly close out the scope of a prior
1.39 kristaps 707: .Sx \&RS .
708: .Ss \&RI
1.22 kristaps 709: Text is rendered alternately in roman (the default font) and italics.
710: Whitespace between arguments is omitted in output.
1.44 kristaps 711: .Pp
712: See
713: .Sx \&BI
714: for an equivalent example.
715: .Pp
716: See also
717: .Sx \&BI ,
718: .Sx \&IB ,
719: .Sx \&BR ,
720: .Sx \&RB ,
721: and
722: .Sx \&IR .
1.39 kristaps 723: .Ss \&RS
1.68 kristaps 724: Begin a part setting the left margin.
725: The left margin controls the offset, following an initial indentation,
726: to un-indented text such as that of
1.39 kristaps 727: .Sx \&PP .
1.44 kristaps 728: This has the following syntax:
729: .Bd -filled -offset indent
730: .Pf \. Sx \&Rs
731: .Op Cm width
1.32 kristaps 732: .Ed
1.44 kristaps 733: .Pp
734: The
735: .Cm width
736: argument must conform to
737: .Sx Scaling Widths .
1.55 kristaps 738: If not specified, the saved or default width is used.
1.39 kristaps 739: .Ss \&SB
1.22 kristaps 740: Text is rendered in small size (one point smaller than the default font)
741: bold face.
1.39 kristaps 742: .Ss \&SH
1.68 kristaps 743: Begin a section.
744: The scope of a section is only closed by another section or the end of
745: file.
1.78 schwarze 746: The paragraph left-margin width is reset to the default.
1.39 kristaps 747: .Ss \&SM
1.22 kristaps 748: Text is rendered in small size (one point smaller than the default
749: font).
1.39 kristaps 750: .Ss \&SS
1.68 kristaps 751: Begin a sub-section.
752: The scope of a sub-section is closed by a subsequent sub-section,
753: section, or end of file.
1.78 schwarze 754: The paragraph left-margin width is reset to the default.
1.39 kristaps 755: .Ss \&TH
1.22 kristaps 756: Sets the title of the manual page with the following syntax:
1.44 kristaps 757: .Bd -filled -offset indent
758: .Pf \. Sx \&TH
759: .Cm title section
760: .Op Cm date Op Cm source Op Cm volume
761: .Ed
1.43 kristaps 762: .Pp
1.78 schwarze 763: At least the upper-case document
1.43 kristaps 764: .Cm title
1.78 schwarze 765: and the manual
1.44 kristaps 766: .Cm section
1.68 kristaps 767: arguments must be provided.
768: The
1.43 kristaps 769: .Cm date
770: argument should be formatted as described in
1.74 kristaps 771: .Sx Dates ,
772: but will be printed verbatim if it is not.
773: If the date is not specified, the current date is used.
1.68 kristaps 774: The
1.44 kristaps 775: .Cm source
1.68 kristaps 776: string specifies the organisation providing the utility.
777: The
1.44 kristaps 778: .Cm volume
1.43 kristaps 779: string replaces the default rendered volume, which is dictated by the
780: manual section.
781: .Pp
782: Examples:
1.46 kristaps 783: .Pp
784: .D1 \&.TH CVS 5 "1992-02-12" GNU
1.39 kristaps 785: .Ss \&TP
1.25 kristaps 786: Begin a paragraph where the head, if exceeding the indentation width, is
1.24 kristaps 787: followed by a newline; if not, the body follows on the same line after a
1.68 kristaps 788: buffer to the indentation width.
789: Subsequent output lines are indented.
1.44 kristaps 790: The syntax is as follows:
791: .Bd -filled -offset indent
792: .Pf \. Sx \&TP
793: .Op Cm width
1.32 kristaps 794: .Ed
795: .Pp
1.44 kristaps 796: The
797: .Cm width
798: argument must conform to
799: .Sx Scaling Widths .
800: If specified, it's saved for later paragraph left-margins; if
1.27 kristaps 801: unspecified, the saved or default width is used.
1.44 kristaps 802: .Pp
803: See also
1.45 kristaps 804: .Sx \&HP ,
805: .Sx \&IP ,
806: .Sx \&LP ,
807: .Sx \&P ,
1.44 kristaps 808: and
1.45 kristaps 809: .Sx \&PP .
1.72 joerg 810: .Ss \&UC
811: Sets the volume for the footer for compatibility with man pages from
812: BSD releases.
813: The optional first argument specifies which release it is from.
1.39 kristaps 814: .Ss \&br
1.68 kristaps 815: Breaks the current line.
816: Consecutive invocations have no further effect.
1.44 kristaps 817: .Pp
818: See also
819: .Sx \&sp .
1.39 kristaps 820: .Ss \&fi
1.22 kristaps 821: End literal mode begun by
1.39 kristaps 822: .Sx \&nf .
1.91 kristaps 823: .Ss \&ft
824: Change the current font mode.
825: See
826: .Sx Text Decoration
827: for a listing of available font modes.
1.79 kristaps 828: .Ss \&in
829: Indent relative to the current indentation:
830: .Pp
831: .D1 Pf \. Sx \&in Op Cm width
832: .Pp
833: If
834: .Cm width
835: is signed, the new offset is relative.
836: Otherwise, it is absolute.
837: This value is reset upon the next paragraph, section, or sub-section.
1.39 kristaps 838: .Ss \&na
1.36 kristaps 839: Don't align to the right margin.
1.39 kristaps 840: .Ss \&nf
1.22 kristaps 841: Begin literal mode: all subsequent free-form lines have their end of
1.68 kristaps 842: line boundaries preserved.
843: May be ended by
1.39 kristaps 844: .Sx \&fi .
845: .Ss \&sp
1.44 kristaps 846: Insert vertical spaces into output with the following syntax:
847: .Bd -filled -offset indent
848: .Pf \. Sx \&sp
849: .Op Cm height
850: .Ed
851: .Pp
1.55 kristaps 852: Insert
1.44 kristaps 853: .Cm height
854: spaces, which must conform to
855: .Sx Scaling Widths .
856: If 0, this is equivalent to the
1.39 kristaps 857: .Sx \&br
1.68 kristaps 858: macro.
859: Defaults to 1, if unspecified.
1.44 kristaps 860: .Pp
861: See also
862: .Sx \&br .
1.18 kristaps 863: .Sh COMPATIBILITY
1.58 kristaps 864: This section documents areas of questionable portability between
865: implementations of the
866: .Nm
867: language.
1.51 kristaps 868: .Pp
869: .Bl -dash -compact
1.77 kristaps 870: .It
1.58 kristaps 871: In quoted literals, GNU troff allowed pair-wise double-quotes to produce
1.68 kristaps 872: a standalone double-quote in formatted output.
873: It is not known whether this behaviour is exhibited by other formatters.
1.32 kristaps 874: .It
1.82 kristaps 875: troff suppresses a newline before
876: .Sq \(aq
877: macro output; in mandoc, it is an alias for the standard
878: .Sq \&.
879: control character.
880: .It
881: The
882: .Sq \eh
883: .Pq horizontal position ,
884: .Sq \ev
885: .Pq vertical position ,
886: .Sq \em
887: .Pq text colour ,
888: .Sq \eM
889: .Pq text filling colour ,
1.83 kristaps 890: .Sq \ez
891: .Pq zero-length character ,
1.84 kristaps 892: .Sq \ew
893: .Pq string length ,
1.85 kristaps 894: .Sq \ek
895: .Pq horizontal position marker ,
1.87 kristaps 896: .Sq \eo
897: .Pq text overstrike ,
1.82 kristaps 898: and
899: .Sq \es
900: .Pq text size
1.84 kristaps 901: escape sequences are all discarded in mandoc.
1.82 kristaps 902: .It
903: The
904: .Sq \ef
905: scaling unit is accepted by mandoc, but rendered as the default unit.
906: .It
1.23 kristaps 907: The
1.51 kristaps 908: .Sx \&sp
1.68 kristaps 909: macro does not accept negative values in mandoc.
910: In GNU troff, this would result in strange behaviour.
1.32 kristaps 911: .El
1.1 kristaps 912: .Sh SEE ALSO
1.89 schwarze 913: .Xr man 1 ,
1.32 kristaps 914: .Xr mandoc 1 ,
1.89 schwarze 915: .Xr mandoc_char 7 ,
916: .Xr mdoc 7
1.78 schwarze 917: .Sh HISTORY
918: The
919: .Nm
920: language first appeared as a macro package for the roff typesetting
921: system in
922: .At v7 .
923: It was later rewritten by James Clark as a macro package for groff.
924: The stand-alone implementation that is part of the
925: .Xr mandoc 1
926: utility written by Kristaps Dzonsons appeared in
1.80 kristaps 927: .Ox 4.6 .
1.1 kristaps 928: .Sh AUTHORS
1.78 schwarze 929: This
1.32 kristaps 930: .Nm
1.23 kristaps 931: reference was written by
1.62 kristaps 932: .An Kristaps Dzonsons Aq kristaps@bsd.lv .
1.1 kristaps 933: .Sh CAVEATS
1.68 kristaps 934: Do not use this language.
935: Use
1.32 kristaps 936: .Xr mdoc 7 ,
1.1 kristaps 937: instead.
CVSweb