• 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

  The exit status value to return.

  "-output

  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.

  "-verbose

  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

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

  "file"

  The pathname of a file containing pod documentation to be output in usage mesage format (defaults to standard input).

• DESCRIPTION
  
  pod2usage will read the given input file looking for pod documentation and will print the corresponding usage message. If no input file is specified than standard input is read.
  
  pod2usage invokes the <(>BIpod2usage() function in the Pod::Usage module. Please see "pod2usage()" in Pod::Usage.
• SEE ALSO
  
  Pod::Usage, pod2text(1)
• AUTHOR
  
  Please report bugs using <http://rt.cpan.org>.
  
  Brad Appleton <bradapp@enteract.com>
  
  Based on code for BIpod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>

Current Users: 90 © 1999-2009 PenguinSoft. All trademarks and copyrights on this page are owned by their respective companies. Linux is a trademark of Linus Torvalds.