|
 |
0dc09e |
@node Trunk Scripts Functions Prepare
|
|
|
0dc09e |
@section @file{trunk/Scripts/Functions/Prepare}
|
|
|
0dc09e |
@cindex Trunk scripts functions prepare
|
|
|
0dc09e |
|
|
|
0dc09e |
The @file{trunk/Scripts/Functions/Prepare} directory exists to
|
|
|
0dc09e |
organize the @code{prepare} functionality of @command{centos-art.sh}
|
|
|
0dc09e |
script. The @code{prepare} functionality is written in Bash and its
|
|
|
0dc09e |
main goal is to standardize the final configuration stuff your
|
|
|
0dc09e |
workstation needs, once the working copy of @value{TCAR} has been
|
|
|
0dc09e |
downloaded inside it.
|
|
|
0dc09e |
|
|
|
0dc09e |
The @file{trunk/Scripts/Functions/Prepare} directory and all files
|
|
|
0dc09e |
inside it are under version control.
|
|
|
0dc09e |
|
|
|
0dc09e |
Content rendition inside @file{trunk/Scripts/Functions/Prepare} is not
|
|
|
0dc09e |
supported.
|
|
|
0dc09e |
|
|
|
0dc09e |
Inside @file{trunk/Scripts/Functions/Prepare} directory, file names
|
|
|
0dc09e |
and function names share the same name convenction with the exception
|
|
|
0dc09e |
that file names end with a @samp{.sh} suffix while function names
|
|
|
0dc09e |
doesn't. Both, file names and function names, begin with
|
|
|
0dc09e |
@samp{prepare_} prefix followed by a description of what the function
|
|
|
0dc09e |
does.
|
|
|
0dc09e |
|
|
|
0dc09e |
Inside @file{trunk/Scripts/Functions/Prepare} directory, you can find
|
|
|
0dc09e |
the following functions:
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare
|
|
|
0dc09e |
The @code{prepare} (initialization) function creates the base
|
|
|
0dc09e |
execution environment required to standardize final configuration
|
|
|
0dc09e |
stuff needed by your workstation, once the working copy of
|
|
|
0dc09e |
@value{TCAR} has been downloaded in it.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare_getOptions
|
|
|
0dc09e |
The @code{prepare_getOptions} function parses command options provided
|
|
|
0dc09e |
to @command{centos-art.sh} script when the first argument in the
|
|
|
0dc09e |
command-line is the @samp{prepare} word. This function decides what
|
|
|
0dc09e |
action to perform based on options provided. To parse options, this
|
|
|
0dc09e |
function makes use of @command{getopt} program.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare_updateLinks
|
|
|
0dc09e |
The @code{prepare_updateLinks} function updates the symbolic
|
|
|
0dc09e |
link relation that connects your workstation with the files inside the
|
|
|
0dc09e |
working copy of @value{TCAR}. This function makes brushes, palettes,
|
|
|
0dc09e |
patterns and fonts inside the working copy available to programs like
|
|
|
0dc09e |
GIMP and Inkscape installed in your workstation.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare_updateImages
|
|
|
0dc09e |
The @code{prepare_updateImages} function initializes image files
|
|
|
0dc09e |
inside the working copy. This function makes a list of all design
|
|
|
0dc09e |
models inside the working copy and renders them one by one to produces
|
|
|
0dc09e |
the related output images.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare_updateManuals
|
|
|
0dc09e |
The @code{prepare_updateManuals} function initializes
|
|
|
0dc09e |
documentation files inside the working copy. This function makes a
|
|
|
0dc09e |
list of all documentation manuals source files inside the working copy
|
|
|
0dc09e |
and produces related output for them.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare_updatePackages
|
|
|
0dc09e |
The @code{prepare_updatePackages} function verifies the required
|
|
|
0dc09e |
packages your workstation needs to have installed in order for
|
|
|
0dc09e |
@command{centos-art.sh} script to run correctly. If one or
|
|
|
0dc09e |
more packages are uninstalled or out of date, the
|
|
|
0dc09e |
@command{centos-art.sh} script asks you to confirm their
|
|
|
0dc09e |
installation or actualization through the @command{sudo yum} command.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare_getEnvars
|
|
|
0dc09e |
The @code{prepare_getEnvars} function outputs a brief description of
|
|
|
0dc09e |
relevant environment variables the @command{centos-art.sh} script
|
|
|
0dc09e |
makes use of.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|
|
|
0dc09e |
@defun prepare_getLinkName DIRECTORY, FILE
|
|
|
0dc09e |
The @code{prepare_getLinkName} function takes a @var{DIRECTORY} path
|
|
|
0dc09e |
as first argument and a @var{FILE} path as second argument to output a
|
|
|
0dc09e |
file name with the path information that remains from substracting the
|
|
|
0dc09e |
@var{DIRECTORY} path from the @var{FILE} path provided as argument.
|
|
|
0dc09e |
@end defun
|
|
|
0dc09e |
|