Blame Manuals/Repository/repository-html/repository_52.html

4c79b5
4c79b5
<html>
ccb7a3
4c79b5
4c79b5
Permission is granted to copy, distribute and/or modify this document
4c79b5
under the terms of the GNU Free Documentation License, Version 1.2 or
4c79b5
any later version published by the Free Software Foundation; with no
4c79b5
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
4c79b5
copy of the license is included in the section entitled GNU Free
4c79b5
Documentation License.  
4c79b5
-->
acd47b
4c79b5
4c79b5
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
4c79b5
            Karl Berry  <karl@freefriends.org>
4c79b5
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
4c79b5
            and many others.
4c79b5
Maintained by: Many creative people <dev@texi2html.cvshome.org>
4c79b5
Send bugs and suggestions to <users@texi2html.cvshome.org>
4c79b5
4c79b5
-->
4c79b5
<head>
7fa1fb
<title>CentOS Artwork Repository: 3.49 trunk/Scripts/Bash</title>
4c79b5
7fa1fb
<meta name="description" content="CentOS Artwork Repository: 3.49 trunk/Scripts/Bash">
7fa1fb
<meta name="keywords" content="CentOS Artwork Repository: 3.49 trunk/Scripts/Bash">
4c79b5
<meta name="resource-type" content="document">
4c79b5
<meta name="distribution" content="global">
4c79b5
<meta name="Generator" content="texi2html 1.76">
4c79b5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4c79b5
<style type="text/css">
4c79b5
1e9202
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";
4c79b5
4c79b5
a.summary-letter {text-decoration: none}
4c79b5
pre.display {font-family: serif}
4c79b5
pre.format {font-family: serif}
4c79b5
pre.menu-comment {font-family: serif}
4c79b5
pre.menu-preformatted {font-family: serif}
4c79b5
pre.smalldisplay {font-family: serif; font-size: smaller}
4c79b5
pre.smallexample {font-size: smaller}
4c79b5
pre.smallformat {font-family: serif; font-size: smaller}
4c79b5
pre.smalllisp {font-size: smaller}
4c79b5
span.sansserif {font-family:sans-serif; font-weight:normal;}
4c79b5
ul.toc {list-style: none}
4c79b5
-->
4c79b5
</style>
4c79b5
4c79b5
4c79b5
</head>
4c79b5
4c79b5
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
4c79b5
4c79b5
2dc146
[ < ]
2dc146
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
7fa1fb
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
7fa1fb
[Index]
4c79b5
[ ? ]
4c79b5
7fa1fb
2dc146
7fa1fb

3.49 trunk/Scripts/Bash

2dc146
2dc146
2dc146
2dc146

3.49.1 Goals

2dc146
7fa1fb

The <tt>`trunk/Scripts/Bash'</tt> directory exists to organize the trunk

7fa1fb
development line of <tt>`centos-art.sh'</tt> automation script.  The
7fa1fb
<tt>`centos-art.sh'</tt> script standardizes frequent tasks inside your
7fa1fb
working copy of CentOS Artwork Repository.
2dc146

2dc146
2dc146
2dc146

3.49.2 Description

2dc146
7fa1fb

The best way to understand <tt>`centos-art.sh'</tt> automation script is

7fa1fb
studying its source code.  However, as start point, you may prefer to
7fa1fb
read an introductory resume before diving into the source code
7fa1fb
details.
7fa1fb

7fa1fb

The <tt>`centos-art.sh'</tt> script is written in Bash. Most tasks, inside

7fa1fb
<tt>`centos-art.sh'</tt> script, have been organized in many specific
7fa1fb
functionalities that you can invoke from the centos-art
7fa1fb
command-line interface.
7fa1fb

7fa1fb

When you type the centos-art command in your terminal, the

7fa1fb
operating system trys to execute that command. In order to execute the
7fa1fb
command, the operating system needs to know where it is, so the
7fa1fb
operating system uses the PATH environment variable to look for
7fa1fb
that command location. If your system was prepared to use CentOS
7fa1fb
Artwork Repository correctly (see section trunk/Scripts/Bash/Functions/Verify), you should have a symbolic link inside <tt>`~/bin/'</tt>
7fa1fb
directory that points to the <tt>`centos-art.sh'</tt> script file. As
7fa1fb
<tt>`~/bin/'</tt> directory is, by default, inside PATH environment
7fa1fb
variable, the execution of centos-art command runs the
2dc146
<tt>`centos-art.sh'</tt> script.
2dc146

7fa1fb

When <tt>`centos-art.sh'</tt> script is executed, the first it does is

7fa1fb
executing the <tt>`trunk/Scripts/Bash/initEnvironment.sh'</tt> script to
7fa1fb
initialize global variables (e.g., gettext variables) and
7fa1fb
global function scripts.  Global function scripts are located inside
7fa1fb
<tt>`trunk/Scripts/Bash/Functions'</tt> directory and their file names
7fa1fb
begin with <samp>`cli'</samp>. Global function scripts provide common
7fa1fb
functionalities that can be used anywhere inside <tt>`centos-art.sh'</tt>
7fa1fb
script execution environment.
7fa1fb

7fa1fb

Once global variables and function scripts have been loaded,

7fa1fb
<tt>`centos-art.sh'</tt> script executes the cli global function
7fa1fb
from <tt>`cli.sh'</tt> function script to retrive command-line arguments
7fa1fb
and define some default values that may be used later by specific
7fa1fb
function scripts (see section trunk/Scripts/Bash/Functions).
7fa1fb

7fa1fb

As convenction, the <tt>`centos-art.sh'</tt> command-line arguments have

7fa1fb
the following format:
7fa1fb

7fa1fb
centos-art arg1 --arg2=val2 --arg3=val3
7fa1fb
7fa1fb

In the above example, <samp>`centos-art'</samp> is the command you use to

7fa1fb
invoke <tt>`centos-art.sh'</tt> script. The <samp>`arg1'</samp> is required and
7fa1fb
represents the functionality you want to perform (e.g.,
7fa1fb
<samp>`verify'</samp>, <samp>`render'</samp>, <samp>`locale'</samp>, <samp>`manual'</samp>,
7fa1fb
etc.). The remaining arguments are modifiers to <samp>`arg1'</samp>. The
7fa1fb
<samp>`--arg2'</samp> definition is required and represets, specifically,
7fa1fb
the action inside the functionality you want to perform.  The
7fa1fb
<samp>`--arg3'</samp> and on, are optional.
7fa1fb

7fa1fb

Once command-line arguments have been retrived, the

7fa1fb
<tt>`centos-art.sh'</tt> script loads specific functionalities using the
7fa1fb
<tt>`cli_getFunctions.sh'</tt> function script. Only one specific
7fa1fb
functionality can be loaded at one script execution I.e., you run
7fa1fb
centos-art.sh script to run just one functionality.
7fa1fb

7fa1fb
7fa1fb
+----------------------------------------------------------------------+
7fa1fb
| [centos@host]$ centos-art function --action='value' --option='value' |
7fa1fb
+----------------------------------------------------------------------+
7fa1fb
| ~/bin/centos-art --> ~/artwork/trunk/Scripts/Bash/centos-art.sh      |
7fa1fb
+---v-----------------------------------------v------------------------+
7fa1fb
    | centos-art.sh                           |
7fa1fb
    +---v---------------------------------v---+
7fa1fb
    .   | initEnvironment.sh              |   .
7fa1fb
    .   +---------------------------------+   .
7fa1fb
    .   | cli $@                          |   .
7fa1fb
    .   +---v-------------------------v---+   .
7fa1fb
    .   .   | cli_getFunctions        |   .   .
7fa1fb
    .   .   +---v-----------------v---+   .   .
7fa1fb
    .   .   .   | function1       |   .   .   .
7fa1fb
    .   .   .   | function2       |   .   .   .
7fa1fb
    .   .   .   | function3       |   .   .   .
7fa1fb
    .   .   .   +-----------------+   .   .   .
7fa1fb
    .   .   ...........................   .   .
7fa1fb
    .   ...................................   .
7fa1fb
    ...........................................
7fa1fb
7fa1fb

Figure 3.1: The functionalities initialization environment.

7fa1fb
2b5e61

7fa1fb

Functionalities are implemented by means of actions. Once the

7fa1fb
functionality has been initiazalized, actions initialization take
7fa1fb
place for that functionality. Actions initialization model is very
7fa1fb
similar to functions initialization model. But with the difference,
7fa1fb
that actions are loaded inside function environment, and so, share
7fa1fb
variables and functions defined inside function environment.
7fa1fb

7fa1fb
7fa1fb
+--------------------------------------+
7fa1fb
| cli_getFunctions                     |
7fa1fb
+---v------------------------------v---+
7fa1fb
.   | function1                    |   .
7fa1fb
.   +---v----------------------v---+   .
7fa1fb
.   .   | function1_getActions |   .   .
7fa1fb
.   .   +---v--------------v---+   .   .
7fa1fb
.   .   .   | action 1     |   .   .   .
7fa1fb
.   .   .   | action 2     |   .   .   .
7fa1fb
.   .   .   | action n     |   .   .   .
7fa1fb
.   .   .   +--------------+   .   .   .
7fa1fb
.   .   ........................   .   .
7fa1fb
.   ................................   .
7fa1fb
.   +------------------------------+   .
7fa1fb
.   | function2                    |   .
7fa1fb
.   +---v----------------------v---+   .
7fa1fb
.   .   | function2_getActions |   .   .
7fa1fb
.   .   +---v--------------v---+   .   .
7fa1fb
.   .   .   | action 1     |   .   .   .
7fa1fb
.   .   .   | action 2     |   .   .   .
7fa1fb
.   .   .   | action n     |   .   .   .
7fa1fb
.   .   .   +--------------+   .   .   .
7fa1fb
.   .   ........................   .   .
7fa1fb
.   ................................   .
7fa1fb
.   +------------------------------+   .
7fa1fb
.   | function3                    |   .
7fa1fb
.   +---v----------------------v---+   .
7fa1fb
.   .   | function3_getActions |   .   .
7fa1fb
.   .   +---v--------------v---+   .   .
7fa1fb
.   .   .   | action 1     |   .   .   .
7fa1fb
.   .   .   | action 2     |   .   .   .
7fa1fb
.   .   .   | action n     |   .   .   .
7fa1fb
.   .   .   +--------------+   .   .   .
7fa1fb
.   .   ........................   .   .
7fa1fb
.   ................................   .
7fa1fb
........................................
7fa1fb
7fa1fb

Figure 3.2: The actions initialization environment.

7fa1fb
2dc146

2dc146
4a9d2a
2dc146

3.49.3 Usage

008ee0
7fa1fb

The <tt>`centos-art.sh'</tt> script usage information is described inside

7fa1fb
each specific function documentation (see section trunk/Scripts/Bash/Functions).
2b5e61

2b5e61
7fa1fb
2b5e61

3.49.4 See also

2b5e61
2b5e61
7fa1fb
3.48 trunk/Scripts  
7fa1fb
7fa1fb
3.50 trunk/Scripts/Bash/Functions  
2dc146
7fa1fb
3.60 trunk/Scripts/Bash/Locale  
2dc146
2dc146
4c79b5
4c79b5
4c79b5
7fa1fb
[ < ]
7fa1fb
[ > ]
4c79b5
   
4c79b5
[ << ]
2dc146
[ Up ]
7fa1fb
[ >> ]
4c79b5
4c79b5

4c79b5
 <font size="-1">
acd47b
  This document was generated on February, 26 2011 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

4c79b5
</body>
4c79b5
</html>