Return to texi2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / texi2mdoc

Annotation of texi2mdoc/texi2mdoc.1, Revision 1.14

1.14    ! kristaps    1: .\"    $Id: texi2mdoc.1,v 1.13 2015/03/01 00:25:08 kristaps Exp $
1.1       kristaps    2: .\"
                      3: .\" Copyright (c) 2015 Kristaps Dzonsons <kristaps@bsd.lv>
                      4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16: .\"
1.14    ! kristaps   17: .Dd $Mdocdate: March 1 2015 $
1.1       kristaps   18: .Dt TEXI2MDOC 1
                     19: .Os
                     20: .Sh NAME
                     21: .Nm texi2mdoc
                     22: .Nd convert texinfo documents to mdoc
                     23: .Sh SYNOPSIS
                     24: .Nm texi2mdoc
1.13      kristaps   25: .Op Fl I Ar dir
1.1       kristaps   26: .Op Fl I Ar dirs
1.8       kristaps   27: .Op Ar file
1.1       kristaps   28: .Sh DESCRIPTION
                     29: The
                     30: .Nm
                     31: utility converts
                     32: .%B GNU Texinfo
                     33: documents to
1.2       kristaps   34: .Xr mdoc 7
                     35: mixed with
                     36: .Xr tbl 7
                     37: .Pq if applicable .
1.8       kristaps   38: By default,
                     39: .Nm
                     40: reads from standard input.
1.1       kristaps   41: Its arguments are as follows:
                     42: .Bl -tag -width Ds
1.13      kristaps   43: .It Fl C Ar dir
                     44: Instead of producing a single document, break apart the input into
                     45: chapter-level documents placed within
                     46: .Ar dir ,
                     47: which must exist.
                     48: These are created as
1.14    ! kristaps   49: .Pa nodeNNN.7 .
1.1       kristaps   50: .It Fl I Ar dirs
                     51: Colon-separated directories to search for
                     52: .Li @include
                     53: files.
1.8       kristaps   54: .It Ar file
                     55: A Texinfo input file.
                     56: If specified, the directory of
                     57: .Ar file
                     58: is prepended to the list of
                     59: .Fl I
                     60: directories.
1.1       kristaps   61: .El
                     62: .Pp
                     63: .Nm
                     64: can understand a significant subset of the texinfo language.
                     65: It recognises itself as a
                     66: .Em plaintext
                     67: formatter.
1.2       kristaps   68: The produced document's title is set to the
                     69: .Ar file
                     70: filename and the description is set to the
                     71: .Li @settitle
                     72: command's contents.
1.1       kristaps   73: .\" .Sh CONTEXT
                     74: .\" For section 9 functions only.
                     75: .\" .Sh IMPLEMENTATION NOTES
                     76: .\" Not used in OpenBSD.
                     77: .\" .Sh RETURN VALUES
                     78: .\" For sections 2, 3, and 9 function return values only.
                     79: .\" .Sh ENVIRONMENT
                     80: .\" For sections 1, 6, 7, and 8 only.
                     81: .\" .Sh FILES
                     82: .Sh EXIT STATUS
                     83: .Ex -std
                     84: .\" .Sh EXAMPLES
                     85: .\" .Sh DIAGNOSTICS
                     86: .\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
                     87: .\" .Sh ERRORS
                     88: .\" For sections 2, 3, 4, and 9 errno settings only.
                     89: .Sh SEE ALSO
1.3       kristaps   90: .Xr mdoc 7 ,
                     91: .Xr tbl 7
1.1       kristaps   92: .Rs
                     93: .%B GNU Texinfo
                     94: .%U http://www.gnu.org/software/texinfo/manual/texinfo
                     95: .Re
                     96: .\" .Xr foobar 1
                     97: .\" .Sh STANDARDS
                     98: .\" .Sh HISTORY
1.2       kristaps   99: .Sh AUTHORS
                    100: The
                    101: .Nm
                    102: utility was written by
                    103: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.4       kristaps  104: .Sh CAVEATS
1.11      kristaps  105: The output consists of superfluous
1.7       kristaps  106: .Sq \&Pp
1.11      kristaps  107: that cause
                    108: .D1 % mandoc -Tlint
                    109: to complain.
1.10      kristaps  110: .Pp
                    111: Many commands that might contain useful information (such as
1.7       kristaps  112: .Li @footnote )
                    113: are thrown away.
1.9       kristaps  114: .Pp
1.11      kristaps  115: The comma in Texinfo macro arguments may at times be escaped with a backslash.
1.10      kristaps  116: This is
                    117: .Em not
                    118: supported.
1.12      kristaps  119: .\" .Sh BUGS
1.4       kristaps  120: .Sh SECURITY CONSIDERATIONS
                    121: As a security precaution,
                    122: .Nm
                    123: does not allow the inclusion (via
                    124: .Li @include
                    125: or
1.5       kristaps  126: .Li @verbatiminclude )
1.4       kristaps  127: of absolute paths or paths with
                    128: .Li \&..
                    129: as directory components.