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>
7bbd70
<title>CentOS Artwork Repository: 3.49 trunk/Scripts/Bash</title>
4c79b5
7bbd70
<meta name="description" content="CentOS Artwork Repository: 3.49 trunk/Scripts/Bash">
7bbd70
<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 ]
7bbd70
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
7bbd70
[Index]
4c79b5
[ ? ]
4c79b5
7bbd70
2dc146
7bbd70

3.49 trunk/Scripts/Bash

2dc146
2dc146
2dc146
2dc146

3.49.1 Goals

2dc146
7bbd70

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

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

2dc146
2dc146
2dc146

3.49.2 Description

2dc146
7bbd70

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

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

7bbd70

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

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

7bbd70

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

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

7bbd70

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

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

7bbd70

Once global variables and function scripts have been loaded,

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

7bbd70

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

7bbd70
the following format:
7bbd70

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

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

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

7bbd70

Once command-line arguments have been retrived, the

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

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

Figure 3.1: The functionalities initialization environment.

7bbd70
166893

7bbd70

Functionalities are implemented by means of actions. Once the

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

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

Figure 3.2: The actions initialization environment.

7bbd70
2dc146

2dc146
4a9d2a
2dc146

3.49.3 Usage

008ee0
7bbd70

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

7bbd70
each specific function documentation (see section trunk/Scripts/Bash/Functions).
166893

166893
7bbd70
166893

3.49.4 See also

166893
166893
7bbd70
3.48 trunk/Scripts  
7bbd70
7bbd70
3.50 trunk/Scripts/Bash/Functions  
2dc146
7bbd70
3.60 trunk/Scripts/Bash/Locale  
2dc146
2dc146
4c79b5
4c79b5
4c79b5
7bbd70
[ < ]
7bbd70
[ > ]
4c79b5
   
4c79b5
[ << ]
2dc146
[ Up ]
7bbd70
[ >> ]
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>