Blame tcar-scripts-locale-docs/Manpages/locale.asciidoc

Alain Reguera Delgado ed4f16
locale(1)
Alain Reguera Delgado ed4f16
=========
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Name
Alain Reguera Delgado ed4f16
----
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
locale - Create, edit and delete translation files for images,
Alain Reguera Delgado ed4f16
documents and automation scripts.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Synopsis
Alain Reguera Delgado ed4f16
--------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
*centos-art.sh locale --help*::
Alain Reguera Delgado ed4f16
    Print module's documentation.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
*centos-art.sh locale --version*::
Alain Reguera Delgado ed4f16
    Print module's version.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
*centos-art.sh locale DIRECTORY [--update|--edit|--delete|--filter="REGEX"]*::
Alain Reguera Delgado ed4f16
    Perform directory localization.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
*centos-art.sh locale FILE [--update|--edit|--delete]*::
Alain Reguera Delgado ed4f16
    Perform file localization.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Description
Alain Reguera Delgado ed4f16
-----------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
The *locale* produces translations files for images, documents and
Alain Reguera Delgado ed4f16
automation scripts based on the LANG environment variable. In order to
Alain Reguera Delgado ed4f16
produce locale-specific translation files, the current language
Alain Reguera Delgado ed4f16
information set by the LANG environment variable must be different to
Alain Reguera Delgado ed4f16
English (`en'). If the current language is English, the *locale*
Alain Reguera Delgado ed4f16
module ends its execution with an error message. When the current
Alain Reguera Delgado ed4f16
language is different to English, the *locale* looks for source files,
Alain Reguera Delgado ed4f16
based on the arguments you passed through the command-line.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
When the argument you provided is a ``DIRECTORY'', the *locale* module
Alain Reguera Delgado ed4f16
looks for configuration files inside it and produces translation files
Alain Reguera Delgado ed4f16
based on the *render-from* and *locale-from* variables set in there.
Alain Reguera Delgado ed4f16
On the other hand, when a ``FILE'' is provided, it takes the file
Alain Reguera Delgado ed4f16
extension (i.e., the characters after the last dot in the file name)
Alain Reguera Delgado ed4f16
and looks recursively in the file's directory for all the files that
Alain Reguera Delgado ed4f16
have the same file extension the ``FILE'' does, and builds the list of
Alain Reguera Delgado ed4f16
source files that will be used to produce the translation files. In
Alain Reguera Delgado ed4f16
this case, the translation files are stored in a ``Locales''
Alain Reguera Delgado ed4f16
directory, at the same level of the ``FILE'' you provided as argument
Alain Reguera Delgado ed4f16
to *locale* module's command-line.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Translation files are the files we use to store translatable strings.
Alain Reguera Delgado ed4f16
These files can be either portable objects (`.po'), machine objects
Alain Reguera Delgado ed4f16
(`.po') or portable object templates (`.pot'). Machine objects are
Alain Reguera Delgado ed4f16
built from portable objects. Portable objects are built from portable
Alain Reguera Delgado ed4f16
object templates (`.pot').  Portable object templates are built using
Alain Reguera Delgado ed4f16
*xgettext* or *xml2po* programs, according to the source files you are
Alain Reguera Delgado ed4f16
retrieving translatable strings from. From these files, portable
Alain Reguera Delgado ed4f16
objects (`.po') are used by *render* module to produce both localized
Alain Reguera Delgado ed4f16
images and localized documentation while machine objects (`.mo') are
Alain Reguera Delgado ed4f16
used by *gettext* program to produce localized output messages from
Alain Reguera Delgado ed4f16
automation scripts.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Options
Alain Reguera Delgado ed4f16
-------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
The *locale* module accepts the following options:
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
*--help*::
Alain Reguera Delgado ed4f16
    Print module's documentation.
Alain Reguera Delgado ed4f16
*--version*::
Alain Reguera Delgado ed4f16
    Print module's version.
Alain Reguera Delgado ed4f16
*--filter="REGEX"*::
Alain Reguera Delgado ed4f16
    When ``DIRECTORY'' is passed as argument, this option reduces the
Alain Reguera Delgado ed4f16
    number of section blocks inside configuration files the *locale*
Alain Reguera Delgado ed4f16
    module will take for processing by using the ``REGEX'' value is a
Alain Reguera Delgado ed4f16
    regular expression pattern to match one or more section names
Alain Reguera Delgado ed4f16
    inside the configuration files found under ``DIRECTORY''. When
Alain Reguera Delgado ed4f16
    ``FILE'' is passed as argument, in the other hand, it limits the
Alain Reguera Delgado ed4f16
    number of files that will be set in the list of source files used
Alain Reguera Delgado ed4f16
    to build the final translation files.
Alain Reguera Delgado ed4f16
*--update*::
Alain Reguera Delgado ed4f16
*--edit*::
Alain Reguera Delgado ed4f16
*--delete*::
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Localizing Image Files
Alain Reguera Delgado ed4f16
----------------------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Hi
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Localizing Documentation Files
Alain Reguera Delgado ed4f16
------------------------------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Hi
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Localizing Automation Scripts
Alain Reguera Delgado ed4f16
-----------------------------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Hi
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Author
Alain Reguera Delgado ed4f16
------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Written by mailto:al@centos.org.cu[Alain Reguera Delgado]
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Copyright
Alain Reguera Delgado ed4f16
---------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
Copyright (C) 2009-2013 The CentOS Project
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado ed4f16
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado ed4f16
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado ed4f16
your option) any later version.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado ed4f16
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado ed4f16
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado ed4f16
General Public License for more details.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
You should have received a copy of the GNU General Public License
Alain Reguera Delgado ed4f16
along with this program; if not, write to the Free Software
Alain Reguera Delgado ed4f16
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
See Also
Alain Reguera Delgado ed4f16
--------
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
centos-art.sh(1), centos-art.sh-render(1), gettext(1)
Alain Reguera Delgado ed4f16
Alain Reguera Delgado ed4f16
// vim: set syntax=asciidoc: