Blame Manuals/Repository/repository-html/repository_61.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>
7e35dc
<title>CentOS Artwork Repository: 3.58 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
7e35dc
<meta name="description" content="CentOS Artwork Repository: 3.58 trunk/Scripts/Bash/Functions/Verify">
7e35dc
<meta name="keywords" content="CentOS Artwork Repository: 3.58 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
300762
7e35dc
[ < ]
7e35dc
[ > ]
4c79b5
   
38bcd9
[ << ]
38bcd9
[ Up ]
7e35dc
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
7e35dc
[Index]
4c79b5
[ ? ]
4c79b5
7e35dc
7e35dc
7e35dc

3.58 trunk/Scripts/Bash/Functions/Verify

2dc146
2dc146
7e35dc
2dc146

3.58.1 Goals

2dc146
7e35dc

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

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

2dc146
7e35dc
2dc146

3.58.2 Description

2dc146
7e35dc

The first time you download CentOS Artwork Repository you need to

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

7e35dc

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

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

c2a1bc
7e35dc
7e35dc

3.58.2.1 Packages

7e35dc
7e35dc

Installation of auxiliar RPM packages provides the software required

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

7e35dc
info

Note

Configuration of third party repositories inside CentOS

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

7e35dc
7e35dc

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

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

7e35dc

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

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

7e35dc
7e35dc
7e35dc

3.58.2.2 Links

c2a1bc
7e35dc

Creation of symbolic links helps us to alternate between different

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

7e35dc

Creation of symbolic links helps us to reuse components from repository

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

7e35dc

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

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

7e35dc
7e35dc
7e35dc

3.58.2.3 Environment variables

7e35dc
7e35dc

Definition of environemnt variables helps us to set default values to

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

7e35dc

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

7e35dc
evaluates the following environment variables:
2dc146

2dc146
7e35dc
EDITOR
7e35dc

Default text editor.

2dc146

7e35dc

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

7e35dc
pre-commit subversion messages, translation files, configuration
7e35dc
files, script files, and similar text-based files.
2dc146

7e35dc

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

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

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

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

    7e35dc
    <tt>`centos-art.sh'</tt> uses <tt>`/usr/bin/vim'</tt> text editor by default. 
    2dc146

    7fa1fb
    7e35dc
    TEXTDOMAIN
    7e35dc
    7e35dc

    Default domain used to retrieve translated messages. This variable is

    7e35dc
    set in <tt>`initFunctions.sh'</tt> and shouldn't be changed.
    2dc146

    bf28e1
    7e35dc
    TEXTDOMAINDIR
    7e35dc
    7e35dc

    Default directory used to retrieve translated messages. This variable

    7e35dc
    is set in <tt>`initFunctions.sh'</tt> and shouldn't be changed.
    4a9d2a

    bf28e1
    7e35dc
    LANG
    7e35dc
    7e35dc

    Default locale information.

    fa7cae

    7e35dc

    This variable is initially set in the configuration process of CentOS

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

    7e35dc

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

    7e35dc
    variable to know in which language the script messages are printed
    7e35dc
    out.
    7bbd70

    bf28e1
    7e35dc
    TZ
    7e35dc
    7e35dc

    Default time zone representation.

    7bbd70

    7e35dc

    This variable is initially set in the configuration process of CentOS

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

    7e35dc

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

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

    7e35dc

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

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

    7e35dc
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    bf28e1
    7e35dc

    The format of TZ environment variable is described in

    7e35dc
    <tt>`tzset(3)'</tt> manual page.
    bf28e1

    7e35dc
    7e35dc
    c2a1bc
    7e35dc
    7e35dc
    008ee0

    3.58.3 Usage

    2c8180
    2dc146
    7e35dc
    centos-art verify --packages
    7e35dc
    7e35dc

    Verify required packages your workstation needs in order to run the

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

    7e35dc

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

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

    7e35dc
    7e35dc
    centos-art verify --links
    7e35dc
    7e35dc

    Verify required links your workstation needs in order to run the

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

    7e35dc

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

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

    7e35dc

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

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

    7e35dc
    7e35dc
    centos-art verify --environment
    7e35dc
    centos-art verify --environment --filter='regex'
    7e35dc
    7e35dc

    Output a brief description of environment variables used by

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

    7e35dc

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

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

    2dc146
    2dc146
    2dc146
    2c8180
    7e35dc
    008ee0

    3.58.4 See also

    2c8180
    4a9d2a
    7e35dc
    3.48 trunk/Scripts/Bash  
    4a9d2a
    7e35dc
    3.49 trunk/Scripts/Bash/Functions  
    4a9d2a
    4a9d2a
    c9b54d
    035049
    300762
    7e35dc
    [ < ]
    7e35dc
    [ > ]
    300762
       
    38bcd9
    [ << ]
    7e35dc
    [ Up ]
    7e35dc
    [ >> ]
    300762
    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>