*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> pod2usage (1)              



NAME    [Toc]    [Back]

       pod2usage - print usage messages from embedded pod docs in files

SYNOPSIS    [Toc]    [Back]

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


       -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 then standard 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 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    [Toc]    [Back]

       pod2usage will read the given input file looking for pod documentation
       and will print the corresponding usage message.	If no input file is
       specifed than standard input is read.

       pod2usage invokes the pod2usage() function in the Pod::Usage module.
       Please see "pod2usage()" in Pod::Usage.

SEE ALSO    [Toc]    [Back]

       Pod::Usage, pod2text(1)

AUTHOR    [Toc]    [Back]

       Brad Appleton <bradapp@enteract.com>

       Based on code for pod2text(1) written by Tom Christiansen

3rd Berkeley Distribution	  2004-12-24			  POD2USAGE(1)
[ Back ]
 Similar pages
Name OS Title
rlog Tru64 print log messages and other information about RCS files
rlog OpenBSD print log messages and other information about RCS files
rlog FreeBSD print log messages and other information about RCS files
rlog HP-UX print log messages and other information on RCS files
rlog IRIX print log messages and other information about RCS files
amsyslog IRIX parse system log files and print critical messages
ERR_print_errors NetBSD print error messages
ERR_print_errors_fp Tru64 Print error messages
ERR_print_errors Tru64 Print error messages
ERR_print_errors_fp OpenBSD print error messages
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service