=================================================================== RCS file: /cvs/texi2mdoc/texi2mdoc.1,v retrieving revision 1.2 retrieving revision 1.11 diff -u -p -r1.2 -r1.11 --- texi2mdoc/texi2mdoc.1 2015/02/19 15:40:44 1.2 +++ texi2mdoc/texi2mdoc.1 2015/02/25 10:01:54 1.11 @@ -1,4 +1,4 @@ -.\" $Id: texi2mdoc.1,v 1.2 2015/02/19 15:40:44 kristaps Exp $ +.\" $Id: texi2mdoc.1,v 1.11 2015/02/25 10:01:54 kristaps Exp $ .\" .\" Copyright (c) 2015 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: February 19 2015 $ +.Dd $Mdocdate: February 25 2015 $ .Dt TEXI2MDOC 1 .Os .Sh NAME @@ -23,7 +23,7 @@ .Sh SYNOPSIS .Nm texi2mdoc .Op Fl I Ar dirs -.Ar file +.Op Ar file .Sh DESCRIPTION The .Nm @@ -34,12 +34,22 @@ documents to mixed with .Xr tbl 7 .Pq if applicable . +By default, +.Nm +reads from standard input. Its arguments are as follows: .Bl -tag -width Ds .It Fl I Ar dirs Colon-separated directories to search for .Li @include 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 .Pp .Nm @@ -69,12 +79,12 @@ command's contents. .\" .Sh ERRORS .\" For sections 2, 3, 4, and 9 errno settings only. .Sh SEE ALSO +.Xr mdoc 7 , +.Xr tbl 7 .Rs .%B GNU Texinfo .%U http://www.gnu.org/software/texinfo/manual/texinfo .Re -.Xr mdoc 7 , -.Xr tbl 7 .\" .Xr foobar 1 .\" .Sh STANDARDS .\" .Sh HISTORY @@ -83,7 +93,35 @@ The .Nm utility was written by .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . -.\" .Sh CAVEATS -.\" .Sh BUGS -.\" .Sh SECURITY CONSIDERATIONS -.\" Not used in OpenBSD. +.Sh CAVEATS +The output consists of superfluous +.Sq \&Pp +that cause +.D1 % mandoc -Tlint +to complain. +.Pp +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 +Macros in +.Nm +are assumed to be self-contained (with matching block and respective +.Li @end +pairs). +In Texinfo, they aren't: they're considered as if typed in place. +.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.