Blame Automation/Manuals/centos-art.sh-locale.asciidoc

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