Blame Manuals/Repository/repository-html/repository_62.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
-->
acd47b
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>
7fa1fb
<title>CentOS Artwork Repository: 3.59 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
7fa1fb
<meta name="description" content="CentOS Artwork Repository: 3.59 trunk/Scripts/Bash/Functions/Verify">
7fa1fb
<meta name="keywords" content="CentOS Artwork Repository: 3.59 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
bc3531
7fa1fb
[ < ]
7fa1fb
[ > ]
4c79b5
   
38bcd9
[ << ]
008ee0
[ Up ]
7fa1fb
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
7fa1fb
[Index]
4c79b5
[ ? ]
4c79b5
7fa1fb
7fa1fb
7fa1fb

3.59 trunk/Scripts/Bash/Functions/Verify

7fa1fb
7fa1fb
7fa1fb
7fa1fb

3.59.1 Goals

7fa1fb
7fa1fb

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

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

7fa1fb
7fa1fb
7fa1fb

3.59.2 Description

7fa1fb
7fa1fb

The first time you download CentOS Artwork Repository you need to

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

7fa1fb

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

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

7fa1fb
13b177
7fa1fb

3.59.2.1 Packages

008ee0
7fa1fb

Installation of auxiliar RPM packages provides the software required

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

7fa1fb
info

Note

Configuration of third party repositories inside CentOS

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

7fa1fb
7fa1fb

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

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

7fa1fb

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

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

008ee0
13b177
7fa1fb

3.59.2.2 Links

008ee0
7fa1fb

Creation of symbolic links helps us to alternate between different

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

7fa1fb

Creation of symbolic links helps us to reuse components from repository

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

7fa1fb

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

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

008ee0
13b177
7fa1fb

3.59.2.3 Environment variables

7fa1fb
7fa1fb

Definition of environemnt variables helps us to set default values to

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

7fa1fb

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

7fa1fb
evaluates the following environment variables:
7fa1fb

7fa1fb
7fa1fb
EDITOR
7fa1fb

Default text editor.

7fa1fb

7fa1fb

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

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

7fa1fb

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

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

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

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

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

    7fa1fb
    7fa1fb
    TEXTDOMAIN
    7fa1fb
    7fa1fb

    Default domain used to retrieve translated messages. This variable is

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

    7fa1fb
    7fa1fb
    TEXTDOMAINDIR
    7fa1fb
    7fa1fb

    Default directory used to retrieve translated messages. This variable

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

    7fa1fb
    7fa1fb
    LANG
    7fa1fb
    7fa1fb

    Default locale information.

    7fa1fb

    7fa1fb

    This variable is initially set in the configuration process of CentOS

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

    7fa1fb

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

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

    7fa1fb
    7fa1fb
    TZ
    7fa1fb
    7fa1fb

    Default time zone representation.

    7fa1fb

    7fa1fb

    This variable is initially set in the configuration process of CentOS

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

    7fa1fb

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

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

    7fa1fb

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

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

    7fa1fb
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    008ee0
    7fa1fb

    The format of TZ environment variable is described in

    7fa1fb
    <tt>`tzset(3)'</tt> manual page.
    2dc146

    7fa1fb
    7fa1fb
    7fa1fb
    008ee0
    13b177
    008ee0

    3.59.3 Usage

    008ee0
    7fa1fb
    7fa1fb
    centos-art verify --packages
    7fa1fb
    7fa1fb

    Verify required packages your workstation needs in order to run the

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

    7fa1fb

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

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

    7fa1fb
    7fa1fb
    centos-art verify --links
    7fa1fb
    7fa1fb

    Verify required links your workstation needs in order to run the

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

    7fa1fb

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

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

    7fa1fb

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

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

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

    Output a brief description of environment variables used by

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

    7fa1fb

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

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

    7fa1fb
    7fa1fb
    7fa1fb
    008ee0
    13b177
    008ee0

    3.59.4 See also

    008ee0
    2dc146
    7fa1fb
    3.49 trunk/Scripts/Bash  
    2dc146
    7fa1fb
    3.50 trunk/Scripts/Bash/Functions  
    2dc146
    2dc146
    38bcd9
    4a9d2a
    bc3531
    13b177
    [ < ]
    13b177
    [ > ]
    bc3531
       
    38bcd9
    [ << ]
    7fa1fb
    [ Up ]
    7fa1fb
    [ >> ]
    bc3531
    4c79b5

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

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