Blame Identity/Manual/repository-xhtml/repository_81.xhtml

c8f7b7
728c6d
728c6d
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
728c6d
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
728c6d
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
06d106
<head>
06d106
a6f1b3
    <title>CentOS Artwork Repository: 2.74 The trunk/Scripts/Functions/Verify Directory</title>
c8f7b7
c8f7b7
    <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
a6f1b3
    <meta name="description" content="CentOS Artwork Repository: 2.74 The trunk/Scripts/Functions/Verify Directory" />
a6f1b3
    <meta name="keywords" content="CentOS Artwork Repository: 2.74 The trunk/Scripts/Functions/Verify Directory" />
728c6d
    <meta name="resource-type" content="document" />
728c6d
    <meta name="distribution" content="global" />
728c6d
    <meta name="generator" content="texi2html 1.76" />
728c6d
    <meta name="copyright" content="2009-2011 Alain Reguera Delgado" />
06d106
c8f7b7
    <link href="/home/centos/artwork/trunk/Identity/Manual/repository.css" rel="stylesheet" type="text/css" media="screen projection" />
06d106
06d106
</head>
06d106
728c6d
<body>
06d106
728c6d
728c6d
728c6d
728c6d
728c6d
    
728c6d
728c6d
        
c8f7b7
a6f1b3
06d106
a6f1b3
[ < ]
a6f1b3
[ > ]
06d106
   
a6f1b3
[ << ]
a6f1b3
[ Up ]
a6f1b3
[ >> ]
06d106
   
06d106
   
06d106
   
06d106
   
c8f7b7
[Top]
c8f7b7
[Contents]
a6f1b3
[Index]
c8f7b7
[ ? ]
06d106
a6f1b3
a6f1b3
a6f1b3

2.74 The <tt>`trunk/Scripts/Functions/Verify'</tt> Directory

a6f1b3
a6f1b3

a6f1b3
a6f1b3

2.74.1 Goals

a6f1b3
a6f1b3

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

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

a6f1b3

a6f1b3
a6f1b3

2.74.2 Description

a6f1b3
a6f1b3

The first time you download CentOS Artwork Repository you need to

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

a6f1b3

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

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

a6f1b3

a6f1b3
a6f1b3

2.74.2.1 Packages

a6f1b3
a6f1b3

Installation of auxiliar RPM packages provides the software required

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

a6f1b3
Info

Note

Configuration of third party repositories inside CentOS

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

a6f1b3
a6f1b3

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

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

a6f1b3

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

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

a6f1b3

a6f1b3
a6f1b3

2.74.2.2 Links

a6f1b3
a6f1b3

Creation of symbolic links helps us to alternate between different

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

a6f1b3

Creation of symbolic links helps us to reuse components from repository

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

a6f1b3

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

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

a6f1b3

a6f1b3
a6f1b3

2.74.2.3 Environment variables

a6f1b3
a6f1b3

Definition of environemnt variables helps us to set default values to

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

a6f1b3

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

a6f1b3
evaluates the following environment variables:
a6f1b3

a6f1b3
a6f1b3
EDITOR
a6f1b3

Default text editor.

a6f1b3

a6f1b3

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

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

a6f1b3

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

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

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

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

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

    a6f1b3
    a6f1b3
    TEXTDOMAIN
    a6f1b3
    a6f1b3

    Default domain used to retrieve translated messages. This variable is

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

    a6f1b3
    a6f1b3
    TEXTDOMAINDIR
    a6f1b3
    a6f1b3

    Default directory used to retrieve translated messages. This variable

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

    a6f1b3
    a6f1b3
    LANG
    a6f1b3
    a6f1b3

    Default locale information.

    a6f1b3

    a6f1b3

    This variable is initially set in the configuration process of CentOS

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

    a6f1b3

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

    a6f1b3
    variable to know in which language the script messages are printed
    a6f1b3
    out.
    a6f1b3

    a6f1b3
    a6f1b3
    TZ
    a6f1b3
    a6f1b3

    Default time zone representation.

    a6f1b3

    a6f1b3

    This variable is initially set in the configuration process of CentOS

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

    a6f1b3

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

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

    a6f1b3

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

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

    a6f1b3
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    a6f1b3
    a6f1b3

    The format of TZ environment variable is described in

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

    a6f1b3
    a6f1b3
    a6f1b3
    a6f1b3

    a6f1b3
    a6f1b3

    2.74.3 Usage

    a6f1b3
    a6f1b3
    a6f1b3
    centos-art verify --packages
    a6f1b3
    a6f1b3

    Verify required packages your workstation needs in order to run the

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

    a6f1b3

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

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

    a6f1b3
    a6f1b3
    centos-art verify --links
    a6f1b3
    a6f1b3

    Verify required links your workstation needs in order to run the

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

    a6f1b3

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

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

    a6f1b3

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

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

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

    Output a brief description of environment variables used by

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

    a6f1b3

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

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

    a6f1b3
    52772c
    52772c
    728c6d

    a6f1b3
    a6f1b3

    2.74.4 See also

    a6f1b3
    a6f1b3
    a6f1b3
    2.62 The <tt>`trunk/Scripts'</tt> Directory  
    a6f1b3
    a6f1b3
    a6f1b3
    a6f1b3
    a6f1b3
    a6f1b3
    a6f1b3

    06d106
    a6f1b3
    [ < ]
    a6f1b3
    [ > ]
    06d106
       
    a6f1b3
    [ << ]
    a6f1b3
    [ Up ]
    a6f1b3
    [ >> ]
    06d106
    06d106
    728c6d
                

    728c6d
    728c6d
            
    728c6d
    728c6d
        
    728c6d
    728c6d
        

    728c6d
    728c6d
    728c6d
    06d106
    </body>
    728c6d
    06d106
    </html>