Blame Manuals/Repository/repository-html/repository_51.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
-->
bf28e1
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>
7e35dc
<title>CentOS Artwork Repository: 3.48 trunk/Scripts/Bash</title>
4c79b5
7e35dc
<meta name="description" content="CentOS Artwork Repository: 3.48 trunk/Scripts/Bash">
7e35dc
<meta name="keywords" content="CentOS Artwork Repository: 3.48 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
af3979
[ < ]
af3979
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
af3979
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
af3979
[Index]
4c79b5
[ ? ]
4c79b5
7e35dc
af3979
7e35dc

3.48 trunk/Scripts/Bash

008ee0
54b5a5
af3979
63f275

3.48.1 Goals

54b5a5
7e35dc

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

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

4a9d2a
af3979
4a9d2a

3.48.2 Description

4a9d2a
7e35dc

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

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

7e35dc

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

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

7e35dc

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

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

7e35dc

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

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

7e35dc

Once global variables and function scripts have been loaded,

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

7e35dc

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

7e35dc
the following format:
7e35dc

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

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

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

7e35dc

Once command-line arguments have been retrived, the

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

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

Figure 3.1: The functionalities initialization environment.

7e35dc
7e35dc

7e35dc

Functionalities are implemented by means of actions. Once the

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

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

Figure 3.2: The actions initialization environment.

7e35dc
7e35dc

4a9d2a
af3979
4a9d2a

3.48.3 Usage

4a9d2a
7e35dc

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

af3979
each specific function documentation (see section trunk/Scripts/Bash/Functions).
7e35dc

4a9d2a
af3979
4c79b5

3.48.4 See also

4c79b5
7e35dc
af3979
3.47 trunk/Scripts  
7e35dc
af3979
3.49 trunk/Scripts/Bash/Functions  
7e35dc
af3979
3.59 trunk/Scripts/Bash/Locale  
7e35dc
7e35dc
4c79b5
4c79b5
4c79b5
af3979
[ < ]
af3979
[ > ]
4c79b5
   
4c79b5
[ << ]
af3979
[ Up ]
af3979
[ >> ]
4c79b5
4c79b5

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

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