Codex

Pod::UsageTrans

Section: User Contributed Perl Documentation (3pm)

Updated: 2014-09-11

Index?action=index Return to Main Contents


NAME

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

SYNOPSIS

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 option where you can specify the gettext domain to use. If 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, <[email protected]>

Based on Pod::Usage by Brad Appleton <[email protected]> which is based on code for Pod::Text::pod2text() written by Tom Christiansen <[email protected]>

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


Index

NAME

SYNOPSIS

DESCRIPTION

BUGS

SEE ALSO

AUTHOR