Blame Manuals/en/Html/Repository/repository_50.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
-->
92fb7f
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>
aaa0e9
<title>The CentOS Artwork Repository: 3.47 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
aaa0e9
<meta name="description" content="The CentOS Artwork Repository: 3.47 trunk/Scripts/Bash/Functions/Verify">
aaa0e9
<meta name="keywords" content="The CentOS Artwork Repository: 3.47 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
aaa0e9
[ < ]
aaa0e9
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
aaa0e9
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
aaa0e9
[Index]
4c79b5
[ ? ]
4c79b5
aaa0e9
aaa0e9
aaa0e9

3.47 trunk/Scripts/Bash/Functions/Verify

aaa0e9
aaa0e9
aaa0e9
aaa0e9

3.47.1 Goals

aaa0e9
aaa0e9

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

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

aaa0e9
aaa0e9
aaa0e9

3.47.2 Description

aaa0e9
aaa0e9

The first time you download CentOS Artwork Repository you need to

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

aaa0e9

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

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

aaa0e9
01b527
aaa0e9

3.47.2.1 Packages

4c79b5
aaa0e9

Installation of auxiliar RPM packages provides the software required

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

aaa0e9
info

Note

Configuration of third party repositories inside CentOS

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

aaa0e9
aaa0e9

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

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

aaa0e9

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

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

4c79b5
01b527
aaa0e9

3.47.2.2 Links

4c79b5
aaa0e9

Creation of symbolic links helps us to alternate between different

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

aaa0e9

Creation of symbolic links helps us to reuse components from repository

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

aaa0e9

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

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

eae802
01b527
aaa0e9

3.47.2.3 Environment variables

aaa0e9
aaa0e9

Definition of environemnt variables helps us to set default values to

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

aaa0e9

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

aaa0e9
evaluates the following environment variables:
aaa0e9

aaa0e9
aaa0e9
EDITOR
aaa0e9

Default text editor.

aaa0e9

aaa0e9

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

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

aaa0e9

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

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

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

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

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

    aaa0e9
    aaa0e9
    TEXTDOMAIN
    aaa0e9
    aaa0e9

    Default domain used to retrieve translated messages. This variable is

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

    aaa0e9
    aaa0e9
    TEXTDOMAINDIR
    aaa0e9
    aaa0e9

    Default directory used to retrieve translated messages. This variable

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

    aaa0e9
    aaa0e9
    LANG
    aaa0e9
    aaa0e9

    Default locale information.

    aaa0e9

    aaa0e9

    This variable is initially set in the configuration process of CentOS

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

    aaa0e9

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

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

    aaa0e9
    aaa0e9
    TZ
    aaa0e9
    aaa0e9

    Default time zone representation.

    aaa0e9

    aaa0e9

    This variable is initially set in the configuration process of CentOS

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

    aaa0e9

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

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

    aaa0e9

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

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

    aaa0e9
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    6414c4
    aaa0e9

    The format of TZ environment variable is described in

    aaa0e9
    <tt>`tzset(3)'</tt> manual page.
    6414c4

    aaa0e9
    aaa0e9
    aaa0e9
    54b5a5
    01b527
    2c8180

    3.47.3 Usage

    6aec21
    aaa0e9
    aaa0e9
    centos-art verify --packages
    aaa0e9
    aaa0e9

    Verify required packages your workstation needs in order to run the

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

    aaa0e9

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

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

    aaa0e9
    aaa0e9
    centos-art verify --links
    aaa0e9
    aaa0e9

    Verify required links your workstation needs in order to run the

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

    aaa0e9

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

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

    aaa0e9

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

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

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

    Output a brief description of environment variables used by

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

    aaa0e9

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

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

    aaa0e9
    aaa0e9
    aaa0e9
    6aec21
    01b527
    4c79b5

    3.47.4 See also

    4c79b5
    035049
    aaa0e9
    3.37 trunk/Scripts/Bash  
    c6292c
    aaa0e9
    3.38 trunk/Scripts/Bash/Functions  
    749e81
    035049
    4c79b5
    4c79b5
    4c79b5
    01b527
    [ < ]
    01b527
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    aaa0e9
    [ Up ]
    aaa0e9
    [ >> ]
    4c79b5
    4c79b5

    4c79b5
     <font size="-1">
    92fb7f
      This document was generated on January, 5 2011 using texi2html 1.76.
    4c79b5
     </font>
    4c79b5
     
    4c79b5
    4c79b5

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