Blame Manuals/centos-art.sh/centos-art.sh-html/repository_49.html

4c79b5
4c79b5
<html>
6414c4
09d4f2
6414c4
Copyright C 2009, 2010, 2011  Alain Reguera Delgado
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
-->
492287
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>
492287
<title>centos-art.sh: 3.46 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
492287
<meta name="description" content="centos-art.sh: 3.46 trunk/Scripts/Bash/Functions/Verify">
492287
<meta name="keywords" content="centos-art.sh: 3.46 trunk/Scripts/Bash/Functions/Verify">
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
13b177
[ < ]
13b177
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
13b177
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
13b177
[Index]
4c79b5
[ ? ]
4c79b5
ec5f63
13b177
ec5f63

3.46 trunk/Scripts/Bash/Functions/Verify

035049
035049
13b177
035049

3.46.1 Goals

035049
ec5f63

This section exists to organize files related to <tt>`centos-art.sh'</tt>

ec5f63
script <samp>`verify'</samp> functionality.  The <samp>`verify'</samp>
ec5f63
functionality of <tt>`centos-art.sh'</tt> script helps you to verify the
ec5f63
workstation configuration you are planning to use as host for your
ec5f63
working copy of CentOS Artwork Repository.
035049

035049
13b177
035049

3.46.2 Description

035049
ec5f63

The first time you download CentOS Artwork Repository you need to

ec5f63
configure your workstation in order to use <tt>`centos-art.sh'</tt>
ec5f63
script.  These preliminar configurations are based mainly on auxiliar
ec5f63
RPM packages installation, symbolic links creations, and environment
ec5f63
variables definitions.  The <samp>`verify'</samp> functionality of
ec5f63
<tt>`centos-art.sh'</tt> script guides you through this preliminar
ec5f63
configuration process.  
ec5f63

ec5f63

If this is the first time you run <tt>`centos-art.sh'</tt> script, the

ec5f63
appropriate way to use its <samp>`verify'</samp> functionality is not using
ec5f63
the <tt>`centos-art.sh'</tt> script directly, but the absolute path to
ec5f63
centos-art.sh script instead (i.e.,
ec5f63
<tt>`~/artwork/trunk/Scripts/Bash/centos-art.sh'</tt>).  This is necessary
ec5f63
because <tt>`centos-art'</tt> symbolic link, under <tt>`~/bin/'</tt>
ec5f63
directory, has not been created yet.
3207df

1d1bf4
13b177
ec5f63

3.46.2.1 Packages

ec5f63
ec5f63

Installation of auxiliar RPM packages provides the software required

ec5f63
to manipulate files inside the repository (e.g., image files,
ec5f63
documentation files, translation files, script files, etc.). Most of
ec5f63
RPM packages centos-art.sh script uses are shipped with
ec5f63
CentOS distribution, and can be installed from CentOS base repository.
ec5f63
The only exception is <samp>`inkscape'</samp>, the package we use to
ec5f63
manipulate SVG files.  The <samp>`inkscape'</samp> package is not inside
ec5f63
CentOS distribution so it needs to be installed from third party
ec5f63
repositories.
4224f4

ec5f63
info

Note

Configuration of third party repositories inside CentOS

ec5f63
distribution is described in CentOS wiki, specifically in the
ec5f63
following URL:
ec5f63
http://wiki.centos.org/AdditionalResources/Repositories
ec5f63

ec5f63
ec5f63

Before installing packages, the <tt>`centos-art.sh'</tt> script uses

8e85aa
sudo to request root privileges to execute yum
ec5f63
installation functionality.  If your user isn't defined as a
ec5f63
privileged user--at least to run yum commands-- inside
ec5f63
<tt>`/etc/sudoers'</tt> configuration file, you will not be able to
ec5f63
perform package installation tasks as set in <tt>`centos-art.sh'</tt>
ec5f63
script <samp>`verify'</samp> functionality. 
1d1bf4

ec5f63

Setting sudo privileges to users is an administrative task you have to

ec5f63
do by yourself. If you don't have experience with sudo
ec5f63
command, please read its man page running the command: man
ec5f63
sudo. This reading will be very useful, and with some practice, you
ec5f63
will be able to configure your users to have sudo
ec5f63
privileges.
280c77

ec5f63
13b177
ec5f63

3.46.2.2 Links

ec5f63
ec5f63

Creation of symbolic links helps us to alternate between different

ec5f63
implementations of <tt>`centos-art.sh'</tt> script-line (e.g.,
ec5f63
<tt>`centos-art.sh'</tt>, for Bash implementation; <tt>`centos-art.py'</tt>,
ec5f63
for Python implementation; <tt>`centos-art.pl'</tt>, for Perl
ec5f63
implementation; and so on for other implementations). The
ec5f63
<tt>`centos-art.sh'</tt> script-line definition takes place inside your
ec5f63
personal binary (<tt>`~/bin/'</tt>) directory in order to make the script
ec5f63
implementation --the one that <tt>`centos-art'</tt> links to-- available
ec5f63
to PATH environment variable.
280c77

ec5f63

Creation of symbolic links helps us to reuse components from repository

ec5f63
working copy. For example, color information files maintained inside
ec5f63
your working copy must never be duplicated inside program-specific
ec5f63
configuration directories that uses them in your workstation (e.g.,
ec5f63
Gimp, Inkscape, etc.).  Instead, a symbolic link must be created for
ec5f63
each one of them, from program-specific configuration directories to
ec5f63
files in the working copy.  In this configuration, when someone
ec5f63
commits changes to color information files up to central repository,
ec5f63
they--the changes committed-- will be immediatly available to your
ec5f63
programs the next time you update your working copy --the place
ec5f63
inside your workstation those color information files are stored--.
280c77

ec5f63

Creation of symbolic links helps us to make <tt>`centos-art.sh'</tt>

ec5f63
script functionalities available outside <tt>`trunk/'</tt> repository
ec5f63
directory structure, but at its same level in repository tree. This is
ec5f63
useful if you need to use the "render" functionality of
ec5f63
centos-art.sh under <tt>`branches/'</tt> repository directory
ec5f63
structure as you usually do inside <tt>`trunk/'</tt> repository directory
ec5f63
structure. As consequence of this configuration, automation scripts
ec5f63
cannot be branched under <tt>`branches/Scripts'</tt> directory structure.
1d1bf4

ec5f63
13b177
ec5f63

3.46.2.3 Environment variables

ec5f63
ec5f63

Definition of environemnt variables helps us to set default values to

ec5f63
our user session life. The user session environment variable defintion
ec5f63
takes place in the user's <tt>`~/.bash_profile'</tt> file.  The
ec5f63
<samp>`verify'</samp> functionality of <tt>`centos-art.sh'</tt> script doesn't
ec5f63
modify your <tt>`~/.bash_profile'</tt> file.  
1d1bf4

ec5f63

The <samp>`verify'</samp> functionality of <tt>`centos-art.sh'</tt> script

ec5f63
evaluates the following environment variables:
c489c0

ec5f63
ec5f63
EDITOR
ec5f63

Default text editor.

27dad7

ec5f63

The <tt>`centos-art.sh'</tt> script uses default text EDITOR to edit

ec5f63
pre-commit subversion messages, translation files, configuration
ec5f63
files, script files, and similar text-based files.
ec5f63

ec5f63

If EDITOR environment variable is not set, <tt>`centos-art.sh'</tt>

ec5f63
script uses <tt>`/usr/bin/vim'</tt> as default text editor. Otherwise, the
ec5f63
following values are recognized by <tt>`centos-art.sh'</tt> script:
ec5f63

ec5f63
    ec5f63
  • <tt>`/usr/bin/vim'</tt>
  • ec5f63
  • <tt>`/usr/bin/emacs'</tt>
  • ec5f63
  • <tt>`/usr/bin/nano'</tt>
  • ec5f63
    ec5f63
    ec5f63

    If no one of these values is set in EDITOR environment variable,

    ec5f63
    <tt>`centos-art.sh'</tt> uses <tt>`/usr/bin/vim'</tt> text editor by default. 
    aaa0e9

    3f9ae1
    ec5f63
    TEXTDOMAIN
    ec5f63
    ec5f63

    Default domain used to retrieve translated messages. This variable is

    ec5f63
    set in <tt>`initFunctions.sh'</tt> and shouldn't be changed.
    aaa0e9

    3f9ae1
    ec5f63
    TEXTDOMAINDIR
    ec5f63
    ec5f63

    Default directory used to retrieve translated messages. This variable

    ec5f63
    is set in <tt>`initFunctions.sh'</tt> and shouldn't be changed.
    aaa0e9

    3f9ae1
    ec5f63
    LANG
    ec5f63
    ec5f63

    Default locale information.

    ec5f63

    ec5f63

    This variable is initially set in the configuration process of CentOS

    ec5f63
    distribution installer (i.e., Anaconda), specifically in the
    ec5f63
    <samp>`Language'</samp> step; or once installed using the
    ec5f63
    system-config-language tool.
    ec5f63

    ec5f63

    The <tt>`centos-art.sh'</tt> script uses the LANG environment

    ec5f63
    variable to know in which language the script messages are printed
    ec5f63
    out.
    1d1bf4

    1d1bf4
    ec5f63
    TZ
    ec5f63
    ec5f63

    Default time zone representation.

    3f9ae1

    ec5f63

    This variable is initially set in the configuration process of CentOS

    ec5f63
    distribution installer (i.e., Anaconda), specifically in the
    ec5f63
    <samp>`Date and time'</samp> step; or once installed using the
    ec5f63
    system-config-date tool.
    27dad7

    ec5f63

    The <tt>`centos-art.sh'</tt> script doesn't use the TZ environment

    ec5f63
    variable information at all. Instead, this variable is used by the
    ec5f63
    system shell to show the time information according to your phisical
    ec5f63
    location on planet Earth.  
    27dad7

    ec5f63

    Inside your computer, the time information is firstly set in the BIOS

    ec5f63
    clock (which may need correction), and later in the configuration
    ec5f63
    process of CentOS distribution installer (or later, by any of the
    ec5f63
    related configuration tools inside CentOS distribution).  Generally,
    ec5f63
    setting time information is a straight-forward task and configuration
    ec5f63
    tools available do cover most relevant location. However, if you need
    ec5f63
    a time precision not provided by the configuration tools available
    ec5f63
    inside CentOS distribution then, using TZ variable may be
    ec5f63
    necessary.
    27dad7

    ec5f63
    Convenction

    Convenction

    In order to keep changes syncronized between

    ec5f63
    central repository and its working copies: configure both repository
    ec5f63
    server and workstations (i.e., the place where each working copy is
    ec5f63
    set on) to use Coordinated Universal Time (UTC) as base time
    ec5f63
    representation.  Later, correct the time information for your specific
    ec5f63
    location using time zone correction.
    ec5f63

    3f9ae1
    ec5f63

    The format of TZ environment variable is described in

    ec5f63
    <tt>`tzset(3)'</tt> manual page.
    ec5f63

    ec5f63
    ec5f63
    ec5f63
    ec5f63
    13b177
    3f9ae1

    3.46.3 Usage

    3f9ae1
    3f9ae1
    ec5f63
    centos-art verify --packages
    ec5f63
    ec5f63

    Verify required packages your workstation needs in order to run the

    ec5f63
    <tt>`centos-art.sh'</tt> script correctly.  If there are missing packages,
    ec5f63
    the <tt>`centos-art.sh'</tt> script asks you to confirm their
    ec5f63
    installation. When installing packages, the <tt>`centos-art.sh'</tt>
    ec5f63
    script uses the yum application in order to achieve the
    ec5f63
    task.
    ec5f63

    ec5f63

    In case all packages required by <tt>`centos-art.sh'</tt> script are

    ec5f63
    already installed in your workstation, the message <samp>`The required
    ec5f63
    packages are already installed.'</samp> is output for you to know. 
    1d1bf4

    1d1bf4
    ec5f63
    centos-art verify --links
    ec5f63
    ec5f63

    Verify required links your workstation needs in order to run the

    ec5f63
    centos-art command correctly.  If any required link is missing, the
    ec5f63
    centos-art.sh script asks you to confirm their installation.
    ec5f63
    To install required links, the centos-art.sh script uses the
    ec5f63
    ln command.
    3f9ae1

    ec5f63

    In case all links required by <tt>`centos-art.sh'</tt> script are already

    ec5f63
    created in your workstation, the message <samp>`The required links are
    ec5f63
    already installed.'</samp> is output for you to know. 
    3f9ae1

    ec5f63

    In case a regular file exists with the same name of a required link,

    ec5f63
    the <tt>`centos-art.sh'</tt> script outputs the <samp>`Already exists as
    ec5f63
    regular file.'</samp> message when listing required links that will be
    ec5f63
    installed. Of course, as there is already a regular file where must be
    ec5f63
    a link, no link is created. In such cases the <tt>`centos-art.sh'</tt>
    ec5f63
    script will fall into a continue installation request for that missing
    ec5f63
    link.  To end this continue request you can answer <samp>`No'</samp>, or
    ec5f63
    remove the existent regular file to let <tt>`centos-art.sh'</tt> script
    ec5f63
    install the link on its place.
    3f9ae1

    ec5f63
    ec5f63
    centos-art verify --environment
    ec5f63
    centos-art verify --environment --filter='regex'
    ec5f63
    ec5f63

    Output a brief description of environment variables used by

    ec5f63
    <tt>`centos-art.sh'</tt> script. 
    ec5f63

    ec5f63

    If <samp>`--filter'</samp> option is provided, output is reduced as defined in

    ec5f63
    the <samp>`regex'</samp> regular expression value. If <samp>`--filter'</samp> option
    ec5f63
    is specified but <samp>`regex'</samp> value is not, the <tt>`centos-art.sh'</tt>
    ec5f63
    script outputs information as if <samp>`--filter'</samp> option had not been
    ec5f63
    provided at all.  
    ec5f63

    ec5f63
    ec5f63
    1d1bf4
    ec5f63
    13b177
    4c79b5

    3.46.4 See also

    4c79b5
    008ee0
    5cee2c
    3.36 trunk/Scripts/Bash  
    3d6160
    5cee2c
    3.37 trunk/Scripts/Bash/Functions  
    e37211
    008ee0
    4c79b5
    4c79b5
    4c79b5
    13b177
    [ < ]
    13b177
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    13b177
    [ Up ]
    13b177
    [ >> ]
    4c79b5
    4c79b5

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

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