1POD2WIKI(1)           User Contributed Perl Documentation          POD2WIKI(1)
2
3
4

NAME

6       pod2wiki - A utility to convert Pod documents to Wiki format.
7

SYNOPSIS

9       pod2wiki [--style --noerrata --help --man] podfile [outfile]
10
11           Options:
12               --style      wiki style (defaults to wiki. See --help)
13               --noerrata   don't generate a "POD ERRORS" section
14               --help       brief help message
15               --man        full documentation
16

DESCRIPTION

18       This program is used for converting Pod text to Wiki text.
19
20       Pod is Perl's Plain Old Documentation format. See "man perlpod" or
21       "perldoc perlpod".
22
23       A Wiki is a user extensible web site. It uses very simple mark-up that
24       is converted to Html. For an introduction to Wikis see:
25       <http://en.wikipedia.org/wiki/Wiki>
26

OPTIONS

28       podfile
29           The input file that contains the Pod file to be converted. It can
30           also be stdin.
31
32       outfile
33           The converted output file in wiki format. Defaults to stdout if not
34           specified.
35
36       --style or -s
37           Sets the wiki style of the output. If no "style" is specified the
38           program defaults to "wiki". The available options are:
39
40           wiki
41               This is the original Wiki format as used on Ward Cunningham's
42               Portland repository of Patterns. See <http://c2.com/cgi/wiki>.
43
44           kwiki
45               This is the format as used by Brian Ingerson's Kwiki:
46               <http://www.kwiki.org>.
47
48           usemod
49               This is the format used by the Usemod wikis. See:
50               <http://www.usemod.com/cgi-bin/wiki.pl>.
51
52           twiki
53               This is the format used by TWiki wikis. See:
54               <http://twiki.org/>.
55
56           tiddlywiki
57               This is the format used by the TiddlyWiki. See:
58               <http://www.tiddlywiki.com/>.
59
60           textile
61               The Textile markup format as used on GitHub. See:
62               <http://textile.thresholdstate.com/>.
63
64           wikipedia or mediawiki
65               This is the format used by Wikipedia and MediaWiki wikis. See:
66               <http://www.mediawiki.org/>.
67
68           markdown
69               This is the format used by GitHub and other sites. See:
70               <http://daringfireball.net/projects/markdown/syntax>.
71
72           moinmoin
73               This is the format used by MoinMoin wikis. See:
74               <http://moinmo.in/MoinMoinWiki>.
75
76           muse
77               Emacs Muse (also known as "Muse" or "Emacs-Muse") is an
78               authoring and publishing environment for Emacs.
79
80           confluence
81               This is the format used by Confluence. See:
82               <http://www.atlassian.com/software/confluence/>.
83
84       --encoding
85           Specify the encoding for the output filehandle:
86
87               --encoding=":utf8"
88
89           Refer to "binmode" in perlfunc for more details. This option is
90           only available in Perl 5.8 and later.
91
92       --noerrata or -noe
93           Don't generate a "POD ERRORS" section at the end of the document.
94           Equivalent to the Pod::Simple::no_errata_section() method.
95
96       --help or -h
97           Print a brief help message and exits.
98
99       --man or -m
100           Prints the manual page and exits.
101

DISCLAIMER OF WARRANTY

103       Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.
104

AUTHOR

106       John McNamara jmcnamara@cpan.org
107

109       (c) MMIII-MMX1V John McNamara.
110
111       All Rights Reserved. This module is free software. It may be used,
112       redistributed and/or modified under the same terms as Perl itself.
113
114
115
116perl v5.38.0                      2023-07-21                       POD2WIKI(1)
Impressum