Blame Artworks/Documentation/Texinfo/Tcar-fs/en_US/Scripts.texinfo

Alain Reguera Delgado 46de3c
@node Scripts
Alain Reguera Delgado 46de3c
@chapter The @file{Scripts} Directory
Alain Reguera Delgado 46de3c
@cindex Scripts
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@c -- Chapter Introduction
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
The @file{Scripts} directory exists to organize automation
Alain Reguera Delgado 46de3c
scripts related to @value{TCPCVI}. Such automation scripts are
Alain Reguera Delgado 46de3c
implemented through @command{centos-art.sh} script, a bash scripts
Alain Reguera Delgado 46de3c
designed to automate most frequent tasks performed inside the working
Alain Reguera Delgado 46de3c
copy of @value{TCAR} (e.g., image rendition, content documentation,
Alain Reguera Delgado 46de3c
content translation, etc.).
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
The @file{Scripts} directory and all files inside it are under
Alain Reguera Delgado 46de3c
version control. 
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
The @file{Scripts} directory contains just one file, the
Alain Reguera Delgado 46de3c
@file{centos-art.sh} file. This file is the invocation script the
Alain Reguera Delgado 46de3c
@command{centos-art} command calls to. In addition to
Alain Reguera Delgado 46de3c
@file{centos-art.sh} file, the following directories are available:
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
Content rendition inside @file{Scripts} is not supported.
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
Once the @command{centos-art.sh} script is executed, the following
Alain Reguera Delgado 46de3c
variables are available all along the script execution:
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@defvar CLI_PROGRAM
Alain Reguera Delgado 46de3c
The @var{CLI_PROGRAM} variable is read-only and contains the name of
Alain Reguera Delgado 46de3c
the script, which is @samp{centos-art}, without extension.
Alain Reguera Delgado 46de3c
@end defvar
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@defvar CLI_PROGRAM_ID
Alain Reguera Delgado 46de3c
The @var{CLI_PROGRAM_ID} variable is read-only and contains the
Alain Reguera Delgado 46de3c
process identification assigned to @command{centos-art.sh} script,
Alain Reguera Delgado 46de3c
once executed.
Alain Reguera Delgado 46de3c
@end defvar
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@defvar CLI_VERSION
Alain Reguera Delgado 46de3c
The @var{CLI_VERSION} variable is read-only and contains the version
Alain Reguera Delgado 46de3c
number of @command{centos-art.sh} script.
Alain Reguera Delgado 46de3c
@end defvar
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@defvar CLI_BASEDIR
Alain Reguera Delgado 46de3c
The @var{CLI_BASEDIR} variable is read-only and contains the absolute
Alain Reguera Delgado 46de3c
path of directory where @command{centos-art.sh} script is stored in.
Alain Reguera Delgado 46de3c
@end defvar
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@defvar CLI_TEMPDIR
Alain Reguera Delgado 46de3c
The @var{CLI_TEMPDIR} variable is read-only and contains the absolute
Alain Reguera Delgado 46de3c
path of directory where temporal files created by
Alain Reguera Delgado 46de3c
@command{centos-art.sh} script are stored in.
Alain Reguera Delgado 46de3c
@end defvar
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@defvar TEXTDOMAIN
Alain Reguera Delgado 46de3c
The @var{TEXDOMAIN} variable is read-only and contains the name of the
Alain Reguera Delgado 46de3c
program we are providing localization for (i.e., @samp{centos-art.sh}).
Alain Reguera Delgado 46de3c
@end defvar
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@defvar TEXTDOMAINDIR 
Alain Reguera Delgado 46de3c
The @var{TEXTDOMAINDIR} variable is read-only and contains the
Alain Reguera Delgado 46de3c
absolute path of directory holding localization messages for
Alain Reguera Delgado 46de3c
@command{centos-art.sh}. In order for this variable to take effect,
Alain Reguera Delgado 46de3c
its value must be set using the
Alain Reguera Delgado 46de3c
@file{$@{BASEDIR@}/$@{LANG@}/LC_MESSAGES/$@{TEXDOMAIN@}} construction;
Alain Reguera Delgado 46de3c
where @var{BASEDIR} is an absolute path inside your workstation,
Alain Reguera Delgado 46de3c
@var{LANG} a language code based on the standards @samp{ISO-639} and
Alain Reguera Delgado 46de3c
@samp{ISO-3166} (e.g., @samp{es_ES} for Spanish from Spain,
Alain Reguera Delgado 46de3c
@samp{fr_FR} for French from France, etc.).
Alain Reguera Delgado 46de3c
@end defvar
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@c -- Chapter Menu
Alain Reguera Delgado 46de3c
@include Scripts-menu.texinfo
Alain Reguera Delgado 46de3c
Alain Reguera Delgado 46de3c
@c -- Chapter Nodes
Alain Reguera Delgado 46de3c
@include Scripts-nodes.texinfo