Blame Manuals/en/Html/Repository/repository_49.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
-->
6414c4
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>
3207df
<title>The CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
3207df
<meta name="description" content="The CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify">
3207df
<meta name="keywords" content="The CentOS Artwork Repository: 3.46 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
3207df
[ < ]
3207df
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
3207df
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
3207df
[Index]
4c79b5
[ ? ]
4c79b5
3207df
3207df
3207df

3.46 trunk/Scripts/Bash/Functions/Verify

035049
035049
3207df
035049

3.46.1 Goals

035049
3207df

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

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

035049
3207df
035049

3.46.2 Description

035049
3207df

The first time you download CentOS Artwork Repository you need to

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

3207df

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

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

035049
3207df
3207df

3.46.2.1 Packages

3207df
3207df

Installation of auxiliar RPM packages provides the software required

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

3207df
info

Note

Configuration of third party repositories inside CentOS

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

3207df
3207df

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

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

3207df

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

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

3207df
3207df
3207df

3.46.2.2 Links

3207df
3207df

Creation of symbolic links helps us to alternate between different

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

3207df

Creation of symbolic links helps us to reuse components from repository

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

3207df

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

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

3207df
3207df
3207df

3.46.2.3 Environment variables

3207df
3207df

Definition of environemnt variables helps us to set default values to

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

3207df

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

3207df
evaluates the following environment variables:
035049

3207df
3207df
EDITOR
3207df

Default text editor.

035049

3207df

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

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

3207df

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

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

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

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

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

    6414c4
    3207df
    TEXTDOMAIN
    3207df
    3207df

    Default domain used to retrieve translated messages. This variable is

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

    035049
    3207df
    TEXTDOMAINDIR
    3207df
    3207df

    Default directory used to retrieve translated messages. This variable

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

    035049
    3207df
    LANG
    3207df
    3207df

    Default locale information.

    3207df

    3207df

    This variable is initially set in the configuration process of CentOS

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

    3207df

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

    3207df
    variable to know in which language the script messages are printed
    3207df
    out.
    035049

    035049
    3207df
    TZ
    3207df
    3207df

    Default time zone representation.

    749e81

    3207df

    This variable is initially set in the configuration process of CentOS

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

    3207df

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

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

    3207df

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

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

    3207df
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    6414c4
    3207df

    The format of TZ environment variable is described in

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

    3207df
    3207df
    3207df
    3207df
    3207df
    6414c4

    3.46.3 Usage

    6414c4
    6414c4
    3207df
    centos-art verify --packages
    3207df
    3207df

    Verify required packages your workstation needs in order to run the

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

    3207df

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

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

    749e81
    3207df
    centos-art verify --links
    3207df
    3207df

    Verify required links your workstation needs in order to run the

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

    3207df

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

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

    3207df

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

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

    3207df
    3207df
    centos-art verify --environment
    3207df
    centos-art verify --environment --filter='regex'
    3207df
    3207df

    Output a brief description of environment variables used by

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

    3207df

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

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

    3207df
    3207df
    749e81
    3207df
    3207df
    4c79b5

    3.46.4 See also

    4c79b5
    008ee0
    3207df
    3.36 trunk/Scripts/Bash  
    3d6160
    3207df
    3.37 trunk/Scripts/Bash/Functions  
    e37211
    008ee0
    4c79b5
    4c79b5
    4c79b5
    3207df
    [ < ]
    3207df
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    3207df
    [ Up ]
    3207df
    [ >> ]
    4c79b5
    4c79b5

    4c79b5
     <font size="-1">
    6414c4
      This document was generated on January, 3 2011 using texi2html 1.76.
    4c79b5
     </font>
    4c79b5
     
    4c79b5
    4c79b5

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