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