Return to texi2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / texi2mdoc

Annotation of texi2mdoc/texi2mdoc.1, Revision 1.2

1.2     ! kristaps    1: .\"    $Id: texi2mdoc.1,v 1.1 2015/02/19 08:09:55 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.2     ! kristaps   17: .Dd $Mdocdate: February 19 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
                     72: .Rs
                     73: .%B GNU Texinfo
                     74: .%U http://www.gnu.org/software/texinfo/manual/texinfo
                     75: .Re
1.2     ! kristaps   76: .Xr mdoc 7 ,
        !            77: .Xr tbl 7
1.1       kristaps   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.1       kristaps   86: .\" .Sh CAVEATS
                     87: .\" .Sh BUGS
                     88: .\" .Sh SECURITY CONSIDERATIONS
                     89: .\" Not used in OpenBSD.