Return to texi2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / texi2mdoc

Add manual.

.\"	$Id: texi2mdoc.1,v 1.1 2015/02/19 08:09:55 kristaps Exp $
.\"
.\" Copyright (c) 2015 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: February 19 2015 $
.Dt TEXI2MDOC 1
.Os
.Sh NAME
.Nm texi2mdoc
.Nd convert texinfo documents to mdoc
.Sh SYNOPSIS
.Nm texi2mdoc
.Op Fl I Ar dirs
.Ar file
.Sh DESCRIPTION
The
.Nm
utility converts
.%B GNU Texinfo
documents to
.Xr mdoc 7 .
Its arguments are as follows:
.Bl -tag -width Ds
.It Fl I Ar dirs
Colon-separated directories to search for
.Li @include
files.
.El
.Pp
.Nm
can understand a significant subset of the texinfo language.
It recognises itself as a
.Em plaintext
formatter.
.\" .Sh CONTEXT
.\" For section 9 functions only.
.\" .Sh IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .Sh RETURN VALUES
.\" For sections 2, 3, and 9 function return values only.
.\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only.
.\" .Sh FILES
.Sh EXIT STATUS
.Ex -std
.\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.\" .Sh ERRORS
.\" For sections 2, 3, 4, and 9 errno settings only.
.Sh SEE ALSO
.Rs
.%B GNU Texinfo
.%U http://www.gnu.org/software/texinfo/manual/texinfo
.Re
.\" .Xr foobar 1
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.