SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from Fedora 18 perl-Pod-Parser-1.51-238.fc18.noarch.rpm

POD2USAGE

Section: Perl Programmers Reference Guide (1)
Updated: 2013-02-11
Index 

NAME

pod2usage - print usage messages from embedded pod docs in files 

SYNOPSIS

pod2usage
[-help][-man][-exit exitval][-output outfile][-verbose level][-pathlist dirlist]file
 

OPTIONS AND ARGUMENTS

-help
Print a brief help message and exit.
-man
Print this command's manual page and exit.
-exit exitval
The exit status value to return.
-output outfile
The output file to print to. If the special names ``-'' or ``>&1'' or ``>&STDOUT''are used then standard output is used. If ``>&2'' or ``>&STDERR'' is used thenstandard error is used.
-verbose level
The desired level of verbosity to use:

    1 : print SYNOPSIS only    2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections    3 : print the entire manpage (similar to running pod2text)
-pathlist dirlist
Specifies one or more directories to search for the input file if itwas not supplied with an absolute path. Each directory path in the givenlist should be separated by a ':' on Unix (';' on MSWin32 and DOS).
file
The pathname of a file containing pod documentation to be output inusage message format (defaults to standard input).
 

DESCRIPTION

pod2usage will read the given input file looking for poddocumentation and will print the corresponding usage message.If no input file is specified then standard input is read.

pod2usage invokes the pod2usage() function in the Pod::Usagemodule. Please see ``pod2usage()'' in Pod::Usage. 

SEE ALSO

Pod::Usage, pod2text(1) 

AUTHOR

Please report bugs using <http://rt.cpan.org>.

Brad Appleton <bradappAATTenteract.com>

Based on code for pod2text(1) written byTom Christiansen <tchristAATTmox.perl.com>


 

Index

NAME
SYNOPSIS
OPTIONS AND ARGUMENTS
DESCRIPTION
SEE ALSO
AUTHOR

This document was created byman2html,using the manual pages.