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

Alain Reguera Delgado 65f472
locale.sh(1)
Alain Reguera Delgado 65f472
============
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Name
Alain Reguera Delgado 65f472
----
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
locale.sh - The locale module's initialization script.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Synopsis
Alain Reguera Delgado 65f472
--------
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
----------------------------------------------------------------------
Alain Reguera Delgado 65f472
centos-art.sh locale ...
Alain Reguera Delgado 65f472
`-- tcar_setModuleEnvironment
Alain Reguera Delgado 65f472
    `-- locale
Alain Reguera Delgado 65f472
----------------------------------------------------------------------
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Description
Alain Reguera Delgado 65f472
-----------
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
When the first argument passed to *centos-art.sh* script is the word
Alain Reguera Delgado 65f472
*locale*, the *centos-art.sh* script initializes the *locale* module
Alain Reguera Delgado 65f472
by loading the *locale.sh* file into its execution environment. The
Alain Reguera Delgado 65f472
*locale.sh* file's main purpose is to:
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
1. Interpret arguments and options passed through command-line using
Alain Reguera Delgado 65f472
   the _locale_getOptions_ procedure.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
2. Redefine positional parameters using ARGUMENTS local variable.  At
Alain Reguera Delgado 65f472
   this point, option arguments have been removed from TCAR_ARGUMENTS
Alain Reguera Delgado 65f472
   variable and only non-option arguments remain in it.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
3. Verify the current locale information to avoid English messages
Alain Reguera Delgado 65f472
   from being localized to themselves. The English language is used as
Alain Reguera Delgado 65f472
   reference to write translatable strings inside the source files.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
4. Process arguments passed to locale module, based on whether they
Alain Reguera Delgado 65f472
   are files or directories.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Author
Alain Reguera Delgado 65f472
------
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Written by mailto:al@centos.org.cu[Alain Reguera Delgado]
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Copyright
Alain Reguera Delgado 65f472
---------
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Copyright (C) 2009-2013 The CentOS Project
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 65f472
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 65f472
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 65f472
your option) any later version.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 65f472
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 65f472
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 65f472
General Public License for more details.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
You should have received a copy of the GNU General Public License
Alain Reguera Delgado 65f472
along with this program; if not, write to the Free Software
Alain Reguera Delgado 65f472
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
See Also
Alain Reguera Delgado 65f472
--------
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
centos-art.sh-locale(1), locale.conf.sh(1)
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
Alain Reguera Delgado 65f472
// vim: set syntax=asciidoc: