=================================================================== RCS file: /cvs/texi2mdoc/texi2mdoc.1,v retrieving revision 1.5 retrieving revision 1.15 diff -u -p -r1.5 -r1.15 --- texi2mdoc/texi2mdoc.1 2015/02/20 14:43:22 1.5 +++ texi2mdoc/texi2mdoc.1 2015/03/12 04:24:19 1.15 @@ -1,4 +1,4 @@ -.\" $Id: texi2mdoc.1,v 1.5 2015/02/20 14:43:22 kristaps Exp $ +.\" $Id: texi2mdoc.1,v 1.15 2015/03/12 04:24:19 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 20 2015 $ +.Dd $Mdocdate: March 12 2015 $ .Dt TEXI2MDOC 1 .Os .Sh NAME @@ -22,8 +22,9 @@ .Nd convert texinfo documents to mdoc .Sh SYNOPSIS .Nm texi2mdoc +.Op Fl C Ar dir .Op Fl I Ar dirs -.Ar file +.Op Ar file .Sh DESCRIPTION The .Nm @@ -34,12 +35,29 @@ 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 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 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 @@ -84,13 +102,20 @@ The utility was written by .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . .Sh CAVEATS -Amongst others, the -.Li @macro -and macro-related commands, -.Li @defcodeindex , -and -.Li @footnote -are not supported. +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 .Sh SECURITY CONSIDERATIONS As a security precaution, @@ -102,4 +127,3 @@ or of absolute paths or paths with .Li \&.. as directory components. -.\" Not used in OpenBSD.