Blame Documentation/Models/Texinfo/Tcar-fs/en_US/Scripts/chapter.texinfo

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