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: http://twiki.org/
54
55           tiddlywiki
56               This is the format used by the TiddlyWiki.  See:
57               http://www.tiddlywiki.com/
58
59           wikipedia or mediawiki
60               This is the format used by Wikipedia and MediaWiki wikis.  See:
61               http://www.mediawiki.org/
62
63           moinmoin
64               This is the format used by MoinMoin wikis.  See:
65               http://moinmo.in/MoinMoinWiki
66
67           confluence
68               This is the format used by Confluence.  See:
69               http://www.atlassian.com/software/confluence/
70
71       --noerrata or -noe
72           Don't generate a "POD ERRORS" section at the end of the document.
73           Equivalent to the "Pod::Simple::no_errata_section()" method.
74
75       --help or -h
76           Print a brief help message and exits.
77
78       --man or -m
79           Prints the manual page and exits.
80

DISCLAIMER OF WARRANTY

82       Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.
83

AUTHOR

85       John McNamara jmcnamara@cpan.org
86

88       AX MMIII-MMVIII, John McNamara.
89
90       All Rights Reserved. This module is free software. It may be used,
91       redistributed and/or modified under the same terms as Perl itself.
92
93
94
95perl v5.12.0                      2008-05-24                       POD2WIKI(1)
Impressum