[BACK]Return to texi2mdoc.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / texi2mdoc

Diff for /texi2mdoc/texi2mdoc.1 between version 1.1 and 1.16

version 1.1, 2015/02/19 08:09:55 version 1.16, 2018/11/13 08:45:29
Line 22 
Line 22 
 .Nd convert texinfo documents to mdoc  .Nd convert texinfo documents to mdoc
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm texi2mdoc  .Nm texi2mdoc
   .Op Fl C Ar dir
   .Op Fl d Ar date
 .Op Fl I Ar dirs  .Op Fl I Ar dirs
 .Ar file  .Op Ar file
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility converts  utility converts
 .%B GNU Texinfo  .%B GNU Texinfo
 documents to  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:  Its arguments are as follows:
 .Bl -tag -width Ds  .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 d Ar date
   Set the output document date in the
   .Ic \&Dd
   macro to
   .Ar date ,
   to be specified in the format
   .Dq Ar Month Day , Year .
   If unspecified,
   .Nm
   uses the file modification date
   or the current date when reading from standard input.
 .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
Line 44  can understand a significant subset of the texinfo lan
Line 77  can understand a significant subset of the texinfo lan
 It recognises itself as a  It recognises itself as a
 .Em plaintext  .Em plaintext
 formatter.  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  .\" .Sh CONTEXT
 .\" For section 9 functions only.  .\" For section 9 functions only.
 .\" .Sh IMPLEMENTATION NOTES  .\" .Sh IMPLEMENTATION NOTES
Line 61  formatter.
Line 99  formatter.
 .\" .Sh ERRORS  .\" .Sh ERRORS
 .\" For sections 2, 3, 4, and 9 errno settings only.  .\" For sections 2, 3, 4, and 9 errno settings only.
 .Sh SEE ALSO  .Sh SEE ALSO
   .Xr mdoc 7 ,
   .Xr tbl 7
 .Rs  .Rs
 .%B GNU Texinfo  .%B GNU Texinfo
 .%U http://www.gnu.org/software/texinfo/manual/texinfo  .%U http://www.gnu.org/software/texinfo/manual/texinfo
Line 68  formatter.
Line 108  formatter.
 .\" .Xr foobar 1  .\" .Xr foobar 1
 .\" .Sh STANDARDS  .\" .Sh STANDARDS
 .\" .Sh HISTORY  .\" .Sh HISTORY
 .\" .Sh AUTHORS  .Sh AUTHORS
 .\" .Sh CAVEATS  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 BUGS
 .\" .Sh SECURITY CONSIDERATIONS  .Sh SECURITY CONSIDERATIONS
 .\" Not used in OpenBSD.  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.
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.16
CVSweb