Locale::Po4a::Common - common parts of the po4a scripts and utils

- NAME
- DESCRIPTION
- FUNCTIONS
  - Showing output messages
  - Wrappers for other modules
- AUTHORS
- COPYRIGHT AND LICENSE

# NAME

Locale::Po4a::Common - common parts of the po4a scripts and utils

# DESCRIPTION

Locale::Po4a::Common contains common parts of the po4a scripts and some useful functions used along the other modules.

If needed, you can disable the use of Text::WrapI18N as such:

    use Locale::Po4a::Common qw(nowrapi18n);
    use Locale::Po4a::Text;

instead of:

    use Locale::Po4a::Text;

The ordering is important here: as most Locale::Po4a modules load themselves Locale::Po4a::Common, the first time this module is loaded determines whether Text::WrapI18N is used.

# FUNCTIONS

## Showing output messages

- show_version($)

  Shows the current version of the script, and a short copyright message. It takes the name of the script as an argument.

- wrap_msg($@)

  This function displays a message the same way as sprintf() does, but wraps the result so that they look nice on the terminal.

- wrap_mod($$@)

  This function works like wrap_msg(), but it takes a module name as the first argument, and leaves a space at the left of the message.

- wrap_ref_mod($$$@)

  This function works like wrap_msg(), but it takes a file:line reference as the first argument, a module name as the second one, and leaves a space at the left of the message.

## Wrappers for other modules

- Locale::Gettext

  When the Locale::Gettext module cannot be loaded, this module provide dummy (empty) implementation of the following functions. In that case, po4a messages won't get translated but the program will continue to work.

  If Locale::gettext is present, this wrapper also calls setlocale(LC_MESSAGES, "") so callers don't depend on the POSIX module either.

  - bindtextdomain($$)

  - textdomain($)

  - gettext($)

  - dgettext($$)

# AUTHORS

    Jordi Vilalta <jvprat@gmail.com>

# COPYRIGHT AND LICENSE

Copyright © 2005 SPI, Inc.

This program is free software; you may redistribute it and/or modify it under the terms of GPL v2.0 or later (see the COPYING file).

Locale::Po4a::Common - common parts of the po4a scripts and utils