logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Author

       John McNamara jmcnamara@cpan.org

Description

       This program is used for converting Pod text to Wiki text.

       Pod is Perl's PlainOldDocumentation format. See "man perlpod" or "perldoc perlpod".

       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>

Disclaimer Of Warranty

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

Name

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

Options

podfile
           The input file that contains the Pod file to be converted. It can also be stdin.

       outfile
           The converted output file in wiki format. Defaults to stdout if not specified.

       --styleor-s
           Sets  the  wiki  style  of the output. If no "style" is specified the program defaults to "wiki". The
           available options are:

           wiki
               This is the original Wiki format as used on Ward Cunningham's Portland  repository  of  Patterns.
               See <http://c2.com/cgi/wiki>.

           kwiki
               This is the format as used by Brian Ingerson's Kwiki: <http://www.kwiki.org>.

           usemod
               This is the format used by the Usemod wikis. See: <http://www.usemod.com/cgi-bin/wiki.pl>.

           twiki
               This is the format used by TWiki wikis. See: <http://twiki.org/>.

           tiddlywiki
               This is the format used by the TiddlyWiki. See: <http://www.tiddlywiki.com/>.

           textile
               The Textile markup format as used on GitHub. See: <http://textile.thresholdstate.com/>.

           wikipedia or mediawiki
               This is the format used by Wikipedia and MediaWiki wikis. See: <http://www.mediawiki.org/>.

           markdown
               This      is      the     format     used     by     GitHub     and     other     sites.     See:
               <http://daringfireball.net/projects/markdown/syntax>.

           moinmoin
               This is the format used by MoinMoin wikis. See: <http://moinmo.in/MoinMoinWiki>.

           muse
               Emacs Muse (also known as "Muse" or "Emacs-Muse") is an authoring and publishing environment  for
               Emacs.

           confluence
               This is the format used by Confluence. See: <http://www.atlassian.com/software/confluence/>.

       --encoding
           Specify the encoding for the output filehandle:

               --encoding=":utf8"

           Refer to "binmode" in perlfunc for more details. This option is only available in Perl 5.8 and later.

       --noerrataor-noe
           Don't   generate   a   "POD   ERRORS"  section  at  the  end  of  the  document.  Equivalent  to  the
           "Pod::Simple::no_errata_section()" method.

       --helpor-h
           Print a brief help message and exits.

       --manor-m
           Prints the manual page and exits.

Synopsis

       pod2wiki [--style --noerrata --help --man] podfile [outfile]

           Options:
               --style      wiki style (defaults to wiki. See --help)
               --noerrata   don't generate a "POD ERRORS" section
               --help       brief help message
               --man        full documentation

See Also