Blame Automation/Modules/Locale/Manuals/locale.asciidoc

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