| Current File : //usr/local/apps/perl/man/man1/pod2markdown.1 |
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "POD2MARKDOWN 1"
.TH POD2MARKDOWN 1 "2023-10-29" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
pod2markdown \- Convert POD text to Markdown
.SH "VERSION"
.IX Header "VERSION"
version 3.400
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # parse STDIN, print to STDOUT
\& $ pod2markdown < POD_File > Markdown_File
\&
\& # parse file, print to STDOUT
\& $ pod2markdown input.pod
\&
\& # parse file, print to file
\& $ pod2markdown input.pod output.mkdn
\&
\& # parse STDIN, print to file
\& $ pod2markdown \- output.mkdn
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program uses Pod::Markdown to convert \s-1POD\s0 into Markdown sources.
.PP
\&\s-1UTF\-8\s0 is the default output encoding
if no encoding options are specified (see \*(L"\s-1OPTIONS\*(R"\s0).
.PP
It accepts two optional arguments:
.IP "\(bu" 4
input pod file (defaults to \f(CW\*(C`STDIN\*(C'\fR)
.IP "\(bu" 4
output markdown file (defaults to \f(CW\*(C`STDOUT\*(C'\fR)
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-\-html\-encode\-chars" 4
.IX Item "--html-encode-chars"
A list of characters to encode as \s-1HTML\s0 entities.
Pass a regexp character class, or \f(CW1\fR to mean control chars, high-bit chars, and \f(CW\*(C`<&>"\*(Aq\*(C'\fR.
.Sp
See \*(L"html_encode_chars\*(R" in Pod::Markdown for more information.
.IP "\-\-match\-encoding (\-m)" 4
.IX Item "--match-encoding (-m)"
Use the same \f(CW\*(C`=encoding\*(C'\fR as the input pod for the output file.
.IP "\-\-local\-module\-url\-prefix" 4
.IX Item "--local-module-url-prefix"
Alters the perldoc urls that are created from \f(CW\*(C`L<>\*(C'\fR codes
when the module is a \*(L"local\*(R" module (\f(CW"Local::*"\fR or \f(CW"Foo_Corp::*"\fR (see perlmodlib)).
.Sp
The default is to use \f(CW\*(C`perldoc_url_prefix\*(C'\fR.
.Sp
See \*(L"local_module_url_prefix\*(R" in Pod::Markdown for more information.
.IP "\-\-man\-url\-prefix" 4
.IX Item "--man-url-prefix"
Alters the man page urls that are created from \f(CW\*(C`L<>\*(C'\fR codes.
.Sp
The default is \f(CW\*(C`http://man.he.net/man\*(C'\fR.
.Sp
See \*(L"man_url_prefix\*(R" in Pod::Markdown for more information.
.IP "\-\-perldoc\-url\-prefix" 4
.IX Item "--perldoc-url-prefix"
Alters the perldoc urls that are created from \f(CW\*(C`L<>\*(C'\fR codes.
Can be:
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`metacpan\*(C'\fR (shortcut for \f(CW\*(C`https://metacpan.org/pod/\*(C'\fR)
.IP "\(bu" 4
\&\f(CW\*(C`sco\*(C'\fR (shortcut for \f(CW\*(C`http://search.cpan.org/perldoc?\*(C'\fR)
.IP "\(bu" 4
any url
.RE
.RS 4
.Sp
The default is \f(CW\*(C`metacpan\*(C'\fR.
.Sp
See \*(L"perldoc_url_prefix\*(R" in Pod::Markdown for more information.
.RE
.IP "\-\-output\-encoding (\-e)" 4
.IX Item "--output-encoding (-e)"
Specify the encoding for the output file.
.IP "\-\-utf8 (\-u)" 4
.IX Item "--utf8 (-u)"
Alias for \f(CW\*(C`\-e UTF\-8\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This program is strongly based on \f(CW\*(C`pod2mdwn\*(C'\fR from Module::Build::IkiWiki.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Marcel Gruenauer <marcel@cpan.org>
.IP "\(bu" 4
Victor Moral <victor@taquiones.net>
.IP "\(bu" 4
Ryan C. Thompson <rct at thompsonclan d0t org>
.IP "\(bu" 4
Aristotle Pagaltzis <pagaltzis@gmx.de>
.IP "\(bu" 4
Randy Stauner <rwstauner@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Randy Stauner.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.