Annotation of mandoc/man.7, Revision 1.38
1.38 ! kristaps 1: .\" $Id: man.7,v 1.37 2009/09/05 10:37:09 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.32 kristaps 194: .Sq 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.32 kristaps 201: .Sq 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
247: sit between the control character and the macro name. Thus,
1.32 kristaps 248: .Sq .PP
1.2 kristaps 249: and
1.32 kristaps 250: .Sq \&.\ \ \ PP
1.2 kristaps 251: are equivalent.
1.32 kristaps 252: .
253: .Pp
1.1 kristaps 254: The
1.32 kristaps 255: .Nm
1.30 kristaps 256: macros are classified by scope: line scope or block scope. Line
1.22 kristaps 257: macros are only scoped to the current line (and, in some situations,
258: the subsequent line). Block macros are scoped to the current line and
259: subsequent lines until closed by another block macro.
1.28 kristaps 260: .
261: .
1.32 kristaps 262: .Ss Line Macros
1.30 kristaps 263: Line macros are generally scoped to the current line, with the body
264: consisting of zero or more arguments. If a macro is scoped to the next
265: line and the line arguments are empty, the next line is used instead,
266: else the general syntax is used. Thus:
1.32 kristaps 267: .Bd -literal -offset indent
1.30 kristaps 268: \&.I
1.4 kristaps 269: foo
1.32 kristaps 270: .Ed
271: .
272: .Pp
1.20 kristaps 273: is equivalent to
1.32 kristaps 274: .Sq \&.I foo .
1.35 kristaps 275: If next-line macros are invoked consecutively, only the last is used.
276: If a next-line macro is proceded by a block macro, it is ignored.
1.32 kristaps 277: .Bd -literal -offset indent
1.22 kristaps 278: \&.YO \(lBbody...\(rB
279: \(lBbody...\(rB
1.32 kristaps 280: .Ed
281: .
282: .Pp
283: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
284: .It Em Macro Ta Em Arguments Ta Em Scope
285: .It B Ta n Ta next-line
286: .It BI Ta n Ta current
287: .It BR Ta n Ta current
288: .It DT Ta 0 Ta current
289: .It I Ta n Ta next-line
290: .It IB Ta n Ta current
291: .It IR Ta n Ta current
292: .It R Ta n Ta next-line
293: .It RB Ta n Ta current
294: .It RI Ta n Ta current
295: .It SB Ta n Ta next-line
296: .It SM Ta n Ta next-line
297: .It TH Ta >1, <6 Ta current
1.36 kristaps 298: .It UC Ta n Ta current
1.32 kristaps 299: .It br Ta 0 Ta current
300: .It fi Ta 0 Ta current
301: .It i Ta n Ta current
302: .It na Ta 0 Ta current
303: .It nf Ta 0 Ta current
304: .It r Ta 0 Ta current
305: .It sp Ta 1 Ta current
306: .El
307: .
308: .Pp
1.31 kristaps 309: The
1.32 kristaps 310: .Sq RS ,
311: .Sq RE ,
1.36 kristaps 312: .Sq UC ,
1.32 kristaps 313: .Sq br ,
314: .Sq fi ,
315: .Sq i ,
316: .Sq na ,
317: .Sq nf ,
318: .Sq r ,
1.22 kristaps 319: and
1.32 kristaps 320: .Sq sp
1.36 kristaps 321: macros should not be used. They're included for compatibility.
1.28 kristaps 322: .
323: .
1.32 kristaps 324: .Ss Block Macros
1.30 kristaps 325: Block macros are comprised of a head and body. Like for in-line macros,
326: the head is scoped to the current line and, in one circumstance, the
327: next line; the body is scoped to subsequent lines and is closed out by a
328: subsequent block macro invocation.
1.32 kristaps 329: .Bd -literal -offset indent
1.22 kristaps 330: \&.YO \(lBhead...\(rB
331: \(lBhead...\(rB
332: \(lBbody...\(rB
1.32 kristaps 333: .Ed
334: .
335: .Pp
1.30 kristaps 336: The closure of body scope may be to the section, where a macro is closed
337: by
1.32 kristaps 338: .Sq SH ;
1.30 kristaps 339: sub-section, closed by a section or
1.32 kristaps 340: .Sq SS ;
1.30 kristaps 341: part, closed by a section, sub-section, or
1.32 kristaps 342: .Sq RE ;
1.30 kristaps 343: or paragraph, closed by a section, sub-section, part,
1.32 kristaps 344: .Sq HP ,
345: .Sq IP ,
346: .Sq LP ,
347: .Sq P ,
348: .Sq PP ,
1.30 kristaps 349: or
1.32 kristaps 350: .Sq TP .
1.30 kristaps 351: No closure refers to an explicit block closing macro.
1.32 kristaps 352: .
353: .Pp
354: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
355: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
356: .It HP Ta <2 Ta current Ta paragraph
357: .It IP Ta <3 Ta current Ta paragraph
358: .It LP Ta 0 Ta current Ta paragraph
359: .It P Ta 0 Ta current Ta paragraph
360: .It PP Ta 0 Ta current Ta paragraph
361: .It RE Ta 0 Ta current Ta none
362: .It RS Ta 1 Ta current Ta part
1.34 kristaps 363: .It SH Ta >0 Ta next-line Ta section
364: .It SS Ta >0 Ta next-line Ta sub-section
1.32 kristaps 365: .It TP Ta n Ta next-line Ta paragraph
366: .El
367: .
368: .Pp
1.22 kristaps 369: If a block macro is next-line scoped, it may only be followed by in-line
370: macros (excluding
1.32 kristaps 371: .Sq DT ,
372: .Sq TH ,
1.36 kristaps 373: .Sq UC ,
1.32 kristaps 374: .Sq br ,
375: .Sq na ,
376: .Sq sp ,
377: .Sq nf ,
1.22 kristaps 378: and
1.32 kristaps 379: .Sq fi ) .
1.28 kristaps 380: .
381: .
1.22 kristaps 382: .Sh REFERENCE
383: This section is a canonical reference to all macros, arranged
384: alphabetically. For the scoping of individual macros, see
1.32 kristaps 385: .Sx MACRO SYNTAX .
1.28 kristaps 386: .
1.32 kristaps 387: .Bl -tag -width Ds
388: .It B
1.22 kristaps 389: Text is rendered in bold face.
1.32 kristaps 390: .It BI
1.22 kristaps 391: Text is rendered alternately in bold face and italic. Thus,
1.32 kristaps 392: .Sq .BI this word and that
1.22 kristaps 393: causes
1.32 kristaps 394: .Sq this
1.22 kristaps 395: and
1.32 kristaps 396: .Sq and
1.22 kristaps 397: to render in bold face, while
1.32 kristaps 398: .Sq word
1.22 kristaps 399: and
1.32 kristaps 400: .Sq that
1.22 kristaps 401: render in italics. Whitespace between arguments is omitted in output.
1.32 kristaps 402: .It BR
1.22 kristaps 403: Text is rendered alternately in bold face and roman (the default font).
404: Whitespace between arguments is omitted in output.
1.32 kristaps 405: .It DT
1.36 kristaps 406: Has no effect. Included for compatibility.
1.32 kristaps 407: .It HP
1.23 kristaps 408: Begin a paragraph whose initial output line is left-justified, but
1.27 kristaps 409: subsequent output lines are indented, with the following syntax:
1.32 kristaps 410: .Bd -literal -offset indent
1.27 kristaps 411: \&.HP [width]
1.32 kristaps 412: .Ed
413: .
414: .Pp
1.38 ! kristaps 415: If scaling width
1.32 kristaps 416: .Va width
1.27 kristaps 417: is specified, it's saved for later paragraph left-margins; if
418: unspecified, the saved or default width is used.
1.32 kristaps 419: .It I
1.22 kristaps 420: Text is rendered in italics.
1.32 kristaps 421: .It IB
1.22 kristaps 422: Text is rendered alternately in italics and bold face. Whitespace
423: between arguments is omitted in output.
1.32 kristaps 424: .It IP
1.25 kristaps 425: Begin a paragraph with the following syntax:
1.32 kristaps 426: .Bd -literal -offset indent
1.25 kristaps 427: \&.IP [head [width]]
1.32 kristaps 428: .Ed
429: .
430: .Pp
1.25 kristaps 431: This follows the behaviour of the
1.32 kristaps 432: .Sq TP
1.26 kristaps 433: except for the macro syntax (all arguments on the line, instead of
1.27 kristaps 434: having next-line scope). If
1.32 kristaps 435: .Va width
1.27 kristaps 436: is specified, it's saved for later paragraph left-margins; if
437: unspecified, the saved or default width is used.
1.32 kristaps 438: .It IR
1.22 kristaps 439: Text is rendered alternately in italics and roman (the default font).
440: Whitespace between arguments is omitted in output.
1.32 kristaps 441: .It LP, P, PP
1.22 kristaps 442: Begin an undecorated paragraph. The scope of a paragraph is closed by a
1.27 kristaps 443: subsequent paragraph, sub-section, section, or end of file. The saved
444: paragraph left-margin width is re-set to the default.
1.32 kristaps 445: .It R
1.22 kristaps 446: Text is rendered in roman (the default font).
1.32 kristaps 447: .It RB
1.22 kristaps 448: Text is rendered alternately in roman (the default font) and bold face.
449: Whitespace between arguments is omitted in output.
1.32 kristaps 450: .It RE
1.30 kristaps 451: Explicitly close out the scope of a prior
1.32 kristaps 452: .Sq RS .
453: .It RI
1.22 kristaps 454: Text is rendered alternately in roman (the default font) and italics.
455: Whitespace between arguments is omitted in output.
1.32 kristaps 456: .It RS
1.30 kristaps 457: Begin a part setting the left margin. The left margin controls the
458: offset, following an initial indentation, to un-indented text such as
459: that of
1.32 kristaps 460: .Sq PP .
1.38 ! kristaps 461: A scaling width may be specified as following:
1.32 kristaps 462: .Bd -literal -offset indent
1.30 kristaps 463: \&.RS [width]
1.32 kristaps 464: .Ed
465: .
466: .Pp
1.30 kristaps 467: If
1.32 kristaps 468: .Va width
1.30 kristaps 469: is not specified, the saved or default width is used.
1.32 kristaps 470: .It SB
1.22 kristaps 471: Text is rendered in small size (one point smaller than the default font)
472: bold face.
1.32 kristaps 473: .It SH
1.22 kristaps 474: Begin a section. The scope of a section is only closed by another
1.27 kristaps 475: section or the end of file. The paragraph left-margin width is re-set
476: to the default.
1.32 kristaps 477: .It SM
1.22 kristaps 478: Text is rendered in small size (one point smaller than the default
479: font).
1.32 kristaps 480: .It SS
1.22 kristaps 481: Begin a sub-section. The scope of a sub-section is closed by a
1.27 kristaps 482: subsequent sub-section, section, or end of file. The paragraph
483: left-margin width is re-set to the default.
1.32 kristaps 484: .It TH
1.22 kristaps 485: Sets the title of the manual page with the following syntax:
1.32 kristaps 486: .Bd -literal -offset indent
1.30 kristaps 487: \&.TH title section [date [source [volume]]]
1.32 kristaps 488: .Ed
489: .
490: .Pp
1.22 kristaps 491: At least the
1.32 kristaps 492: .Va title
1.22 kristaps 493: and
1.32 kristaps 494: .Va section
1.22 kristaps 495: arguments must be provided. The
1.32 kristaps 496: .Va date
1.22 kristaps 497: argument should be formatted as
1.32 kristaps 498: .Qq %b [%d] %Y
1.22 kristaps 499: format, described in
1.32 kristaps 500: .Xr strptime 3 .
1.22 kristaps 501: The
1.32 kristaps 502: .Va source
1.22 kristaps 503: string specifies the organisation providing the utility. The
1.32 kristaps 504: .Va volume
1.22 kristaps 505: replaces the default rendered volume as dictated by the manual section.
1.32 kristaps 506: .It TP
1.25 kristaps 507: Begin a paragraph where the head, if exceeding the indentation width, is
1.24 kristaps 508: followed by a newline; if not, the body follows on the same line after a
1.25 kristaps 509: buffer to the indentation width. Subsequent output lines are indented.
1.32 kristaps 510: .
511: .Pp
1.38 ! kristaps 512: The indentation scaling width may be set as follows:
1.32 kristaps 513: .Bd -literal -offset indent
1.26 kristaps 514: \&.TP [width]
1.32 kristaps 515: .Ed
516: .
517: .Pp
1.38 ! kristaps 518: If
1.32 kristaps 519: .Va width
1.27 kristaps 520: is specified, it's saved for later paragraph left-margins; if
521: unspecified, the saved or default width is used.
1.37 kristaps 522: .It UC
523: Has no effect. Included for compatibility.
1.32 kristaps 524: .It br
1.22 kristaps 525: Breaks the current line. Consecutive invocations have no further effect.
1.32 kristaps 526: .It fi
1.22 kristaps 527: End literal mode begun by
1.32 kristaps 528: .Sq nf .
529: .It i
1.22 kristaps 530: Italicise arguments. If no arguments are specified, all subsequent text
531: is italicised.
1.32 kristaps 532: .It na
1.36 kristaps 533: Don't align to the right margin.
1.32 kristaps 534: .It nf
1.22 kristaps 535: Begin literal mode: all subsequent free-form lines have their end of
536: line boundaries preserved. May be ended by
1.32 kristaps 537: .Sq fi .
538: .It r
1.22 kristaps 539: Fonts and styles (bold face, italics) reset to roman (default font).
1.32 kristaps 540: .It sp
1.22 kristaps 541: Insert n spaces, where n is the macro's positive numeric argument. If
542: 0, this is equivalent to the
1.32 kristaps 543: .Sq br
1.22 kristaps 544: macro.
1.32 kristaps 545: .El
1.28 kristaps 546: .
547: .
1.18 kristaps 548: .Sh COMPATIBILITY
1.23 kristaps 549: This section documents compatibility with other roff implementations, at
550: this time limited to
1.32 kristaps 551: .Xr groff 1 .
552: .Bl -hyphen
553: .It
1.23 kristaps 554: In quoted literals, groff allowed pair-wise double-quotes to produce a
555: standalone double-quote in formatted output. This idiosyncratic
556: behaviour is no longer applicable.
1.32 kristaps 557: .It
1.23 kristaps 558: The
1.32 kristaps 559: .Sq sp
1.23 kristaps 560: macro does not accept negative numbers.
1.32 kristaps 561: .It
1.23 kristaps 562: Blocks of whitespace are stripped from both macro and free-form text
563: lines (except when in literal mode), while groff would retain whitespace
564: in free-form text lines.
1.32 kristaps 565: .El
1.28 kristaps 566: .
567: .
1.1 kristaps 568: .Sh SEE ALSO
1.32 kristaps 569: .Xr mandoc 1 ,
570: .Xr mandoc_char 7
1.28 kristaps 571: .
572: .
1.1 kristaps 573: .Sh AUTHORS
574: The
1.32 kristaps 575: .Nm
1.23 kristaps 576: reference was written by
1.32 kristaps 577: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.28 kristaps 578: .
579: .
1.1 kristaps 580: .Sh CAVEATS
581: Do not use this language. Use
1.32 kristaps 582: .Xr mdoc 7 ,
1.1 kristaps 583: instead.
1.28 kristaps 584: .
CVSweb