Blame Manuals/Repository/repository-html/repository_50.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>
1023f4
<title>CentOS Artwork Repository: 3.47 trunk/Scripts/Bash</title>
4c79b5
1023f4
<meta name="description" content="CentOS Artwork Repository: 3.47 trunk/Scripts/Bash">
1023f4
<meta name="keywords" content="CentOS Artwork Repository: 3.47 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
d11e55
[ < ]
d11e55
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
1023f4
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
1023f4
[Index]
4c79b5
[ ? ]
4c79b5
1023f4
d11e55
1023f4

3.47 trunk/Scripts/Bash

4c79b5
4c79b5
d11e55
ec5f63

3.47.1 Goals

4c79b5
1023f4

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

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

eae802
d11e55
ec5f63

3.47.2 Description

6414c4
1023f4

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

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

1023f4

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

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

1023f4

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

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

1023f4

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

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

1023f4

Once global variables and function scripts have been loaded,

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

1023f4

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

1023f4
the following format:
1023f4

1023f4
centos-art arg1 --arg2=val2 --arg3=val3
1023f4
1023f4

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

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

1023f4

Once command-line arguments have been retrived, the

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

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

Figure 3.1: The functionalities initialization environment.

1023f4
1023f4

1023f4

Functionalities are implemented by means of actions. Once the

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

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

Figure 3.2: The actions initialization environment.

1023f4
1023f4

54b5a5
d11e55
2c8180

3.47.3 Usage

6aec21
1023f4

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

1023f4
each specific function documentation (see section trunk/Scripts/Bash/Functions).
1023f4

6aec21
d11e55
4c79b5

3.47.4 See also

4c79b5
1023f4
1023f4
3.46 trunk/Scripts  
1023f4
1023f4
3.48 trunk/Scripts/Bash/Functions  
1023f4
1023f4
3.58 trunk/Scripts/Bash/Locale  
1023f4
1023f4
4c79b5
4c79b5
4c79b5
d11e55
[ < ]
d11e55
[ > ]
4c79b5
   
4c79b5
[ << ]
d11e55
[ Up ]
1023f4
[ >> ]
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>