mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.139 and 1.170

version 1.139, 2015/01/28 17:32:07

version 1.170, 2017/01/12 17:29:33

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 23

.Nd format and display UNIX manuals

.Sh SYNOPSIS

.Nm mandoc

.Op Fl acfhklV

.Op Fl acfhkl

.Sm off

.Op Fl I Cm os Ns = Ns Ar name

.Op Fl I Cm os Li = Ar name

.Op Fl K Ar encoding

.Sm on

.Op Fl K Ns Ar encoding

.Op Fl m Ns Ar format

.Op Fl O Ns Ar option

.Op Fl O Ar option

.Op Fl T Ns Ar output

.Op Fl T Ar output

.Op Fl W Ns Ar level

.Op Fl W Ar level

.Op Ar

.Sh DESCRIPTION

The

Line 49 or

Line 47 or

text from stdin, implying

.Fl m Ns Cm andoc ,

and produces

.Fl T Ns Cm locale

.Fl T Cm locale

output.

.Pp

The options are as follows:

Line 77 This overrides any earlier

Line 75 This overrides any earlier

and

.Fl l

options.

.Sm off

.It Fl h

.It Fl I Cm os Li = Ar name

Display only the SYNOPSIS lines.

.Sm on

Implies

.Fl c .

.It Fl I Cm os Ns = Ns Ar name

Override the default operating system

.Ar name

for the

Line 89 and for the

.Xr man 7

.Sq \&TH

macro.

.It Fl h

.It Fl K Ar encoding

Display only the SYNOPSIS lines.

Implies

.Fl c .

.It Fl K Ns Ar encoding

Specify the input encoding.

The supported

.Ar encoding

Line 141 See

Line 137 See

for available formats.

Defaults to

.Fl m Ns Cm andoc .

.It Fl O Ns Ar option

.It Fl O Ar option

Comma-separated output options.

.It Fl T Ns Ar output

.It Fl T Ar output

Output format.

See

.Sx Output Formats

for available formats.

Defaults to

.Fl T Ns Cm locale .

.Fl T Cm locale .

.It Fl V

.It Fl W Ar level

Print version and exit.

.It Fl W Ns Ar level

Specify the minimum message

.Ar level

to be reported on the standard error output and to affect the exit status.

Line 176 and

Line 170 and

for details.

.Pp

The special option

.Fl W Ns Cm stop

.Fl W Cm stop

tells

.Nm

to exit after parsing a file that causes warnings or errors of at least

Line 187 If both a

Line 181 If both a

and

.Cm stop

are requested, they can be joined with a comma, for example

.Fl W Ns Cm error , Ns Cm stop .

.Fl W Cm error , Ns Cm stop .

.It Ar file

Read input from zero or more files.

If unspecified, reads from stdin.

Line 256 The

Line 250 The

utility accepts the following

.Fl T

arguments, which correspond to output modes:

.Bl -tag -width "-Tlocale"

.Bl -tag -width "-T locale"

.It Fl T Ns Cm ascii

.It Fl T Cm ascii

Produce 7-bit ASCII output.

See

.Sx ASCII Output .

.It Fl T Ns Cm html

.It Fl T Cm html

Produce HTML5, CSS1, and MathML output.

See

.Sx HTML Output .

.It Fl T Ns Cm lint

.It Fl T Cm lint

Parse only: produce no output.

Implies

.Fl W Ns Cm warning .

.Fl W Cm warning .

.It Fl T Ns Cm locale

.It Fl T Cm locale

Encode output using the current locale.

This is the default.

See

.Sx Locale Output .

.It Fl T Ns Cm man

.It Fl T Cm man

Produce

.Xr man 7

format output.

See

.Sx Man Output .

.It Fl T Ns Cm pdf

.It Fl T Cm pdf

Produce PDF output.

See

.Sx PDF Output .

.It Fl T Ns Cm ps

.It Fl T Cm ps

Produce PostScript output.

See

.Sx PostScript Output .

.It Fl T Ns Cm tree

.It Fl T Cm tree

Produce an indented parse tree.

.It Fl T Ns Cm utf8

See

.Sx Syntax tree output .

.It Fl T Cm utf8

Encode output in the UTF\-8 multi-byte format.

See

.Sx UTF\-8 Output .

.It Fl T Ns Cm xhtml

.It Fl T Cm xhtml

This is a synonym for

.Fl T Ns Cm html .

.Fl T Cm html .

.El

.Pp

If multiple input files are specified, these will be processed by the

corresponding filter in-order.

.Ss ASCII Output

Output produced by

.Fl T Ns Cm ascii

.Fl T Cm ascii

is rendered in standard 7-bit ASCII documented in

.Xr ascii 7 .

.Pp

Line 321 Emboldened characters are rendered as

Line 317 Emboldened characters are rendered as

The special characters documented in

.Xr mandoc_char 7

are rendered best-effort in an ASCII equivalent.

If no equivalent is found,

.Sq \&?

is used instead.

.Pp

Output width is limited to 78 visible columns unless literal input lines

exceed this limit.

Line 344 for example overfull lines or ugly line breaks.

Line 337 for example overfull lines or ugly line breaks.

.It Cm width Ns = Ns Ar width

The output width is set to

.Ar width ,

which will normalise to \(>=60.

which will normalise to \(>=58.

.El

.Ss HTML Output

Output produced by

.Fl T Ns Cm html

.Fl T Cm html

conforms to HTML5 using optional self-closing tags.

Default styles use only CSS1.

Equations rendered from

Line 356 Equations rendered from

Line 349 Equations rendered from

blocks use MathML.

.Pp

The

.Pa example.style.css

.Pa mandoc.css

file documents style-sheet classes available for customising output.

If a style-sheet is not specified with

.Fl O Ns Ar style ,

.Fl O Cm style ,

.Fl T Ns Cm html

.Fl T Cm html

defaults to simple output (via an embedded style-sheet)

readable in any graphical or text-based web

browser.

Line 416 relative URI.

Line 409 relative URI.

.El

.Ss Locale Output

Locale-depending output encoding is triggered with

.Fl T Ns Cm locale .

.Fl T Cm locale .

This is the default.

.Pp

This option is not available on all systems: systems without locale

support, or those whose internal representation is not natively UCS-4,

will fall back to

.Fl T Ns Cm ascii .

.Fl T Cm ascii .

See

.Sx ASCII Output

for font style specification and available command-line arguments.

Line 452 level controls which

Line 445 level controls which

are displayed before copying the input to the output.

.Ss PDF Output

PDF-1.1 output may be generated by

.Fl T Ns Cm pdf .

.Fl T Cm pdf .

See

.Sx PostScript Output

for

Line 462 arguments and defaults.

Line 455 arguments and defaults.

PostScript

.Qq Adobe-3.0

Level-2 pages may be generated by

.Fl T Ns Cm ps .

.Fl T Cm ps .

Output pages default to letter sized and are rendered in the Times font

family, 11-point.

Margins are calculated as 1/9 the page length and width.

Line 494 is used.

Line 487 is used.

.El

.Ss UTF\-8 Output

Use

.Fl T Ns Cm utf8

.Fl T Cm utf8

to force a UTF\-8 locale.

See

.Sx Locale Output

for details and options.

.Ss Syntax tree output

Use

.Fl T Cm tree

to show a human readable representation of the syntax tree.

It is useful for debugging the source code of manual pages.

The exact format is subject to change, so don't write parsers for it.

.Pp

The first paragraph shows meta data found in the

.Xr mdoc 7

prologue, on the

.Xr man 7

.Ic \&TH

line, or the fallbacks used.

.Pp

In the tree dump, each output line shows one syntax tree node.

Child nodes are indented with respect to their parent node.

The columns are:

.Pp

.Bl -enum -compact

.It

For macro nodes, the macro name; for text and

.Xr tbl 7

nodes, the content.

There is a special format for

.Xr eqn 7

nodes.

.It

Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).

.It

Flags:

.Bl -dash -compact

.It

An opening parenthesis if the node is an opening delimiter.

.It

An asterisk if the node starts a new input line.

.It

The input line number (starting at one).

.It

A colon.

.It

The input column number (starting at one).

.It

A closing parenthesis if the node is a closing delimiter.

.It

A full stop if the node ends a sentence.

.It

NOSRC if the node is not in the input file,

but automatically generated from macros.

.It

NOPRT if the node is not supposed to generate output

for any output format.

.El

.Sh ENVIRONMENT

.Bl -tag -width MANPAGER

.It Ev MANPAGER

Line 511 Specifies the pagination program to use when

Line 557 Specifies the pagination program to use when

.Ev MANPAGER

is not defined.

If neither PAGER nor MANPAGER is defined,

.Pa /usr/bin/more Fl s

.Xr more 1

.Fl s

will be used.

.El

.Sh EXIT STATUS

Line 530 they were lower than the requested

Line 577 they were lower than the requested

.Ar level .

.It 2

At least one warning occurred, but no error, and

.Fl W Ns Cm warning

.Fl W Cm warning

was specified.

.It 3

At least one parsing error occurred,

but no unsupported feature was encountered, and

.Fl W Ns Cm error

.Fl W Cm error

.Fl W Ns Cm warning

.Fl W Cm warning

was specified.

.It 4

At least one unsupported feature was encountered, and

.Fl W Ns Cm unsupp ,

.Fl W Cm unsupp ,

.Fl W Ns Cm error

.Fl W Cm error

.Fl W Ns Cm warning

.Fl W Cm warning

was specified.

.It 5

Invalid command line arguments were specified.

Line 558 to exit at once, possibly in the middle of parsing or

Line 605 to exit at once, possibly in the middle of parsing or

.El

.Pp

Note that selecting

.Fl T Ns Cm lint

.Fl T Cm lint

output mode implies

.Fl W Ns Cm warning .

.Fl W Cm warning .

.Sh EXAMPLES

To page manuals to the terminal:

.Pp

.Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less

.Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less

.Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less

.Pp

To produce HTML manuals with

.Ar style.css

.Pa mandoc.css

as the style-sheet:

.Pp

.Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html

.Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html

.Pp

To check over a large set of manuals:

.Pp

.Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`

.Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga

.Pp

To produce a series of PostScript manuals for A4 paper:

.Pp

.Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps

.Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps

.Pp

Convert a modern

.Xr mdoc 7

Line 589 format, for use on systems lacking an

Line 636 format, for use on systems lacking an

.Xr mdoc 7

parser:

.Pp

.Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man

.Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man

.Sh DIAGNOSTICS

Messages displayed by

.Nm

Line 656 levels except those about non-existent or unreadable i

Line 703 levels except those about non-existent or unreadable i

are hidden unless their level, or a lower level, is requested using a

.Fl W

option or

.Fl T Ns Cm lint

.Fl T Cm lint

output mode.

.Ss Warnings related to the document prologue

.Bl -ohang

Line 732 macro occurs after some non-prologue macro, but still

Line 779 macro occurs after some non-prologue macro, but still

.Pq mdoc

The

.Ic \&Dt

macro can only occur before the first non-prologue macro

macro appears after the first non-prologue macro.

because traditional formatters write the page header

Traditional formatters cannot handle this because

before parsing the document body.

they write the page header before parsing the document body.

Even though this technical restriction does not apply to

.Nm ,

traditional semantics is preserved.

Line 776 This may confuse

Line 823 This may confuse

.Xr makewhatis 8

and

.Xr apropos 1 .

.It Sy "bad NAME section contents"

.It Sy "NAME section without Nm before Nd"

.Pq mdoc

The last node in the NAME section is not an

The NAME section does not contain any

.Ic \&Nm

child macro before the first

.Ic \&Nd

macro, or any preceding macro is not

macro.

.Ic \&Nm ,

.It Sy "NAME section without description"

or the NAME section is completely empty.

.Pq mdoc

This may confuse

The NAME section lacks the mandatory

.Xr makewhatis 8

.Ic \&Nd

child macro.

.It Sy "description not at the end of NAME"

.Pq mdoc

The NAME section does contain an

.Ic \&Nd

child macro, but other content follows it.

.It Sy "bad NAME section content"

.Pq mdoc

The NAME section contains plain text or macros other than

.Ic \&Nm

and

.Xr apropos 1 .

.Ic \&Nd .

.It Sy "missing comma before name"

.Pq mdoc

The NAME section contains an

.Ic \&Nm

macro that is neither the first one nor preceded by a comma.

.It Sy "missing description line, using \(dq\(dq"

.Pq mdoc

The

.Ic \&Nd

macro lacks the required argument.

The title line of the manual will end after the dash.

.It Sy "sections out of conventional order"

.Pq mdoc

A standard section occurs after another section it usually precedes.

Line 806 In the SEE ALSO section, an

Line 876 In the SEE ALSO section, an

macro with a lower section number follows one with a higher number,

or two

.Ic \&Xr

macros refering to the same section are out of alphabetical order.

macros referring to the same section are out of alphabetical order.

.It Sy "unusual Xr punctuation"

.Pq mdoc

In the SEE ALSO section, punctuation between two

Line 833 manual for replacements.

Line 903 manual for replacements.

.Pq mdoc

The name of a macro that is not callable appears on a macro line.

It is printed verbatim.

If the intention is to call it, move it to its own line;

If the intention is to call it, move it to its own input line;

otherwise, escape it by prepending

.Sq \e& .

.It Sy "skipping paragraph macro"

Line 926 list block contains text or macros before the first

Line 996 list block contains text or macros before the first

.Ic \&It

macro.

The offending children are moved before the beginning of the list.

.It Sy ".Vt block has child macro"

.Pq mdoc

The

.Ic \&Vt

macro supports plain text arguments only.

Formatting may be ugly and semantic searching

for the affected content might not work.

.It Sy "fill mode already enabled, skipping"

.Pq man

Line 992 clause.

Line 1055 clause.

.It Sy "skipping empty macro"

.Pq mdoc

The indicated macro has no arguments and hence no effect.

.It Sy "empty block"

.Pq mdoc , man

.Ic \&Bd ,

.Ic \&Bk ,

.Ic \&Bl ,

.Ic \&D1 ,

.Ic \&Dl ,

.Ic \&RS ,

.Ic \&UR

block contains nothing in its body and will produce no output.

.It Sy "empty argument, using 0n"

.Pq mdoc

The required width is missing after

Line 1001 or

Line 1076 or

.Fl offset

.Fl width.

.It Sy "argument count wrong"

.Pq mdoc , man

The indicated macro has too few or too many arguments.

The syntax tree will contain the wrong number of arguments as given.

Formatting behaviour depends on the specific macro in question.

Note that the same message may also occur as an ERROR, see below.

.It Sy "missing display type, using -ragged"

.Pq mdoc

The

Line 1038 The

Line 1107 The

macro is called without an argument before

.Ic \&Nm

has first been called with an argument.

.It Sy "missing function name, using \(dq\(dq"

.Pq mdoc

The

.Ic \&Fo

macro is called without an argument.

No function name is printed.

.It Sy "empty head in list item"

.Pq mdoc

In a

Line 1065 list, an

Line 1140 list, an

.Ic \&It

block is empty.

An empty list item is shown.

.It Sy "missing font type"

.It Sy "missing font type, using \efR"

.Pq mdoc

.Ic \&Bf

macro has no argument.

It switches to the default font,

It switches to the default font.

.Cm \efR .

.It Sy "unknown font type, using \efR"

.It Sy "unknown font type"

.Pq mdoc

The

.Ic \&Bf

argument is invalid.

The default font

The default font is used instead.

.Cm \efR

is used instead.

.It Sy "nothing follows prefix"

.Pq mdoc

Line 1088 macro has no argument, or only one argument and no mac

Line 1160 macro has no argument, or only one argument and no mac

on the same input line.

This defeats its purpose; in particular, spacing is not suppressed

before the text or macros following on the next input line.

.It Sy "empty reference block"

.Pq mdoc

.Ic \&Rs

macro is immediately followed by an

.Ic \&Re

macro on the next input line.

Such an empty block does not produce any output.

.It Sy "missing section argument"

.Pq mdoc

.Ic \&Xr

macro lacks its second, section number argument.

The first argument, i.e. the name, is printed, but without subsequent

parentheses.

.It Sy "missing -std argument, adding it"

.Pq mdoc

Line 1102 The

Line 1189 The

utility assumes

.Fl std

even when it is not specified, but other implementations may not.

.It Sy "missing option string, using \(dq\(dq"

.Pq man

The

.Ic \&OP

macro is invoked without any argument.

An empty pair of square brackets is shown.

.It Sy "missing resource identifier, using \(dq\(dq"

.Pq man

The

.Ic \&UR

macro is invoked without any argument.

An empty pair of angle brackets is shown.

.It Sy "missing eqn box, using \(dq\(dq"

.Pq eqn

A diacritic mark or a binary operator is found,

Line 1166 list has a

Line 1265 list has a

.Fl width

argument.

That has no effect.

.It Sy "wrong number of cells"

In a line of a

.Ic \&Bl Fl column

list, the number of tabs or

.Ic \&Ta

macros is less than the number expected from the list header line

or exceeds the expected number by more than one.

Missing cells remain empty, and all cells exceeding the number of

columns are joined into one single cell.

.It Sy "unknown AT&T UNIX version"

.Pq mdoc

Line 1217 request or a

Line 1325 request or a

layout modifier has an unknown

.Ar font

argument.

.It Sy "odd number of characters in request"

.Pq roff

.Ic \&tr

request contains an odd number of characters.

The last character is mapped to the blank character.

.El

.Ss "Warnings related to plain text"

.Bl -ohang

Line 1291 Data provided for this cell is ignored, and nothing is

Line 1405 Data provided for this cell is ignored, and nothing is

A table layout specification contains more than two consecutive vertical bars.

A double bar is printed, all additional bars are discarded.

.El

.Ss "Errors related to equations"

.Bl -inset -compact

.It "unexpected equation scope closure"

.It "equation scope open on exit"

.It "overlapping equation scopes"

.It "unexpected end of equation"

.El

.Ss "Errors related to tables"

.Bl -ohang

.It Sy "non-alphabetic character in tbl options"

Line 1460 macros as well as tables require explicit closing by d

Line 1567 macros as well as tables require explicit closing by d

A block that doesn't support bad nesting

ends before all of its children are properly closed.

The open child nodes are closed implicitly.

.It Sy "scope open on exit"

.It Sy "appending missing end of block"

.Pq mdoc , man , eqn , tbl , roff

At the end of the document, an explicit

.Xr mdoc 7

Line 1510 When parsing for a request or a user-defined macro nam

Line 1617 When parsing for a request or a user-defined macro nam

only the escape sequence is discarded.

The characters preceding it are used as the request or macro name,

the characters following it are used as the arguments to the request or macro.

.It Sy "argument count wrong"

.Pq mdoc , man , roff

The indicated request or macro has too few or too many arguments.

The syntax tree will contain the wrong number of arguments as given.

Formatting behaviour depends on the specific request or macro in question.

Note that the same message may also occur as a WARNING, see above.

.It Sy "NOT IMPLEMENTED: Bd -file"

.Pq mdoc

For security reasons, the

Line 1527 By requesting the inclusion of a sensitive file, a mal

Line 1628 By requesting the inclusion of a sensitive file, a mal

might otherwise trick a privileged user into inadvertently displaying

the file on the screen, revealing the file content to bystanders.

The argument is ignored including the file name following it.

.It Sy "skipping display without arguments"

.Pq mdoc

.Ic \&Bd

block macro does not have any arguments.

The block is discarded, and the block content is displayed in

whatever mode was active before the block.

.It Sy "missing list type, using -item"

.Pq mdoc

Line 1535 macro fails to specify the list type.

Line 1643 macro fails to specify the list type.

.It Sy "missing manual name, using \(dq\(dq"

.Pq mdoc

The first call to

.Ic \&Nm

.Ic \&Nm ,

lacks the required argument.

or any call in the NAME section, lacks the required argument.

.It Sy "uname(3) system call failed, using UNKNOWN"

.Pq mdoc

The

Line 1598 An

Line 1706 An

.Ic \&Ef ,

.Ic \&Ek ,

.Ic \&El ,

.Ic \&Lp ,

.Ic \&Pp ,

.Ic \&Re ,

.Ic \&Rs ,

.Ic \&Ud

macro, an

Line 1616 or

Line 1727 or

.Ic \&EN

macro, or a

.Xr roff 7

.Ic \&br ,

.Ic \&fi ,

.Ic \&nf

request or

.Sq \&..

block closing request is invoked with at least one argument.

All arguments are ignored.

.It Sy "skipping excess arguments"

.Pq mdoc , man , roff

The

A macro or request is invoked with too many arguments:

.Ic \&Bf

.Bl -dash -offset 2n -width 2n -compact

macro is invoked with more than one argument, the

.It

.Ic \&Fo ,

.Ic \&PD ,

.Ic \&RS ,

.Ic \&UR ,

.Ic \&ft ,

.Ic \&sp

with more than one argument

.It

.Ic \&An

with another argument after

.Fl split

.Fl nosplit

.It

.Ic \&RE

macro is invoked with more than one argument

with more than one argument or with a non-integer argument

or with a non-integer argument, or a request of the

.It

.Ic \&OP

or a request of the

.Ic \&de

family is invoked with more than two arguments.

family with more than two arguments

.It

.Ic \&Dt

with more than three arguments

.It

.Ic \&TH

with more than five arguments

.It

.Ic \&Bd ,

.Ic \&Bk ,

.Ic \&Bl

with invalid arguments

.El

The excess arguments are ignored.

.El

.Ss Unsupported features

Line 1677 macro or of an undefined macro.

Line 1823 macro or of an undefined macro.

The macro is ignored, and its arguments are handled

as if they were a text line.

.El

.Sh COMPATIBILITY

This section summarises

.Nm

compatibility with GNU troff.

Each input and output format is separately noted.

.Ss ASCII Compatibility

.Bl -bullet -compact

.It

Unrenderable unicode codepoints specified with

.Sq \e[uNNNN]

escapes are printed as

.Sq \&?

in mandoc.

In GNU troff, these raise an error.

.It

The

.Sq \&Bd \-literal

and

.Sq \&Bd \-unfilled

macros of

.Xr mdoc 7

.Fl T Ns Cm ascii

are synonyms, as are \-filled and \-ragged.

.It

In historic GNU troff, the

.Sq \&Pa

.Xr mdoc 7

macro does not underline when scoped under an

.Sq \&It

in the FILES section.

This behaves correctly in

.Nm .

.It

A list or display following the

.Sq \&Ss

.Xr mdoc 7

macro in

.Fl T Ns Cm ascii

does not assert a prior vertical break, just as it doesn't with

.Sq \&Sh .

.It

The

.Sq \&na

.Xr man 7

macro in

.Fl T Ns Cm ascii

has no effect.

.It

Words aren't hyphenated.

.El

.Ss HTML Compatibility

.Bl -bullet -compact

.It

The

.Sq \efP

escape will revert the font to the previous

.Sq \ef

escape, not to the last rendered decoration, which is now dictated by

CSS instead of hard-coded.

It also will not span past the current scope,

for the same reason.

Note that in

.Sx ASCII Output

mode, this will work fine.

.It

The

.Xr mdoc 7

.Sq \&Bl \-hang

and

.Sq \&Bl \-tag

list types render similarly (no break following overreached left-hand

side) due to the expressive constraints of HTML.

.It

The

.Xr man 7

.Sq IP

and

.Sq TP

lists render similarly.

.El

.Sh SEE ALSO

.Xr apropos 1 ,

.Xr man 1 ,

.Xr eqn 7 ,

.Xr man 7 ,

.Xr mandoc_char 7 ,

Line 1766 lists render similarly.

Line 1833 lists render similarly.

.Xr roff 7 ,

.Xr tbl 7

.Sh AUTHORS

.An -nosplit

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

.Sh CAVEATS

and is maintained by

.An Ingo Schwarze Aq Mt schwarze@openbsd.org .

.Sh BUGS

.Fl T Ns Cm html

.Fl T Cm html ,

and

.Fl T Ns Cm xhtml ,

the maximum size of an element attribute is determined by

.Dv BUFSIZ ,

which is usually 1024 bytes.

Be aware of this when setting long link

formats such as

.Fl O Ns Cm style Ns = Ns Ar really/long/link .

.Fl O Cm style Ns = Ns Ar really/long/link .

.Pp

Nesting elements within next-line element scopes of

.Fl m Ns Cm an ,

such as

.Sq br

within an empty

.Sq B ,

will confuse

.Fl T Ns Cm html

and

.Fl T Ns Cm xhtml

and cause them to forget the formatting of the prior next-line scope.

.Pp

The

.Sq \(aq

control character is an alias for the standard macro control character

and does not emit a line-break as stipulated in GNU troff.

CVSweb