=================================================================== RCS file: /cvs/texi2mdoc/texi2mdoc.1,v retrieving revision 1.1 retrieving revision 1.14 diff -u -p -r1.1 -r1.14 --- texi2mdoc/texi2mdoc.1 2015/02/19 08:09:55 1.1 +++ texi2mdoc/texi2mdoc.1 2015/03/01 00:26:21 1.14 @@ -1,4 +1,4 @@ -.\" $Id: texi2mdoc.1,v 1.1 2015/02/19 08:09:55 kristaps Exp $ +.\" $Id: texi2mdoc.1,v 1.14 2015/03/01 00:26:21 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: March 1 2015 $ .Dt TEXI2MDOC 1 .Os .Sh NAME @@ -22,21 +22,42 @@ .Nd convert texinfo documents to mdoc .Sh SYNOPSIS .Nm texi2mdoc +.Op Fl I Ar dir .Op Fl I Ar dirs -.Ar file +.Op Ar file .Sh DESCRIPTION The .Nm utility converts .%B GNU Texinfo documents to -.Xr mdoc 7 . +.Xr mdoc 7 +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 dir +Instead of producing a single document, break apart the input into +chapter-level documents placed within +.Ar dir , +which must exist. +These are created as +.Pa nodeNNN.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 @@ -44,6 +65,11 @@ can understand a significant subset of the texinfo lan It recognises itself as a .Em plaintext formatter. +The produced document's title is set to the +.Ar file +filename and the description is set to the +.Li @settitle +command's contents. .\" .Sh CONTEXT .\" For section 9 functions only. .\" .Sh IMPLEMENTATION NOTES @@ -61,6 +87,8 @@ formatter. .\" .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 @@ -68,8 +96,34 @@ formatter. .\" .Xr foobar 1 .\" .Sh STANDARDS .\" .Sh HISTORY -.\" .Sh AUTHORS -.\" .Sh CAVEATS +.Sh AUTHORS +The +.Nm +utility was written by +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . +.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 -.\" .Sh SECURITY CONSIDERATIONS -.\" Not used in OpenBSD. +.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.