Annotation of texi2mdoc/texi2mdoc.1, Revision 1.16
1.16 ! schwarze 1: .\" $Id: texi2mdoc.1,v 1.15 2015/03/12 04:24:19 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.16 ! schwarze 17: .Dd $Mdocdate: March 12 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.15 kristaps 25: .Op Fl C Ar dir
1.16 ! schwarze 26: .Op Fl d Ar date
1.1 kristaps 27: .Op Fl I Ar dirs
1.8 kristaps 28: .Op Ar file
1.1 kristaps 29: .Sh DESCRIPTION
30: The
31: .Nm
32: utility converts
33: .%B GNU Texinfo
34: documents to
1.2 kristaps 35: .Xr mdoc 7
36: mixed with
37: .Xr tbl 7
38: .Pq if applicable .
1.8 kristaps 39: By default,
40: .Nm
41: reads from standard input.
1.1 kristaps 42: Its arguments are as follows:
43: .Bl -tag -width Ds
1.15 kristaps 44: .It Fl C Ar prefix
1.13 kristaps 45: Instead of producing a single document, break apart the input into
1.15 kristaps 46: node-level documents placed within
1.13 kristaps 47: .Ar dir ,
48: which must exist.
49: These are created as
1.15 kristaps 50: .Pa prefix-NNN.7 .
1.16 ! schwarze 51: .It Fl d Ar date
! 52: Set the output document date in the
! 53: .Ic \&Dd
! 54: macro to
! 55: .Ar date ,
! 56: to be specified in the format
! 57: .Dq Ar Month Day , Year .
! 58: If unspecified,
! 59: .Nm
! 60: uses the file modification date
! 61: or the current date when reading from standard input.
1.1 kristaps 62: .It Fl I Ar dirs
63: Colon-separated directories to search for
64: .Li @include
65: files.
1.8 kristaps 66: .It Ar file
67: A Texinfo input file.
68: If specified, the directory of
69: .Ar file
70: is prepended to the list of
71: .Fl I
72: directories.
1.1 kristaps 73: .El
74: .Pp
75: .Nm
76: can understand a significant subset of the texinfo language.
77: It recognises itself as a
78: .Em plaintext
79: formatter.
1.2 kristaps 80: The produced document's title is set to the
81: .Ar file
82: filename and the description is set to the
83: .Li @settitle
84: command's contents.
1.1 kristaps 85: .\" .Sh CONTEXT
86: .\" For section 9 functions only.
87: .\" .Sh IMPLEMENTATION NOTES
88: .\" Not used in OpenBSD.
89: .\" .Sh RETURN VALUES
90: .\" For sections 2, 3, and 9 function return values only.
91: .\" .Sh ENVIRONMENT
92: .\" For sections 1, 6, 7, and 8 only.
93: .\" .Sh FILES
94: .Sh EXIT STATUS
95: .Ex -std
96: .\" .Sh EXAMPLES
97: .\" .Sh DIAGNOSTICS
98: .\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
99: .\" .Sh ERRORS
100: .\" For sections 2, 3, 4, and 9 errno settings only.
101: .Sh SEE ALSO
1.3 kristaps 102: .Xr mdoc 7 ,
103: .Xr tbl 7
1.1 kristaps 104: .Rs
105: .%B GNU Texinfo
106: .%U http://www.gnu.org/software/texinfo/manual/texinfo
107: .Re
108: .\" .Xr foobar 1
109: .\" .Sh STANDARDS
110: .\" .Sh HISTORY
1.2 kristaps 111: .Sh AUTHORS
112: The
113: .Nm
114: utility was written by
115: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.4 kristaps 116: .Sh CAVEATS
1.11 kristaps 117: The output consists of superfluous
1.7 kristaps 118: .Sq \&Pp
1.11 kristaps 119: that cause
120: .D1 % mandoc -Tlint
121: to complain.
1.10 kristaps 122: .Pp
123: Many commands that might contain useful information (such as
1.7 kristaps 124: .Li @footnote )
125: are thrown away.
1.9 kristaps 126: .Pp
1.11 kristaps 127: The comma in Texinfo macro arguments may at times be escaped with a backslash.
1.10 kristaps 128: This is
129: .Em not
130: supported.
1.12 kristaps 131: .\" .Sh BUGS
1.4 kristaps 132: .Sh SECURITY CONSIDERATIONS
133: As a security precaution,
134: .Nm
135: does not allow the inclusion (via
136: .Li @include
137: or
1.5 kristaps 138: .Li @verbatiminclude )
1.4 kristaps 139: of absolute paths or paths with
140: .Li \&..
141: as directory components.
CVSweb