=================================================================== RCS file: /cvs/texi2mdoc/texi2mdoc.1,v retrieving revision 1.7 retrieving revision 1.10 diff -u -p -r1.7 -r1.10 --- texi2mdoc/texi2mdoc.1 2015/02/23 12:39:59 1.7 +++ texi2mdoc/texi2mdoc.1 2015/02/24 21:06:52 1.10 @@ -1,4 +1,4 @@ -.\" $Id: texi2mdoc.1,v 1.7 2015/02/23 12:39:59 kristaps Exp $ +.\" $Id: texi2mdoc.1,v 1.10 2015/02/24 21:06:52 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 23 2015 $ +.Dd $Mdocdate: February 24 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 @@ -86,15 +96,22 @@ utility was written by .Sh CAVEATS The output of .Nm -doesn't play entirely nicely with -.Xr mdoc 7 . -It doesn't detect whether a line trailing slash is properly escaped, nor +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. -Moreover, many commands that might contain useful information (such as +.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 SECURITY CONSIDERATIONS As a security precaution,