Annotation of src/usr.bin/mandoc/mandoc.1, Revision 1.60
1.60 ! schwarze 1: .\" $OpenBSD: mandoc.1,v 1.59 2014/08/08 16:25:15 schwarze Exp $
1.1 kristaps 2: .\"
1.44 schwarze 3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.58 schwarze 4: .\" Copyright (c) 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
1.3 schwarze 7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: .\"
1.3 schwarze 10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: .\"
1.60 ! schwarze 18: .Dd $Mdocdate: August 8 2014 $
1.2 deraadt 19: .Dt MANDOC 1
1.1 kristaps 20: .Os
21: .Sh NAME
22: .Nm mandoc
23: .Nd format and display UNIX manuals
24: .Sh SYNOPSIS
25: .Nm mandoc
1.60 ! schwarze 26: .Op Fl acV
1.54 schwarze 27: .Sm off
28: .Op Fl I Cm os Li = Ar name
29: .Sm on
1.1 kristaps 30: .Op Fl m Ns Ar format
1.26 jmc 31: .Op Fl O Ns Ar option
1.17 schwarze 32: .Op Fl T Ns Ar output
1.38 schwarze 33: .Op Fl W Ns Ar level
1.45 schwarze 34: .Op Ar
1.1 kristaps 35: .Sh DESCRIPTION
36: The
37: .Nm
1.10 schwarze 38: utility formats
1.1 kristaps 39: .Ux
1.25 jmc 40: manual pages for display.
1.53 schwarze 41: .Pp
42: By default,
43: .Nm
44: reads
45: .Xr mdoc 7
46: or
47: .Xr man 7
48: text from stdin, implying
49: .Fl m Ns Cm andoc ,
50: and produces
51: .Fl T Ns Cm ascii
52: output.
53: .Pp
1.25 jmc 54: The arguments are as follows:
1.5 schwarze 55: .Bl -tag -width Ds
1.60 ! schwarze 56: .It Fl a
! 57: If the standard output is a terminal device and
! 58: .Fl c
! 59: is not specified, use
! 60: .Xr more 1
! 61: to paginate the output, just like
! 62: .Xr man 1
! 63: would.
! 64: .It Fl c
! 65: Copy the formatted manual pages to the standard output without using
! 66: .Xr more 1
! 67: to paginate them.
! 68: This is the default.
! 69: It can be specified to override
! 70: .Fl a .
1.54 schwarze 71: .Sm off
72: .It Fl I Cm os Li = Ar name
73: .Sm on
74: Override the default operating system
75: .Ar name
76: for the
77: .Xr mdoc 7
78: .Sq \&Os
79: macro.
1.1 kristaps 80: .It Fl m Ns Ar format
1.25 jmc 81: Input format.
82: See
1.1 kristaps 83: .Sx Input Formats
1.25 jmc 84: for available formats.
85: Defaults to
1.26 jmc 86: .Fl m Ns Cm andoc .
87: .It Fl O Ns Ar option
1.25 jmc 88: Comma-separated output options.
1.1 kristaps 89: .It Fl T Ns Ar output
1.25 jmc 90: Output format.
91: See
1.1 kristaps 92: .Sx Output Formats
1.25 jmc 93: for available formats.
94: Defaults to
1.26 jmc 95: .Fl T Ns Cm ascii .
1.4 schwarze 96: .It Fl V
97: Print version and exit.
1.38 schwarze 98: .It Fl W Ns Ar level
99: Specify the minimum message
100: .Ar level
101: to be reported on the standard error output and to affect the exit status.
102: The
103: .Ar level
104: can be
105: .Cm warning ,
106: .Cm error ,
107: or
108: .Cm fatal .
109: The default is
110: .Fl W Ns Cm fatal ;
1.26 jmc 111: .Fl W Ns Cm all
1.38 schwarze 112: is an alias for
113: .Fl W Ns Cm warning .
114: See
115: .Sx EXIT STATUS
116: and
117: .Sx DIAGNOSTICS
118: for details.
119: .Pp
120: The special option
121: .Fl W Ns Cm stop
122: tells
123: .Nm
124: to exit after parsing a file that causes warnings or errors of at least
125: the requested level.
126: No formatted output will be produced from that file.
127: If both a
128: .Ar level
129: and
130: .Cm stop
131: are requested, they can be joined with a comma, for example
132: .Fl W Ns Cm error , Ns Cm stop .
1.26 jmc 133: .It Ar file
134: Read input from zero or more files.
1.25 jmc 135: If unspecified, reads from stdin.
136: If multiple files are specified,
1.1 kristaps 137: .Nm
138: will halt with the first failed parse.
139: .El
140: .Ss Input Formats
141: The
142: .Nm
143: utility accepts
144: .Xr mdoc 7
145: and
146: .Xr man 7
147: input with
1.26 jmc 148: .Fl m Ns Cm doc
1.1 kristaps 149: and
1.26 jmc 150: .Fl m Ns Cm an ,
1.25 jmc 151: respectively.
152: The
1.1 kristaps 153: .Xr mdoc 7
154: format is
155: .Em strongly
1.10 schwarze 156: recommended;
1.1 kristaps 157: .Xr man 7
158: should only be used for legacy manuals.
159: .Pp
160: A third option,
1.26 jmc 161: .Fl m Ns Cm andoc ,
1.1 kristaps 162: which is also the default, determines encoding on-the-fly: if the first
1.10 schwarze 163: non-comment macro is
1.11 schwarze 164: .Sq \&Dd
1.1 kristaps 165: or
1.11 schwarze 166: .Sq \&Dt ,
1.10 schwarze 167: the
1.1 kristaps 168: .Xr mdoc 7
169: parser is used; otherwise, the
170: .Xr man 7
171: parser is used.
172: .Pp
173: If multiple
1.10 schwarze 174: files are specified with
1.26 jmc 175: .Fl m Ns Cm andoc ,
1.25 jmc 176: each has its file-type determined this way.
177: If multiple files are
1.1 kristaps 178: specified and
1.26 jmc 179: .Fl m Ns Cm doc
1.1 kristaps 180: or
1.26 jmc 181: .Fl m Ns Cm an
1.1 kristaps 182: is specified, then this format is used exclusively.
183: .Ss Output Formats
184: The
185: .Nm
186: utility accepts the following
187: .Fl T
1.34 schwarze 188: arguments, which correspond to output modes:
1.48 jmc 189: .Bl -tag -width "-Tlocale"
1.26 jmc 190: .It Fl T Ns Cm ascii
1.42 schwarze 191: Produce 7-bit ASCII output.
1.25 jmc 192: This is the default.
193: See
1.20 schwarze 194: .Sx ASCII Output .
1.26 jmc 195: .It Fl T Ns Cm html
1.42 schwarze 196: Produce strict CSS1/HTML-4.01 output.
1.25 jmc 197: See
1.20 schwarze 198: .Sx HTML Output .
1.26 jmc 199: .It Fl T Ns Cm lint
200: Parse only: produce no output.
201: Implies
1.38 schwarze 202: .Fl W Ns Cm warning .
1.48 jmc 203: .It Fl T Ns Cm locale
204: Encode output using the current locale.
205: See
206: .Sx Locale Output .
1.46 schwarze 207: .It Fl T Ns Cm man
1.49 schwarze 208: Produce
1.46 schwarze 209: .Xr man 7
1.49 schwarze 210: format output.
211: See
212: .Sx Man Output .
1.36 schwarze 213: .It Fl T Ns Cm pdf
214: Produce PDF output.
215: See
216: .Sx PDF Output .
1.31 schwarze 217: .It Fl T Ns Cm ps
218: Produce PostScript output.
219: See
220: .Sx PostScript Output .
1.26 jmc 221: .It Fl T Ns Cm tree
222: Produce an indented parse tree.
1.48 jmc 223: .It Fl T Ns Cm utf8
224: Encode output in the UTF\-8 multi-byte format.
225: See
226: .Sx UTF\-8 Output .
1.26 jmc 227: .It Fl T Ns Cm xhtml
1.42 schwarze 228: Produce strict CSS1/XHTML-1.0 output.
1.25 jmc 229: See
1.21 schwarze 230: .Sx XHTML Output .
1.1 kristaps 231: .El
232: .Pp
233: If multiple input files are specified, these will be processed by the
234: corresponding filter in-order.
1.34 schwarze 235: .Ss ASCII Output
236: Output produced by
237: .Fl T Ns Cm ascii ,
238: which is the default, is rendered in standard 7-bit ASCII documented in
239: .Xr ascii 7 .
240: .Pp
241: Font styles are applied by using back-spaced encoding such that an
242: underlined character
243: .Sq c
244: is rendered as
245: .Sq _ Ns \e[bs] Ns c ,
246: where
247: .Sq \e[bs]
248: is the back-space character number 8.
249: Emboldened characters are rendered as
250: .Sq c Ns \e[bs] Ns c .
251: .Pp
252: The special characters documented in
253: .Xr mandoc_char 7
254: are rendered best-effort in an ASCII equivalent.
1.44 schwarze 255: If no equivalent is found,
256: .Sq \&?
257: is used instead.
1.34 schwarze 258: .Pp
259: Output width is limited to 78 visible columns unless literal input lines
260: exceed this limit.
261: .Pp
262: The following
263: .Fl O
264: arguments are accepted:
1.5 schwarze 265: .Bl -tag -width Ds
1.51 schwarze 266: .It Cm indent Ns = Ns Ar indent
267: The left margin for normal text is set to
268: .Ar indent
269: blank characters instead of the default of five for
270: .Xr mdoc 7
271: and seven for
272: .Xr man 7 .
273: Increasing this is not recommended; it may result in degraded formatting,
1.52 jmc 274: for example overfull lines or ugly line breaks.
1.34 schwarze 275: .It Cm width Ns = Ns Ar width
276: The output width is set to
277: .Ar width ,
278: which will normalise to \(>=60.
1.1 kristaps 279: .El
1.34 schwarze 280: .Ss HTML Output
281: Output produced by
282: .Fl T Ns Cm html
283: conforms to HTML-4.01 strict.
284: .Pp
1.30 schwarze 285: The
1.34 schwarze 286: .Pa example.style.css
1.42 schwarze 287: file documents style-sheet classes available for customising output.
288: If a style-sheet is not specified with
289: .Fl O Ns Ar style ,
290: .Fl T Ns Cm html
291: defaults to simple output readable in any graphical or text-based web
292: browser.
1.34 schwarze 293: .Pp
1.45 schwarze 294: Special characters are rendered in decimal-encoded UTF\-8.
1.34 schwarze 295: .Pp
296: The following
1.33 schwarze 297: .Fl O
1.34 schwarze 298: arguments are accepted:
1.17 schwarze 299: .Bl -tag -width Ds
1.49 schwarze 300: .It Cm fragment
1.50 schwarze 301: Omit the
302: .Aq !DOCTYPE
303: declaration and the
304: .Aq html ,
305: .Aq head ,
306: and
307: .Aq body
308: elements and only emit the subtree below the
309: .Aq body
310: element.
1.49 schwarze 311: The
312: .Cm style
1.50 schwarze 313: argument will be ignored.
1.49 schwarze 314: This is useful when embedding manual content within existing documents.
1.33 schwarze 315: .It Cm includes Ns = Ns Ar fmt
1.17 schwarze 316: The string
317: .Ar fmt ,
1.21 schwarze 318: for example,
1.17 schwarze 319: .Ar ../src/%I.html ,
320: is used as a template for linked header files (usually via the
321: .Sq \&In
1.25 jmc 322: macro).
323: Instances of
1.17 schwarze 324: .Sq \&%I
1.25 jmc 325: are replaced with the include filename.
326: The default is not to present a
1.17 schwarze 327: hyperlink.
1.33 schwarze 328: .It Cm man Ns = Ns Ar fmt
1.17 schwarze 329: The string
330: .Ar fmt ,
1.21 schwarze 331: for example,
1.17 schwarze 332: .Ar ../html%S/%N.%S.html ,
333: is used as a template for linked manuals (usually via the
334: .Sq \&Xr
1.25 jmc 335: macro).
336: Instances of
1.17 schwarze 337: .Sq \&%N
338: and
339: .Sq %S
340: are replaced with the linked manual's name and section, respectively.
1.25 jmc 341: If no section is included, section 1 is assumed.
342: The default is not to
1.17 schwarze 343: present a hyperlink.
1.33 schwarze 344: .It Cm style Ns = Ns Ar style.css
1.26 jmc 345: The file
346: .Ar style.css
347: is used for an external style-sheet.
348: This must be a valid absolute or
349: relative URI.
1.30 schwarze 350: .El
1.48 jmc 351: .Ss Locale Output
352: Locale-depending output encoding is triggered with
353: .Fl T Ns Cm locale .
354: This option is not available on all systems: systems without locale
355: support, or those whose internal representation is not natively UCS-4,
356: will fall back to
357: .Fl T Ns Cm ascii .
358: See
359: .Sx ASCII Output
360: for font style specification and available command-line arguments.
1.49 schwarze 361: .Ss Man Output
362: Translate input format into
363: .Xr man 7
364: output format.
1.55 jmc 365: This is useful for distributing manual sources to legacy systems
1.49 schwarze 366: lacking
367: .Xr mdoc 7
368: formatters.
369: .Pp
370: If
371: .Xr mdoc 7
372: is passed as input, it is translated into
1.50 schwarze 373: .Xr man 7 .
374: If the input format is
1.49 schwarze 375: .Xr man 7 ,
1.50 schwarze 376: the input is copied to the output, expanding any
1.49 schwarze 377: .Xr roff 7
378: .Sq so
1.50 schwarze 379: requests.
380: The parser is also run, and as usual, the
381: .Fl W
382: level controls which
383: .Sx DIAGNOSTICS
384: are displayed before copying the input to the output.
1.48 jmc 385: .Ss PDF Output
386: PDF-1.1 output may be generated by
387: .Fl T Ns Cm pdf .
388: See
389: .Sx PostScript Output
390: for
391: .Fl O
392: arguments and defaults.
1.31 schwarze 393: .Ss PostScript Output
1.33 schwarze 394: PostScript
395: .Qq Adobe-3.0
396: Level-2 pages may be generated by
1.31 schwarze 397: .Fl T Ns Cm ps .
1.35 schwarze 398: Output pages default to letter sized and are rendered in the Times font
399: family, 11-point.
400: Margins are calculated as 1/9 the page length and width.
401: Line-height is 1.4m.
1.34 schwarze 402: .Pp
403: Special characters are rendered as in
404: .Sx ASCII Output .
405: .Pp
406: The following
407: .Fl O
408: arguments are accepted:
409: .Bl -tag -width Ds
410: .It Cm paper Ns = Ns Ar name
411: The paper size
412: .Ar name
413: may be one of
1.35 schwarze 414: .Ar a3 ,
415: .Ar a4 ,
416: .Ar a5 ,
417: .Ar legal ,
1.34 schwarze 418: or
419: .Ar letter .
1.35 schwarze 420: You may also manually specify dimensions as
421: .Ar NNxNN ,
422: width by height in millimetres.
423: If an unknown value is encountered,
424: .Ar letter
425: is used.
1.34 schwarze 426: .El
1.48 jmc 427: .Ss UTF\-8 Output
428: Use
429: .Fl T Ns Cm utf8
430: to force a UTF\-8 locale.
1.36 schwarze 431: See
1.48 jmc 432: .Sx Locale Output
433: for details and options.
1.21 schwarze 434: .Ss XHTML Output
435: Output produced by
1.26 jmc 436: .Fl T Ns Cm xhtml
1.21 schwarze 437: conforms to XHTML-1.0 strict.
438: .Pp
439: See
440: .Sx HTML Output
441: for details; beyond generating XHTML tags instead of HTML tags, these
442: output modes are identical.
1.60 ! schwarze 443: .Sh ENVIRONMENT
! 444: .Bl -tag -width MANPAGER
! 445: .It Ev MANPAGER
! 446: Any non-empty value of the environment variable
! 447: .Ev MANPAGER
! 448: will be used instead of the standard pagination program,
! 449: .Xr more 1 .
! 450: .It Ev PAGER
! 451: Specifies the pagination program to use when
! 452: .Ev MANPAGER
! 453: is not defined.
! 454: If neither PAGER nor MANPAGER is defined,
! 455: .Pa /usr/bin/more Fl s
! 456: will be used.
! 457: .El
1.38 schwarze 458: .Sh EXIT STATUS
459: The
460: .Nm
461: utility exits with one of the following values, controlled by the message
462: .Ar level
463: associated with the
464: .Fl W
465: option:
466: .Pp
467: .Bl -tag -width Ds -compact
468: .It 0
469: No warnings or errors occurred, or those that did were ignored because
470: they were lower than the requested
471: .Ar level .
472: .It 2
473: At least one warning occurred, but no error, and
474: .Fl W Ns Cm warning
475: was specified.
476: .It 3
477: At least one parsing error occurred, but no fatal error, and
478: .Fl W Ns Cm error
479: or
480: .Fl W Ns Cm warning
481: was specified.
482: .It 4
483: A fatal parsing error occurred.
484: .It 5
485: Invalid command line arguments were specified.
486: No input files have been read.
487: .It 6
488: An operating system error occurred, for example memory exhaustion or an
489: error accessing input files.
490: Such errors cause
491: .Nm
492: to exit at once, possibly in the middle of parsing or formatting a file.
493: .El
494: .Pp
495: Note that selecting
496: .Fl T Ns Cm lint
497: output mode implies
498: .Fl W Ns Cm warning .
1.1 kristaps 499: .Sh EXAMPLES
500: To page manuals to the terminal:
501: .Pp
1.42 schwarze 502: .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
503: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.12 schwarze 504: .Pp
1.17 schwarze 505: To produce HTML manuals with
506: .Ar style.css
507: as the style-sheet:
508: .Pp
1.42 schwarze 509: .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
1.17 schwarze 510: .Pp
1.12 schwarze 511: To check over a large set of manuals:
512: .Pp
1.38 schwarze 513: .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
1.34 schwarze 514: .Pp
515: To produce a series of PostScript manuals for A4 paper:
516: .Pp
1.42 schwarze 517: .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.46 schwarze 518: .Pp
519: Convert a modern
520: .Xr mdoc 7
521: manual to the older
522: .Xr man 7
523: format, for use on systems lacking an
524: .Xr mdoc 7
525: parser:
526: .Pp
527: .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
1.38 schwarze 528: .Sh DIAGNOSTICS
1.59 schwarze 529: Messages displayed by
530: .Nm
531: follow this format:
1.38 schwarze 532: .Pp
1.59 schwarze 533: .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
1.38 schwarze 534: .Pp
1.59 schwarze 535: Line and column numbers start at 1.
536: Both are omitted for messages referring to an input file as a whole.
537: Macro names and arguments are omitted where meaningless.
538: Fatal messages about invalid command line arguments
539: or operating system errors, for example when memory is exhausted,
540: may also omit the
541: .Ar file
1.57 schwarze 542: and
1.59 schwarze 543: .Ar level
544: fields.
1.57 schwarze 545: .Pp
1.38 schwarze 546: Message levels have the following meanings:
547: .Bl -tag -width "warning"
1.58 schwarze 548: .It Cm syserr
549: Opening or reading an input file failed, so the parser cannot
550: even be started and no output is produced from that input file.
1.38 schwarze 551: .It Cm fatal
552: The parser is unable to parse a given input file at all.
553: No formatted output is produced from that input file.
554: .It Cm error
555: An input file contains syntax that cannot be safely interpreted,
556: either because it is invalid or because
557: .Nm
558: does not implement it yet.
559: By discarding part of the input or inserting missing tokens,
560: the parser is able to continue, and the error does not prevent
561: generation of formatted output, but typically, preparing that
562: output involves information loss, broken document structure
563: or unintended formatting.
564: .It Cm warning
565: An input file uses obsolete, discouraged or non-portable syntax.
566: All the same, the meaning of the input is unambiguous and a correct
567: rendering can be produced.
568: Documents causing warnings may render poorly when using other
569: formatting tools instead of
570: .Nm .
571: .El
572: .Pp
573: Messages of the
574: .Cm warning
575: and
576: .Cm error
577: levels are hidden unless their level, or a lower level, is requested using a
578: .Fl W
579: option or
580: .Fl T Ns Cm lint
581: output mode.
1.6 schwarze 582: .Sh COMPATIBILITY
1.10 schwarze 583: This section summarises
1.6 schwarze 584: .Nm
1.39 schwarze 585: compatibility with GNU troff.
1.14 schwarze 586: Each input and output format is separately noted.
1.20 schwarze 587: .Ss ASCII Compatibility
1.6 schwarze 588: .Bl -bullet -compact
1.13 schwarze 589: .It
1.44 schwarze 590: Unrenderable unicode codepoints specified with
591: .Sq \e[uNNNN]
592: escapes are printed as
593: .Sq \&?
594: in mandoc.
595: In GNU troff, these raise an error.
596: .It
1.21 schwarze 597: The
1.14 schwarze 598: .Sq \&Bd \-literal
1.21 schwarze 599: and
1.14 schwarze 600: .Sq \&Bd \-unfilled
601: macros of
602: .Xr mdoc 7
603: in
1.26 jmc 604: .Fl T Ns Cm ascii
1.14 schwarze 605: are synonyms, as are \-filled and \-ragged.
606: .It
1.44 schwarze 607: In historic GNU troff, the
1.14 schwarze 608: .Sq \&Pa
609: .Xr mdoc 7
610: macro does not underline when scoped under an
611: .Sq \&It
1.25 jmc 612: in the FILES section.
613: This behaves correctly in
1.14 schwarze 614: .Nm .
1.10 schwarze 615: .It
1.26 jmc 616: A list or display following the
1.11 schwarze 617: .Sq \&Ss
1.14 schwarze 618: .Xr mdoc 7
619: macro in
1.26 jmc 620: .Fl T Ns Cm ascii
1.6 schwarze 621: does not assert a prior vertical break, just as it doesn't with
1.11 schwarze 622: .Sq \&Sh .
1.6 schwarze 623: .It
1.14 schwarze 624: The
625: .Sq \&na
626: .Xr man 7
1.16 schwarze 627: macro in
1.26 jmc 628: .Fl T Ns Cm ascii
1.16 schwarze 629: has no effect.
1.6 schwarze 630: .It
631: Words aren't hyphenated.
632: .El
1.21 schwarze 633: .Ss HTML/XHTML Compatibility
1.17 schwarze 634: .Bl -bullet -compact
635: .It
636: The
1.20 schwarze 637: .Sq \efP
638: escape will revert the font to the previous
639: .Sq \ef
640: escape, not to the last rendered decoration, which is now dictated by
1.25 jmc 641: CSS instead of hard-coded.
642: It also will not span past the current scope,
643: for the same reason.
644: Note that in
1.20 schwarze 645: .Sx ASCII Output
646: mode, this will work fine.
647: .It
648: The
1.17 schwarze 649: .Xr mdoc 7
650: .Sq \&Bl \-hang
651: and
652: .Sq \&Bl \-tag
653: list types render similarly (no break following overreached left-hand
654: side) due to the expressive constraints of HTML.
655: .It
656: The
657: .Xr man 7
658: .Sq IP
659: and
660: .Sq TP
661: lists render similarly.
662: .El
1.1 kristaps 663: .Sh SEE ALSO
1.47 schwarze 664: .Xr eqn 7 ,
1.25 jmc 665: .Xr man 7 ,
1.1 kristaps 666: .Xr mandoc_char 7 ,
1.43 schwarze 667: .Xr mdoc 7 ,
668: .Xr roff 7 ,
669: .Xr tbl 7
1.1 kristaps 670: .Sh AUTHORS
671: The
672: .Nm
1.10 schwarze 673: utility was written by
1.56 schwarze 674: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.17 schwarze 675: .Sh CAVEATS
676: In
1.26 jmc 677: .Fl T Ns Cm html
1.21 schwarze 678: and
1.26 jmc 679: .Fl T Ns Cm xhtml ,
1.17 schwarze 680: the maximum size of an element attribute is determined by
681: .Dv BUFSIZ ,
1.25 jmc 682: which is usually 1024 bytes.
683: Be aware of this when setting long link
1.26 jmc 684: formats such as
685: .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1.22 schwarze 686: .Pp
687: Nesting elements within next-line element scopes of
1.26 jmc 688: .Fl m Ns Cm an ,
1.22 schwarze 689: such as
690: .Sq br
691: within an empty
692: .Sq B ,
693: will confuse
1.26 jmc 694: .Fl T Ns Cm html
1.22 schwarze 695: and
1.26 jmc 696: .Fl T Ns Cm xhtml
1.23 schwarze 697: and cause them to forget the formatting of the prior next-line scope.
698: .Pp
1.24 schwarze 699: The
700: .Sq \(aq
701: control character is an alias for the standard macro control character
702: and does not emit a line-break as stipulated in GNU troff.
![[BACK]](/icons/back.gif){kind=icon}
Return to mandoc.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc