---
name: "pod2wiki"
section: "1p"
platform: "linux"
package: "libpod-simple-wiki-perl"
version: "0.20-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/pod2wiki"
---

# pod2wiki(1p)

A utility to convert Pod documents to Wiki format.

## NAME

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

## 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
```

## DESCRIPTION

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

Pod is Perl's *Plain Old Documentation* 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\>

## 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.

- **--style or -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.

- **--noerrata or -noe**

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

- **--help or -h**

  Print a brief help message and exits.

- **--man or -m**

  Prints the manual page and exits.

## DISCLAIMER OF WARRANTY

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

## AUTHOR

John McNamara jmcnamara@cpan.org

## COPYRIGHT

(c) MMIII-MMX1V John McNamara.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.