Annotation of texi2mdoc/texi2mdoc.1, Revision 1.7
1.7 ! kristaps 1: .\" $Id: texi2mdoc.1,v 1.6 2015/02/21 21:49:18 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.7 ! kristaps 17: .Dd $Mdocdate: February 21 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
26: .Ar file
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.1 kristaps 37: Its arguments are as follows:
38: .Bl -tag -width Ds
39: .It Fl I Ar dirs
40: Colon-separated directories to search for
41: .Li @include
42: files.
43: .El
44: .Pp
45: .Nm
46: can understand a significant subset of the texinfo language.
47: It recognises itself as a
48: .Em plaintext
49: formatter.
1.2 kristaps 50: The produced document's title is set to the
51: .Ar file
52: filename and the description is set to the
53: .Li @settitle
54: command's contents.
1.1 kristaps 55: .\" .Sh CONTEXT
56: .\" For section 9 functions only.
57: .\" .Sh IMPLEMENTATION NOTES
58: .\" Not used in OpenBSD.
59: .\" .Sh RETURN VALUES
60: .\" For sections 2, 3, and 9 function return values only.
61: .\" .Sh ENVIRONMENT
62: .\" For sections 1, 6, 7, and 8 only.
63: .\" .Sh FILES
64: .Sh EXIT STATUS
65: .Ex -std
66: .\" .Sh EXAMPLES
67: .\" .Sh DIAGNOSTICS
68: .\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
69: .\" .Sh ERRORS
70: .\" For sections 2, 3, 4, and 9 errno settings only.
71: .Sh SEE ALSO
1.3 kristaps 72: .Xr mdoc 7 ,
73: .Xr tbl 7
1.1 kristaps 74: .Rs
75: .%B GNU Texinfo
76: .%U http://www.gnu.org/software/texinfo/manual/texinfo
77: .Re
78: .\" .Xr foobar 1
79: .\" .Sh STANDARDS
80: .\" .Sh HISTORY
1.2 kristaps 81: .Sh AUTHORS
82: The
83: .Nm
84: utility was written by
85: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.4 kristaps 86: .Sh CAVEATS
1.7 ! kristaps 87: The output of
! 88: .Nm
! 89: doesn't play entirely nicely with
! 90: .Xr mdoc 7 .
! 91: It doesn't detect whether a line trailing slash is properly escaped, nor
! 92: does it properly account for how it mingles
! 93: .Sq \&Pp
! 94: with the text.
! 95: Moreover, many commands that might contain useful information (such as
! 96: .Li @footnote )
! 97: are thrown away.
1.1 kristaps 98: .\" .Sh BUGS
1.4 kristaps 99: .Sh SECURITY CONSIDERATIONS
100: As a security precaution,
101: .Nm
102: does not allow the inclusion (via
103: .Li @include
104: or
1.5 kristaps 105: .Li @verbatiminclude )
1.4 kristaps 106: of absolute paths or paths with
107: .Li \&..
108: as directory components.
1.1 kristaps 109: .\" Not used in OpenBSD.
CVSweb