extract_usage_from_stx(1) [debian man page]

extract_usage_from_stx()												  extract_usage_from_stx()

NAME

       extract_usage_from_stx - extract "Usage:" messages from manpages written in Stx

SYNOPSIS

       extract_usage_from_stx [ file  file ... ]

DESCRIPTION

       Process	the  given  files, which should be manpages written in Stx, stripping away everything that is typically not included in a "Usage:"
       message.  If no files are given, read standard input instead.

       A "Usage:" message is a message typically printed when a program is called with incorrect arguments or when help is specifically requested,
       for  example with a --help command line option.	A "Usage:" message is typically a subset of the information provided on a command's manual
       page.

       The information left in the "Usage:" message by extract_usage_from_stx includes:

	   o   the command synopsis, as given in the "SYNOPSIS" section

	   o   the command line options, as given in the "OPTIONS" section, together with the first sentence of their description.  A sentence	is
	       taken to end at a period (.).

       The  output  of	extract_usage_from_stx is still in Stx format, which you might want to further process to produce the actual "Usage:" mes-
       sage.

OPTIONS

	  --version, -V
		 Just show version information and exit.

	  --help, -?
		 Just show a short help message and exit.

SEE ALSO

       stx2any (1).

BUGS

       The end-condition of a sentence is too strong.

AUTHOR

       This manual page was written by Panu A. Kalliokoski.

Panu A. Kalliokoski													  extract_usage_from_stx()

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

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 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 message 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 then standard input is read.

       pod2usage invokes the pod2usage() 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 pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>

perl v5.14.2							    2014-09-30							      POD2USAGE(1)