Return to pod2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / pod2mdoc

Add index page.
Update manual to note usage.
Make "3p" suffix be a preprocessor macro.

.\"	$Id: pod2mdoc.1,v 1.6 2014/03/24 01:43:42 kristaps Exp $
.\"
.\" Copyright (c) 2014 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: March 24 2014 $
.Dt POD2MDOC 1
.Os
.Sh NAME
.Nm pod2mdoc
.Nd Convert POD data to mdoc input
.Sh SYNOPSIS
.Nm pod2man
.Op Fl chloqruv
.Op Fl d Ar date
.Op Fl n Ar title
.Op Fl s Ar section
.Op Ar file
.Sh DESCRIPTION
The
.Nm
utility reads
.Ar file
and
generates
.Xr mdoc 7
input from
.Xr perlpod 1
source.
If unspecified or
.Ar \&- ,
.Ar file
is taken to be standard input.
Its arguments are as follows:
.Bl -tag -width Ds
.It Fl chloqruv
For compatibility with
.Xr pod2man 1 .
Ignored.
.It Fl d Ar date
Set the document date
.Pq Sq Dd
to
.Ar date
.Po
preferrably in
.Qq Month Day, Year
format
.Pc .
If unspecified,
.Nm
uses the file modification date or the current date if reading from
standard input.
.It Fl n Ar title
Set the document title
.Pq Sq Dt
to
.Ar title .
If unspecified,
.Nm
uses the suffix-stripped filename part of
.Ar file
as a document title or
.Ar STDIN
if reading from standard input
.Pq you probably don't want that .
.It Fl s Ar section
Set the document section
.Pq Sq Dt
to
.Ar section .
If unspecified,
.Nm
uses
.Ar 1
or, if the input file suffix is
.Li .pm ,
uses
.Ar 3p .
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
To pipe a POD document
.Pa foo.pod
through
.Xr mandoc 1
and a pager:
.Pp
.Dl % pod2mdoc foo.pod | mandoc | more
.Sh COMPATIBILITY
If
.Fl s
is not specified and the suffix for
.Ar file
is
.Li .pm ,
.Nm
infers a manual section of 3p, not 3 as stipulated in
.Xr perlpod 1 .
Furthermore, all links in the format of
.Li L<Foo::Bar>
are assumed to be in section 3p.
.Pp
If
.Nm
encounters an
.Li =item
without the necessary
.Li =over ,
it will pretend that a prior
.Li =over
was invoked.
However, it will do so silently and not, as
.Xr pod2man 1
does, append a POD ERRORS section in the output manpage saying so.
.Sh SEE ALSO
.Xr perlpod 1 ,
.Xr pod2man 1 ,
.Xr mdoc 7
.Sh AUTHORS
.Nm
was written by
.Ar Kristaps Dzonsons ,
.Mt kristaps@bsd.lv .
.Sh CAVEATS
By way of being a presentational language, POD is not well-represented
by
.Xr mdoc 7 .
Semantic content will be necessarily lost.
.Pp
.Nm
only supports the named
.Li E<xxx>
escapes.
HTML names and numbers are silently discarded.
.Pp
Although most white-space requests in character encodings are properly
carried to output, adjacent character escapes with the specific
whitespace sequence
.Qq Li "B<2>B< 3>"
will cause the second space to be lost.
.Pp
The
.Li S<>
escape is discarded.
.Pp
Lastly, only the
.Li L<Perl::Manpage>
and
.Li L<manpage(1)>
links are understood and properly rendered as
.Sq \&Xr .