Blame Manual/repository-html/repository_64.html

db14a4
db14a4
<html>
db14a4
db14a4
db14a4
Permission is granted to copy, distribute and/or modify this document
db14a4
under the terms of the GNU Free Documentation License, Version 1.2 or
db14a4
any later version published by the Free Software Foundation; with no
db14a4
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
db14a4
copy of the license is included in the section entitled GNU Free
db14a4
Documentation License.  
db14a4
-->
406f69
db14a4
db14a4
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
db14a4
            Karl Berry  <karl@freefriends.org>
db14a4
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
db14a4
            and many others.
db14a4
Maintained by: Many creative people <dev@texi2html.cvshome.org>
db14a4
Send bugs and suggestions to <users@texi2html.cvshome.org>
db14a4
db14a4
-->
db14a4
<head>
b9dbd3
<title>CentOS Artwork Repository: 2.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory</title>
db14a4
b9dbd3
<meta name="description" content="CentOS Artwork Repository: 2.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory">
b9dbd3
<meta name="keywords" content="CentOS Artwork Repository: 2.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory">
db14a4
<meta name="resource-type" content="document">
db14a4
<meta name="distribution" content="global">
db14a4
<meta name="Generator" content="texi2html 1.76">
db14a4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
db14a4
<style type="text/css">
db14a4
db14a4
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";
db14a4
db14a4
a.summary-letter {text-decoration: none}
db14a4
pre.display {font-family: serif}
db14a4
pre.format {font-family: serif}
db14a4
pre.menu-comment {font-family: serif}
db14a4
pre.menu-preformatted {font-family: serif}
db14a4
pre.smalldisplay {font-family: serif; font-size: smaller}
db14a4
pre.smallexample {font-size: smaller}
db14a4
pre.smallformat {font-family: serif; font-size: smaller}
db14a4
pre.smalllisp {font-size: smaller}
db14a4
span.sansserif {font-family:sans-serif; font-weight:normal;}
db14a4
ul.toc {list-style: none}
db14a4
-->
db14a4
</style>
db14a4
db14a4
db14a4
</head>
db14a4
db14a4
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
db14a4
db14a4
b9dbd3
[ < ]
b9dbd3
[ > ]
db14a4
   
b9dbd3
[ << ]
b9dbd3
[ Up ]
b9dbd3
[ >> ]
db14a4
   
db14a4
   
db14a4
   
db14a4
   
56a476
[Top]
56a476
[Contents]
b130a0
[Index]
56a476
[ ? ]
db14a4
b9dbd3
b9dbd3
b9dbd3

2.62 The <tt>`trunk/Scripts/Bash/Cli/Functions/Verify'</tt> Directory

aaf678
982d5c
b9dbd3
b9dbd3

2.62.1 Goals

b130a0
b9dbd3

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

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

b9dbd3
b9dbd3
b9dbd3

2.62.2 Description

b130a0
b9dbd3

The first time you download CentOS Artwork Repository you need to

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

b9dbd3

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

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

b130a0
b9dbd3
b9dbd3

2.62.2.1 Packages

b130a0
b9dbd3

Installation of auxiliar RPM packages provides the software required

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

b9dbd3
info

Note

Configuration of third party repositories inside CentOS

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

010b2d
b9dbd3

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

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

b9dbd3

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

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

db14a4
b9dbd3
b9dbd3

2.62.2.2 Links

b130a0
b9dbd3

Creation of symbolic links helps us to alternate between different

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

b9dbd3

Creation of symbolic links helps us to reuse components from repository

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

b9dbd3

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

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

b9dbd3
b9dbd3
b9dbd3

2.62.2.3 Environment variables

b9dbd3
b9dbd3

Definition of environemnt variables helps us to set default values to

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

b9dbd3

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

b9dbd3
evaluates the following environment variables:
b9dbd3

b9dbd3
b9dbd3
EDITOR
b9dbd3

Default text editor.

b9dbd3

b9dbd3

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

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

b9dbd3

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

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

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

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

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

    b9dbd3
    b9dbd3
    TEXTDOMAIN
    b9dbd3
    b9dbd3

    Default domain used to retrieve translated messages. This variable is

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

    b9dbd3
    b9dbd3
    TEXTDOMAINDIR
    b9dbd3
    b9dbd3

    Default directory used to retrieve translated messages. This variable

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

    b9dbd3
    b9dbd3
    LANG
    b9dbd3
    b9dbd3

    Default locale information.

    b9dbd3

    b9dbd3

    This variable is initially set in the configuration process of CentOS

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

    b9dbd3

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

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

    b9dbd3
    b9dbd3
    TZ
    b9dbd3
    b9dbd3

    Default time zone representation.

    b9dbd3

    b9dbd3

    This variable is initially set in the configuration process of CentOS

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

    b9dbd3

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

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

    b9dbd3

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

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

    b9dbd3
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    b9dbd3
    b9dbd3

    The format of TZ environment variable is described in

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

    b9dbd3
    b9dbd3
    b130a0
    b130a0
    b9dbd3
    b9dbd3

    2.62.3 Usage

    b9dbd3
    b9dbd3
    b9dbd3
    centos-art verify --packages
    b9dbd3
    b9dbd3

    Verify required packages your workstation needs in order to run the

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

    b9dbd3

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

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

    b9dbd3
    b9dbd3
    centos-art verify --links
    b9dbd3
    b9dbd3

    Verify required links your workstation needs in order to run the

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

    b9dbd3

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

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

    b9dbd3

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

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

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

    Output a brief description of environment variables used by

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

    b9dbd3

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

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

    b9dbd3
    b9dbd3
    b9dbd3
    b9dbd3
    b9dbd3
    b9dbd3

    2.62.4 See also

    5cb5a7
    b9dbd3
    b9dbd3
    2.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    b9dbd3
    b9dbd3
    5cb5a7
    5cb5a7
    db14a4
    b9dbd3
    [ < ]
    b9dbd3
    [ > ]
    db14a4
       
    b9dbd3
    [ << ]
    b9dbd3
    [ Up ]
    b9dbd3
    [ >> ]
    db14a4
    db14a4

    db14a4
     <font size="-1">
    406f69
      This document was generated on March, 1 2011 using texi2html 1.76.
    db14a4
     </font>
    db14a4
     
    db14a4
    db14a4

    db14a4
    </body>
    db14a4
    </html>