version 1.6, 2015/02/21 21:49:18 |
version 1.16, 2018/11/13 08:45:29 |
|
|
.Nd convert texinfo documents to mdoc |
.Nd convert texinfo documents to mdoc |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm texi2mdoc |
.Nm texi2mdoc |
|
.Op Fl C Ar dir |
|
.Op Fl d Ar date |
.Op Fl I Ar dirs |
.Op Fl I Ar dirs |
.Ar file |
.Op Ar file |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
|
|
mixed with |
mixed with |
.Xr tbl 7 |
.Xr tbl 7 |
.Pq if applicable . |
.Pq if applicable . |
|
By default, |
|
.Nm |
|
reads from standard input. |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Fl C Ar prefix |
|
Instead of producing a single document, break apart the input into |
|
node-level documents placed within |
|
.Ar dir , |
|
which must exist. |
|
These are created as |
|
.Pa prefix-NNN.7 . |
|
.It Fl d Ar date |
|
Set the output document date in the |
|
.Ic \&Dd |
|
macro to |
|
.Ar date , |
|
to be specified in the format |
|
.Dq Ar Month Day , Year . |
|
If unspecified, |
|
.Nm |
|
uses the file modification date |
|
or the current date when reading from standard input. |
.It Fl I Ar dirs |
.It Fl I Ar dirs |
Colon-separated directories to search for |
Colon-separated directories to search for |
.Li @include |
.Li @include |
files. |
files. |
|
.It Ar file |
|
A Texinfo input file. |
|
If specified, the directory of |
|
.Ar file |
|
is prepended to the list of |
|
.Fl I |
|
directories. |
.El |
.El |
.Pp |
.Pp |
.Nm |
.Nm |
|
|
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.Sh CAVEATS |
.Sh CAVEATS |
Amongst others, the |
The output consists of superfluous |
.Li @macro |
.Sq \&Pp |
and macro-related commands, |
that cause |
.Li @verb , |
.D1 % mandoc -Tlint |
and |
to complain. |
.Li @footnote |
.Pp |
are not supported. |
Many commands that might contain useful information (such as |
|
.Li @footnote ) |
|
are thrown away. |
|
.Pp |
|
The comma in Texinfo macro arguments may at times be escaped with a backslash. |
|
This is |
|
.Em not |
|
supported. |
.\" .Sh BUGS |
.\" .Sh BUGS |
.Sh SECURITY CONSIDERATIONS |
.Sh SECURITY CONSIDERATIONS |
As a security precaution, |
As a security precaution, |
|
|
of absolute paths or paths with |
of absolute paths or paths with |
.Li \&.. |
.Li \&.. |
as directory components. |
as directory components. |
.\" Not used in OpenBSD. |
|