Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pod::usagetrans(3pm) [linux man page]

Pod::UsageTrans(3pm)					User Contributed Perl Documentation				      Pod::UsageTrans(3pm)

NAME

       Pod::UsageTrans, pod2usage() - print a usage message from embedded pod documentation

SYNOPSIS

	 use Pod::UsageTrans
	 use Locale::gettext;

	 setlocale(LC_MESSAGES,'');
	 textdomain('prog');

	 my $message_text  = "This text precedes the usage message.";
	 my $exit_status   = 2; 	 ## The exit status to use
	 my $verbose_level = 0; 	 ## The verbose level to use
	 my $filehandle    = *STDERR;	 ## The filehandle to write to
	 my $textdomain    = 'prog-pod'; ## The gettext domain for the Pod documentation

	 pod2usage($message_text);

	 pod2usage($exit_status);

	 pod2usage( { -message => gettext( $message_text ) ,
		      -exitval => $exit_status	,
		      -verbose => $verbose_level,
		      -output  => $filehandle,
		      -textdomain => $textdomain } );

	 pod2usage(   -msg     => $message_text ,
		      -exitval => $exit_status	,
		      -verbose => $verbose_level,
		      -output  => $filehandle,
		      -textdomain => $textdomain );

DESCRIPTION

       Pod::UsageTrans works exactly like Pod::Usage but allows you to easily translate your messages. It was specifically written to be
       compatible with the .po files produced by po4a(7). If you want to use any other method to produce your .po files you should probably take a
       look at the source of code of this module to see which msgids you will need to use.

       For documentation on calling pod2usage from your program see Pod::Usage. Pod::UsageTrans additionally supports a "-textdomain" option where
       you can specify the gettext domain to use. If "-textdomain" isn't set, Pod::UsageTrans will behave exactly like Pod::Usage.

BUGS

       Pod::UsageTrans is currently in the state of a quickly hacked together solution that was tested with exactly one use case. Expect bugs in
       corner cases.

       It specifically doesn't support many of the po4a options like charset conversion between the POD input and the msgstr in the .pot file.

SEE ALSO

       po4a(7), Pod::Usage, gettext info documentation

AUTHOR

       Frank Lichtenheld, <frank@lichtenheld.de>

       Based on Pod::Usage by Brad Appleton <bradapp@enteract.com> which is based on code for Pod::Text::pod2text() written by Tom Christiansen
       <tchrist@mox.perl.com>

       Also based on Locale::Po4a::Pod, Locale::Po4a::Po and Locale::Po4a::TransTractor by Martin Quinson and Denis Barbier.

perl v5.12.3							    2011-05-07						      Pod::UsageTrans(3pm)

Check Out this Related Man Page

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.12.1							    2010-07-01							      POD2USAGE(1)
Man Page