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