Annotation of mandoc/man.7, Revision 1.40
1.40 ! kristaps 1: .\" $Id: man.7,v 1.39 2009/10/19 07:44:30 kristaps Exp $
1.1 kristaps 2: .\"
1.11 kristaps 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.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: .\"
17: .Dd $Mdocdate$
1.9 kristaps 18: .Dt MAN 7
1.1 kristaps 19: .Os
1.28 kristaps 20: .
21: .
1.1 kristaps 22: .Sh NAME
1.32 kristaps 23: .Nm man
24: .Nd man language reference
1.28 kristaps 25: .
26: .
1.1 kristaps 27: .Sh DESCRIPTION
28: The
1.32 kristaps 29: .Nm man
1.20 kristaps 30: language was historically used to format
1.32 kristaps 31: .Ux
1.19 kristaps 32: manuals. This reference document describes its syntax, structure, and
33: usage.
1.32 kristaps 34: .
35: .Pp
36: .Bf -emphasis
1.20 kristaps 37: Do not use
1.32 kristaps 38: .Nm
1.20 kristaps 39: to write your manuals.
1.32 kristaps 40: .Ef
1.19 kristaps 41: Use the
1.32 kristaps 42: .Xr mdoc 7
1.1 kristaps 43: language, instead.
1.32 kristaps 44: .
45: .Pp
1.1 kristaps 46: An
1.32 kristaps 47: .Nm
1.1 kristaps 48: document follows simple rules: lines beginning with the control
1.20 kristaps 49: character
1.32 kristaps 50: .Sq \&.
1.1 kristaps 51: are parsed for macros. Other lines are interpreted within the scope of
52: prior macros:
1.32 kristaps 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.32 kristaps 56: .Ed
1.28 kristaps 57: .
58: .
1.1 kristaps 59: .Sh INPUT ENCODING
1.32 kristaps 60: .Nm
1.14 kristaps 61: documents may contain only graphable 7-bit ASCII characters, the
1.19 kristaps 62: space character, and the tabs character. All manuals must have
1.32 kristaps 63: .Ux
1.20 kristaps 64: line termination.
1.32 kristaps 65: .
66: .Pp
1.5 kristaps 67: Blank lines are acceptable; where found, the output will assert a
1.1 kristaps 68: vertical space.
1.32 kristaps 69: .
70: .Pp
1.4 kristaps 71: The
1.32 kristaps 72: .Sq \ec
1.4 kristaps 73: escape is common in historical
1.32 kristaps 74: .Nm
1.4 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.28 kristaps 77: .
78: .
1.32 kristaps 79: .Ss Comments
1.21 kristaps 80: Text following a
1.32 kristaps 81: .Sq \e\*" ,
1.21 kristaps 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.32 kristaps 84: .Sq \&.\e" ,
1.22 kristaps 85: is also ignored. Macro lines with only a control charater and
86: optionally whitespace are stripped from input.
1.28 kristaps 87: .
88: .
1.32 kristaps 89: .Ss Special Characters
1.21 kristaps 90: Special characters may occur in both macro and free-form lines.
91: Sequences begin with the escape character
1.32 kristaps 92: .Sq \e
1.20 kristaps 93: followed by either an open-parenthesis
1.32 kristaps 94: .Sq \&(
1.1 kristaps 95: for two-character sequences; an open-bracket
1.32 kristaps 96: .Sq \&[
1.1 kristaps 97: for n-character sequences (terminated at a close-bracket
1.32 kristaps 98: .Sq \&] ) ;
1.21 kristaps 99: or a single one-character sequence. See
1.32 kristaps 100: .Xr mandoc_char 7
1.21 kristaps 101: for a complete list. Examples include
1.32 kristaps 102: .Sq \e(em
103: .Pq em-dash
1.21 kristaps 104: and
1.32 kristaps 105: .Sq \ee
106: .Pq back-slash .
1.28 kristaps 107: .
108: .
1.32 kristaps 109: .Ss Text Decoration
1.21 kristaps 110: Terms may be text-decorated using the
1.32 kristaps 111: .Sq \ef
1.21 kristaps 112: escape followed by an indicator: B (bold), I, (italic), or P and R
113: (Roman, or reset).
1.28 kristaps 114: .
115: .
1.32 kristaps 116: .Ss Whitespace
1.17 kristaps 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.32 kristaps 120: .Xr mandoc 1 .
1.28 kristaps 121: .
1.38 kristaps 122: .Ss Scaling Widths
123: Many macros support scaled widths for their arguments, such as
124: stipulating a two-inch paragraph indentation with the following:
125: .Bd -literal -offset indent
126: \&.HP 2i
127: .Ed
128: .
129: .Pp
130: The syntax for scaled widths is
131: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,
132: where a decimal must be preceded or proceeded by at least one digit.
133: Negative numbers, while accepted, are truncated to zero. The following
134: scaling units are accepted:
135: .
136: .Pp
137: .Bl -tag -width Ds -offset indent -compact
138: .It c
139: centimetre
140: .It i
141: inch
142: .It P
143: pica (~1/6 inch)
144: .It p
145: point (~1/72 inch)
146: .It f
147: synonym for
148: .Sq u
149: .It v
150: default vertical span
151: .It m
152: width of rendered
153: .Sq m
154: .Pq em
155: character
156: .It n
157: width of rendered
158: .Sq n
159: .Pq en
160: character
161: .It u
162: default horizontal span
163: .It M
164: mini-em (~1/100 em)
165: .El
166: .Pp
167: Using anything other than
168: .Sq m ,
169: .Sq n ,
170: .Sq u ,
171: or
172: .Sq v
173: is necessarily non-portable across output media. See
174: .Sx COMPATIBILITY .
175: .
176: .Pp
177: If a scaling unit is not provided, the numerical value is interpreted
178: under the default rules of
179: .Sq v
180: for vertical spaces and
181: .Sq u
182: for horizontal ones.
183: .Em Note :
184: this differs from
185: .Xr mdoc 7 ,
186: which, if a unit is not provided, will instead interpret the string as
187: literal text.
188: .
1.28 kristaps 189: .
1.22 kristaps 190: .Sh MANUAL STRUCTURE
1.16 kristaps 191: Each
1.32 kristaps 192: .Nm
1.16 kristaps 193: document must contain contains at least the
1.39 kristaps 194: .Sx \&TH
1.16 kristaps 195: macro describing the document's section and title. It may occur
196: anywhere in the document, although conventionally, it appears as the
197: first macro.
1.32 kristaps 198: .
199: .Pp
1.22 kristaps 200: Beyond
1.39 kristaps 201: .Sx \&TH ,
1.22 kristaps 202: at least one macro or text node must appear in the document. Documents
203: are generally structured as follows:
1.32 kristaps 204: .Bd -literal -offset indent
1.22 kristaps 205: \&.TH FOO 1 "13 Aug 2009"
206: \&.
207: \&.SH NAME
1.29 kristaps 208: \efBfoo\efR \e(en a description goes here
1.33 kristaps 209: \&.\e\*q The next is for sections 2 & 3 only.
210: \&.\e\*q .SH LIBRARY
1.22 kristaps 211: \&.
212: \&.SH SYNOPSIS
213: \efBfoo\efR [\efB\e-options\efR] arguments...
214: \&.
215: \&.SH DESCRIPTION
1.33 kristaps 216: The \efBfoo\efR utility processes files...
1.22 kristaps 217: \&.
1.33 kristaps 218: \&.\e\*q .SH IMPLEMENTATION NOTES
219: \&.\e\*q The next is for sections 1 & 8 only.
220: \&.\e\*q .SH EXIT STATUS
221: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22 kristaps 222: \&.\e\*q .SH RETURN VALUES
1.33 kristaps 223: \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
1.22 kristaps 224: \&.\e\*q .SH ENVIRONMENT
225: \&.\e\*q .SH FILES
226: \&.\e\*q .SH EXAMPLES
1.33 kristaps 227: \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
1.22 kristaps 228: \&.\e\*q .SH DIAGNOSTICS
1.33 kristaps 229: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22 kristaps 230: \&.\e\*q .SH ERRORS
231: \&.\e\*q .SH SEE ALSO
232: \&.\e\*q \efBbar\efR(1)
233: \&.\e\*q .SH STANDARDS
234: \&.\e\*q .SH HISTORY
235: \&.\e\*q .SH AUTHORS
236: \&.\e\*q .SH CAVEATS
237: \&.\e\*q .SH BUGS
1.33 kristaps 238: \&.\e\*q .SH SECURITY CONSIDERATIONS
1.32 kristaps 239: .Ed
1.28 kristaps 240: .
241: .
1.22 kristaps 242: .Sh MACRO SYNTAX
1.2 kristaps 243: Macros are one to three three characters in length and begin with a
1.4 kristaps 244: control character ,
1.32 kristaps 245: .Sq \&. ,
1.2 kristaps 246: at the beginning of the line. An arbitrary amount of whitespace may
1.39 kristaps 247: sit between the control character and the macro name. Thus, the
248: following are equivalent:
249: .Bd -literal -offset indent
250: \&.PP
251: \&.\ \ \ PP
252: .Ed
1.32 kristaps 253: .
254: .Pp
1.1 kristaps 255: The
1.32 kristaps 256: .Nm
1.30 kristaps 257: macros are classified by scope: line scope or block scope. Line
1.22 kristaps 258: macros are only scoped to the current line (and, in some situations,
259: the subsequent line). Block macros are scoped to the current line and
260: subsequent lines until closed by another block macro.
1.28 kristaps 261: .
262: .
1.32 kristaps 263: .Ss Line Macros
1.30 kristaps 264: Line macros are generally scoped to the current line, with the body
265: consisting of zero or more arguments. If a macro is scoped to the next
266: line and the line arguments are empty, the next line is used instead,
267: else the general syntax is used. Thus:
1.32 kristaps 268: .Bd -literal -offset indent
1.30 kristaps 269: \&.I
1.4 kristaps 270: foo
1.32 kristaps 271: .Ed
272: .
273: .Pp
1.20 kristaps 274: is equivalent to
1.32 kristaps 275: .Sq \&.I foo .
1.35 kristaps 276: If next-line macros are invoked consecutively, only the last is used.
277: If a next-line macro is proceded by a block macro, it is ignored.
1.32 kristaps 278: .Bd -literal -offset indent
1.22 kristaps 279: \&.YO \(lBbody...\(rB
280: \(lBbody...\(rB
1.32 kristaps 281: .Ed
282: .
283: .Pp
284: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
285: .It Em Macro Ta Em Arguments Ta Em Scope
1.39 kristaps 286: .It Sx \&B Ta n Ta next-line
287: .It Sx \&BI Ta n Ta current
288: .It Sx \&BR Ta n Ta current
289: .It Sx \&DT Ta 0 Ta current
290: .It Sx \&I Ta n Ta next-line
291: .It Sx \&IB Ta n Ta current
292: .It Sx \&IR Ta n Ta current
1.40 ! kristaps 293: .It Sx \&PD Ta n Ta current
1.39 kristaps 294: .It Sx \&R Ta n Ta next-line
295: .It Sx \&RB Ta n Ta current
296: .It Sx \&RI Ta n Ta current
297: .It Sx \&SB Ta n Ta next-line
298: .It Sx \&SM Ta n Ta next-line
299: .It Sx \&TH Ta >1, <6 Ta current
300: .It Sx \&UC Ta n Ta current
301: .It Sx \&br Ta 0 Ta current
302: .It Sx \&fi Ta 0 Ta current
303: .It Sx \&i Ta n Ta current
304: .It Sx \&na Ta 0 Ta current
305: .It Sx \&nf Ta 0 Ta current
306: .It Sx \&r Ta 0 Ta current
307: .It Sx \&sp Ta 1 Ta current
1.32 kristaps 308: .El
309: .
310: .Pp
1.31 kristaps 311: The
1.40 ! kristaps 312: .Sx \&PD ,
1.39 kristaps 313: .Sx \&RS ,
314: .Sx \&RE ,
315: .Sx \&UC ,
316: .Sx \&br ,
317: .Sx \&fi ,
318: .Sx \&i ,
319: .Sx \&na ,
320: .Sx \&nf ,
321: .Sx \&r ,
1.22 kristaps 322: and
1.39 kristaps 323: .Sx \&sp
1.36 kristaps 324: macros should not be used. They're included for compatibility.
1.28 kristaps 325: .
326: .
1.32 kristaps 327: .Ss Block Macros
1.30 kristaps 328: Block macros are comprised of a head and body. Like for in-line macros,
329: the head is scoped to the current line and, in one circumstance, the
330: next line; the body is scoped to subsequent lines and is closed out by a
331: subsequent block macro invocation.
1.32 kristaps 332: .Bd -literal -offset indent
1.22 kristaps 333: \&.YO \(lBhead...\(rB
334: \(lBhead...\(rB
335: \(lBbody...\(rB
1.32 kristaps 336: .Ed
337: .
338: .Pp
1.30 kristaps 339: The closure of body scope may be to the section, where a macro is closed
340: by
1.39 kristaps 341: .Sx \&SH ;
1.30 kristaps 342: sub-section, closed by a section or
1.39 kristaps 343: .Sx \&SS ;
1.30 kristaps 344: part, closed by a section, sub-section, or
1.39 kristaps 345: .Sx \&RE ;
1.30 kristaps 346: or paragraph, closed by a section, sub-section, part,
1.39 kristaps 347: .Sx \&HP ,
348: .Sx \&IP ,
349: .Sx \&LP ,
350: .Sx \&P ,
351: .Sx \&PP ,
1.30 kristaps 352: or
1.39 kristaps 353: .Sx \&TP .
1.30 kristaps 354: No closure refers to an explicit block closing macro.
1.32 kristaps 355: .
356: .Pp
357: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
358: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
1.39 kristaps 359: .It Sx \&HP Ta <2 Ta current Ta paragraph
360: .It Sx \&IP Ta <3 Ta current Ta paragraph
361: .It Sx \&LP Ta 0 Ta current Ta paragraph
362: .It Sx \&P Ta 0 Ta current Ta paragraph
363: .It Sx \&PP Ta 0 Ta current Ta paragraph
364: .It Sx \&RE Ta 0 Ta current Ta none
365: .It Sx \&RS Ta 1 Ta current Ta part
366: .It Sx \&SH Ta >0 Ta next-line Ta section
367: .It Sx \&SS Ta >0 Ta next-line Ta sub-section
368: .It Sx \&TP Ta n Ta next-line Ta paragraph
1.32 kristaps 369: .El
370: .
371: .Pp
1.22 kristaps 372: If a block macro is next-line scoped, it may only be followed by in-line
373: macros (excluding
1.39 kristaps 374: .Sx \&DT ,
1.40 ! kristaps 375: .Sx \&PD ,
1.39 kristaps 376: .Sx \&TH ,
377: .Sx \&UC ,
378: .Sx \&br ,
379: .Sx \&na ,
380: .Sx \&sp ,
381: .Sx \&nf ,
1.22 kristaps 382: and
1.39 kristaps 383: .Sx \&fi ) .
1.28 kristaps 384: .
385: .
1.22 kristaps 386: .Sh REFERENCE
387: This section is a canonical reference to all macros, arranged
388: alphabetically. For the scoping of individual macros, see
1.32 kristaps 389: .Sx MACRO SYNTAX .
1.28 kristaps 390: .
1.39 kristaps 391: .Ss \&B
1.22 kristaps 392: Text is rendered in bold face.
1.39 kristaps 393: .Ss \&BI
1.22 kristaps 394: Text is rendered alternately in bold face and italic. Thus,
1.32 kristaps 395: .Sq .BI this word and that
1.22 kristaps 396: causes
1.32 kristaps 397: .Sq this
1.22 kristaps 398: and
1.32 kristaps 399: .Sq and
1.22 kristaps 400: to render in bold face, while
1.32 kristaps 401: .Sq word
1.22 kristaps 402: and
1.32 kristaps 403: .Sq that
1.22 kristaps 404: render in italics. Whitespace between arguments is omitted in output.
1.39 kristaps 405: .Ss \&BR
1.22 kristaps 406: Text is rendered alternately in bold face and roman (the default font).
407: Whitespace between arguments is omitted in output.
1.39 kristaps 408: .Ss \&DT
1.36 kristaps 409: Has no effect. Included for compatibility.
1.39 kristaps 410: .Ss \&HP
1.23 kristaps 411: Begin a paragraph whose initial output line is left-justified, but
1.27 kristaps 412: subsequent output lines are indented, with the following syntax:
1.32 kristaps 413: .Bd -literal -offset indent
1.27 kristaps 414: \&.HP [width]
1.32 kristaps 415: .Ed
416: .
417: .Pp
1.38 kristaps 418: If scaling width
1.32 kristaps 419: .Va width
1.27 kristaps 420: is specified, it's saved for later paragraph left-margins; if
421: unspecified, the saved or default width is used.
1.39 kristaps 422: .Ss \&I
1.22 kristaps 423: Text is rendered in italics.
1.39 kristaps 424: .Ss \&IB
1.22 kristaps 425: Text is rendered alternately in italics and bold face. Whitespace
426: between arguments is omitted in output.
1.39 kristaps 427: .Ss \&IP
1.25 kristaps 428: Begin a paragraph with the following syntax:
1.32 kristaps 429: .Bd -literal -offset indent
1.25 kristaps 430: \&.IP [head [width]]
1.32 kristaps 431: .Ed
432: .
433: .Pp
1.25 kristaps 434: This follows the behaviour of the
1.39 kristaps 435: .Sx \&TP
1.26 kristaps 436: except for the macro syntax (all arguments on the line, instead of
1.27 kristaps 437: having next-line scope). If
1.32 kristaps 438: .Va width
1.27 kristaps 439: is specified, it's saved for later paragraph left-margins; if
440: unspecified, the saved or default width is used.
1.39 kristaps 441: .Ss \&IR
1.22 kristaps 442: Text is rendered alternately in italics and roman (the default font).
443: Whitespace between arguments is omitted in output.
1.39 kristaps 444: .Ss \&LP
1.22 kristaps 445: Begin an undecorated paragraph. The scope of a paragraph is closed by a
1.27 kristaps 446: subsequent paragraph, sub-section, section, or end of file. The saved
447: paragraph left-margin width is re-set to the default.
1.39 kristaps 448: .Ss \&P
449: Synonym for
450: .Sx \&LP .
451: .Ss \&PP
452: Synonym for
453: .Sx \&LP .
454: .Ss \&R
1.22 kristaps 455: Text is rendered in roman (the default font).
1.39 kristaps 456: .Ss \&RB
1.22 kristaps 457: Text is rendered alternately in roman (the default font) and bold face.
458: Whitespace between arguments is omitted in output.
1.39 kristaps 459: .Ss \&RE
1.30 kristaps 460: Explicitly close out the scope of a prior
1.39 kristaps 461: .Sx \&RS .
462: .Ss \&RI
1.22 kristaps 463: Text is rendered alternately in roman (the default font) and italics.
464: Whitespace between arguments is omitted in output.
1.39 kristaps 465: .Ss \&RS
1.30 kristaps 466: Begin a part setting the left margin. The left margin controls the
467: offset, following an initial indentation, to un-indented text such as
468: that of
1.39 kristaps 469: .Sx \&PP .
1.38 kristaps 470: A scaling width may be specified as following:
1.32 kristaps 471: .Bd -literal -offset indent
1.30 kristaps 472: \&.RS [width]
1.32 kristaps 473: .Ed
474: .
475: .Pp
1.30 kristaps 476: If
1.32 kristaps 477: .Va width
1.30 kristaps 478: is not specified, the saved or default width is used.
1.39 kristaps 479: .Ss \&SB
1.22 kristaps 480: Text is rendered in small size (one point smaller than the default font)
481: bold face.
1.39 kristaps 482: .Ss \&SH
1.22 kristaps 483: Begin a section. The scope of a section is only closed by another
1.27 kristaps 484: section or the end of file. The paragraph left-margin width is re-set
485: to the default.
1.39 kristaps 486: .Ss \&SM
1.22 kristaps 487: Text is rendered in small size (one point smaller than the default
488: font).
1.39 kristaps 489: .Ss \&SS
1.22 kristaps 490: Begin a sub-section. The scope of a sub-section is closed by a
1.27 kristaps 491: subsequent sub-section, section, or end of file. The paragraph
492: left-margin width is re-set to the default.
1.39 kristaps 493: .Ss \&TH
1.22 kristaps 494: Sets the title of the manual page with the following syntax:
1.32 kristaps 495: .Bd -literal -offset indent
1.30 kristaps 496: \&.TH title section [date [source [volume]]]
1.32 kristaps 497: .Ed
498: .
499: .Pp
1.22 kristaps 500: At least the
1.32 kristaps 501: .Va title
1.22 kristaps 502: and
1.32 kristaps 503: .Va section
1.22 kristaps 504: arguments must be provided. The
1.32 kristaps 505: .Va date
1.22 kristaps 506: argument should be formatted as
1.32 kristaps 507: .Qq %b [%d] %Y
1.22 kristaps 508: format, described in
1.32 kristaps 509: .Xr strptime 3 .
1.22 kristaps 510: The
1.32 kristaps 511: .Va source
1.22 kristaps 512: string specifies the organisation providing the utility. The
1.32 kristaps 513: .Va volume
1.22 kristaps 514: replaces the default rendered volume as dictated by the manual section.
1.39 kristaps 515: .Ss \&TP
1.25 kristaps 516: Begin a paragraph where the head, if exceeding the indentation width, is
1.24 kristaps 517: followed by a newline; if not, the body follows on the same line after a
1.25 kristaps 518: buffer to the indentation width. Subsequent output lines are indented.
1.32 kristaps 519: .
520: .Pp
1.38 kristaps 521: The indentation scaling width may be set as follows:
1.32 kristaps 522: .Bd -literal -offset indent
1.26 kristaps 523: \&.TP [width]
1.32 kristaps 524: .Ed
525: .
526: .Pp
1.38 kristaps 527: If
1.32 kristaps 528: .Va width
1.27 kristaps 529: is specified, it's saved for later paragraph left-margins; if
530: unspecified, the saved or default width is used.
1.40 ! kristaps 531: .Ss \&PD
! 532: Has no effect. Included for compatibility.
1.39 kristaps 533: .Ss \&UC
1.37 kristaps 534: Has no effect. Included for compatibility.
1.39 kristaps 535: .Ss \&br
1.22 kristaps 536: Breaks the current line. Consecutive invocations have no further effect.
1.39 kristaps 537: .Ss \&fi
1.22 kristaps 538: End literal mode begun by
1.39 kristaps 539: .Sx \&nf .
540: .Ss \&i
1.22 kristaps 541: Italicise arguments. If no arguments are specified, all subsequent text
542: is italicised.
1.39 kristaps 543: .Ss \&na
1.36 kristaps 544: Don't align to the right margin.
1.39 kristaps 545: .Ss \&nf
1.22 kristaps 546: Begin literal mode: all subsequent free-form lines have their end of
547: line boundaries preserved. May be ended by
1.39 kristaps 548: .Sx \&fi .
549: .Ss \&r
1.22 kristaps 550: Fonts and styles (bold face, italics) reset to roman (default font).
1.39 kristaps 551: .Ss \&sp
1.22 kristaps 552: Insert n spaces, where n is the macro's positive numeric argument. If
553: 0, this is equivalent to the
1.39 kristaps 554: .Sx \&br
1.22 kristaps 555: macro.
1.28 kristaps 556: .
557: .
1.18 kristaps 558: .Sh COMPATIBILITY
1.23 kristaps 559: This section documents compatibility with other roff implementations, at
560: this time limited to
1.32 kristaps 561: .Xr groff 1 .
562: .Bl -hyphen
563: .It
1.23 kristaps 564: In quoted literals, groff allowed pair-wise double-quotes to produce a
565: standalone double-quote in formatted output. This idiosyncratic
566: behaviour is no longer applicable.
1.32 kristaps 567: .It
1.23 kristaps 568: The
1.32 kristaps 569: .Sq sp
1.23 kristaps 570: macro does not accept negative numbers.
1.32 kristaps 571: .It
1.23 kristaps 572: Blocks of whitespace are stripped from both macro and free-form text
573: lines (except when in literal mode), while groff would retain whitespace
574: in free-form text lines.
1.32 kristaps 575: .El
1.28 kristaps 576: .
577: .
1.1 kristaps 578: .Sh SEE ALSO
1.32 kristaps 579: .Xr mandoc 1 ,
580: .Xr mandoc_char 7
1.28 kristaps 581: .
582: .
1.1 kristaps 583: .Sh AUTHORS
584: The
1.32 kristaps 585: .Nm
1.23 kristaps 586: reference was written by
1.32 kristaps 587: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.28 kristaps 588: .
589: .
1.1 kristaps 590: .Sh CAVEATS
591: Do not use this language. Use
1.32 kristaps 592: .Xr mdoc 7 ,
1.1 kristaps 593: instead.
1.28 kristaps 594: .
CVSweb