POD2USAGE(1) Perl Programmers Reference Guide POD2USAGE(1)

POD2USAGE(1) Perl Programmers Reference Guide POD2USAGE(1) #

POD2USAGE(1) Perl Programmers Reference Guide POD2USAGE(1)

NNAAMMEE #

 pod2usage - print usage messages from embedded pod docs in files

SSYYNNOOPPSSIISS #

 ppoodd22uussaaggee   [--hheellpp] [--mmaann] [--eexxiitt _e_x_i_t_v_a_l] [--oouuttppuutt _o_u_t_f_i_l_e] [--vveerrbboossee
             _l_e_v_e_l] [--ppaatthhlliisstt _d_i_r_l_i_s_t] [--ffoorrmmaatttteerr _m_o_d_u_l_e] [--uuttff88] _f_i_l_e

OOPPTTIIOONNSS AANNDD AARRGGUUMMEENNTTSS #

 --hheellpp   Print a brief help message and exit.

 --mmaann    Print this command's manual page and exit.

 --eexxiitt _e_x_i_t_v_a_l
         The exit status value to return.

 --oouuttppuutt _o_u_t_f_i_l_e
         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 then standard error is used.

 --vveerrbboossee _l_e_v_e_l
         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)

 --ppaatthhlliisstt _d_i_r_l_i_s_t
         Specifies one or more directories to search for the input file if
         it was not supplied with an absolute path. Each directory path in
         the given list should be separated by a ':' on Unix (';' on
         MSWin32 and DOS).

 --ffoorrmmaatttteerr _m_o_d_u_l_e
         Which text formatter to use. Default is Pod::Text, or for very
         old Perl versions Pod::PlainText. An alternative would be e.g.
         Pod::Text::Termcap.

 --uuttff88   This option assumes that the formatter (see above) understands
         the option "utf8". It turns on generation of utf8 output.

 _f_i_l_e    The pathname of a file containing pod documentation to be output
         in usage message format. If omitted, standard input is read - but
         the output is then formatted with Pod::Text only - unless a
         specific formatter has been specified with --ffoorrmmaatttteerr.

DDEESSCCRRIIPPTTIIOONN #

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

 ppoodd22uussaaggee invokes the ppoodd22uussaaggee(()) function in the PPoodd::::UUssaaggee module.
 Please see "ppoodd22uussaaggee(())" in Pod::Usage.

SSEEEE AALLSSOO #

 Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap, perldoc

AAUUTTHHOORR #

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

 Brad Appleton <bradapp@enteract.com>

 Based on code for ppoodd22tteexxtt((11)) written by Tom Christiansen
 <tchrist@mox.perl.com>

perl v5.36.3 2024-03-20 POD2USAGE(1)