.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "POD2WIKI 1p"
.TH POD2WIKI 1p "2022-10-13" "perl v5.34.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"
pod2wiki \- A utility to convert Pod documents to Wiki format.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
pod2wiki [\-\-style \-\-noerrata \-\-help \-\-man] podfile [outfile]
.PP
.Vb 5
\&    Options:
\&        \-\-style      wiki style (defaults to wiki. See \-\-help)
\&        \-\-noerrata   don\*(Aqt generate a "POD ERRORS" section
\&        \-\-help       brief help message
\&        \-\-man        full documentation
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program is used for converting Pod text to Wiki text.
.PP
Pod is Perl's \fIPlain Old Documentation\fR format. See \f(CW\*(C`man perlpod\*(C'\fR or \f(CW\*(C`perldoc perlpod\*(C'\fR.
.PP
A Wiki is a user extensible web site. It uses very simple mark-up that is converted to Html. For an introduction to Wikis see: <http://en.wikipedia.org/wiki/Wiki>
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fBpodfile\fR" 4
.IX Item "podfile"
The input file that contains the Pod file to be converted. It can also be stdin.
.IP "\fBoutfile\fR" 4
.IX Item "outfile"
The converted output file in wiki format. Defaults to stdout if not specified.
.IP "\fB\-\-style or \-s\fR" 4
.IX Item "--style or -s"
Sets the wiki style of the output. If no \f(CW\*(C`style\*(C'\fR is specified the program defaults to \f(CW\*(C`wiki\*(C'\fR. The available options are:
.RS 4
.IP "wiki" 4
.IX Item "wiki"
This is the original Wiki format as used on Ward Cunningham's Portland repository of Patterns. See <http://c2.com/cgi/wiki>.
.IP "kwiki" 4
.IX Item "kwiki"
This is the format as used by Brian Ingerson's Kwiki: <http://www.kwiki.org>.
.IP "usemod" 4
.IX Item "usemod"
This is the format used by the Usemod wikis. See: <http://www.usemod.com/cgi\-bin/wiki.pl>.
.IP "twiki" 4
.IX Item "twiki"
This is the format used by TWiki wikis. See: <http://twiki.org/>.
.IP "tiddlywiki" 4
.IX Item "tiddlywiki"
This is the format used by the TiddlyWiki. See: <http://www.tiddlywiki.com/>.
.IP "textile" 4
.IX Item "textile"
The Textile markup format as used on GitHub. See: <http://textile.thresholdstate.com/>.
.IP "wikipedia or mediawiki" 4
.IX Item "wikipedia or mediawiki"
This is the format used by Wikipedia and MediaWiki wikis. See: <http://www.mediawiki.org/>.
.IP "markdown" 4
.IX Item "markdown"
This is the format used by GitHub and other sites. See: <http://daringfireball.net/projects/markdown/syntax>.
.IP "moinmoin" 4
.IX Item "moinmoin"
This is the format used by MoinMoin wikis. See: <http://moinmo.in/MoinMoinWiki>.
.IP "muse" 4
.IX Item "muse"
Emacs Muse (also known as \*(L"Muse\*(R" or \*(L"Emacs-Muse\*(R") is an authoring and publishing environment for Emacs.
.IP "confluence" 4
.IX Item "confluence"
This is the format used by Confluence. See: <http://www.atlassian.com/software/confluence/>.
.RE
.RS 4
.RE
.IP "\fB\-\-encoding\fR" 4
.IX Item "--encoding"
Specify the encoding for the output filehandle:
.Sp
.Vb 1
\&    \-\-encoding=":utf8"
.Ve
.Sp
Refer to \f(CW\*(C`binmode\*(C'\fR in perlfunc for more details. This option is only available in Perl 5.8 and later.
.IP "\fB\-\-noerrata or \-noe\fR" 4
.IX Item "--noerrata or -noe"
Don't generate a \*(L"\s-1POD ERRORS\*(R"\s0 section at the end of the document. Equivalent to the \f(CW\*(C`Pod::Simple::no_errata_section()\*(C'\fR method.
.IP "\fB\-\-help or \-h\fR" 4
.IX Item "--help or -h"
Print a brief help message and exits.
.IP "\fB\-\-man or \-m\fR" 4
.IX Item "--man or -m"
Prints the manual page and exits.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
Please refer to the \s-1DISCLAIMER OF WARRANTY\s0 in Pod::Simple::Wiki.
.SH "AUTHOR"
.IX Header "AUTHOR"
John McNamara jmcnamara@cpan.org
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
(c) \s-1MMIII\-MMX1V\s0 John McNamara.
.PP
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.