Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  AUTOPOD (1)

.ds Aq ’


autopod - using the Perl library Pod::Autopod to generate javadoc like documentation with pod syntax. It is designed to understand perl code in class style, so typically PM files.



autopod [OPTIONS]


The following options may be used:
<B>--helpB> Prints this help.
<B>--readfile | -rB> Perl module to be parsed for building a pod.
<B>--writefile | -wB> Output file to write the pod.

If this filename has a pm extension, it also writes the perl code which was read from the origin.

If this filename has a pod extension or any other, it only writes the pod content.

If there is no --writefile used and no --print, it overwrites the file set via --readfile.

My personal warning: as long this is a new software, better backup your pm file before overwriting it directly.

<B>--print | -pB> Instead of writing to a file, you can print to STDOUT the generated pod file.

        e.g.: autopod -r Foo/ -p

        You may combine this line to pipe to further applications.

        e.g.: autopod -r Foo/ -p | pod2text

        Do not use it in combination with readdir.

<B>--readdir | -dB> Scans a directory recursiv for pm files and generates the pod for them.
<B>--update | -uB> In combination with --readdir it updates only files which have been pod’ed with autopod in the past. An alternative is to write somewhere in the pm file the magic word AUTOPODME.
<B>--podB> In combination with --readdir it writes separat pod files instead of updating the original pm files. They will be parallel to the pm file.
<B>--poddirB> It writes the pod files to a separate directory. --pod is automatically enabled when using --poddir.
<B>--verboseB> In combination with --readdir it prints the filenames which are written.

 -d mylibs -u -verbose

<B>--version | -vB> Prints the version of Pod::Autopod.

licence is LGPL

by Andreas Hernitscheck ahernit(AT)

Search for    or go to Top of page |  Section 1 |  Main Index

perl v5.20.3 AUTOPOD (1) 2014-09-29

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.