version 1.3, 2015/02/20 09:58:50 |
version 1.10, 2015/02/24 21:06:52 |
|
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm texi2mdoc |
.Nm texi2mdoc |
.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 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 |
|
|
.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 |
|
The output of |
|
.Nm |
|
currently doesn't play nicely with |
|
.Xr mdoc 7 : |
|
it doesn't detect whether a line trailing slash is properly escaped nor |
|
does it properly account for how it mingles |
|
.Sq \&Pp |
|
with the text. |
|
.Pp |
|
Many commands that might contain useful information (such as |
|
.Li @footnote ) |
|
are thrown away. |
|
.Pp |
|
Lastly, 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, |
|
.Nm |
|
does not allow the inclusion (via |
|
.Li @include |
|
or |
|
.Li @verbatiminclude ) |
|
of absolute paths or paths with |
|
.Li \&.. |
|
as directory components. |
.\" Not used in OpenBSD. |
.\" Not used in OpenBSD. |