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
-->
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>
c489c0
<title>The CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
c489c0
<meta name="description" content="The CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify">
c489c0
<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
c489c0
[ < ]
c489c0
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
c489c0
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
c489c0
[Index]
4c79b5
[ ? ]
4c79b5
c489c0
c489c0
c489c0

3.46 trunk/Scripts/Bash/Functions/Verify

035049
035049
c489c0
035049

3.46.1 Goals

035049
c489c0

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

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

035049
c489c0
035049

3.46.2 Description

035049
c489c0

The first time you download CentOS Artwork Repository you need to

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

c489c0

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

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

4224f4
c489c0
c489c0

3.46.2.1 Packages

c489c0
c489c0

Installation of auxiliar RPM packages provides the software required

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

c489c0
info

Note

Configuration of third party repositories inside CentOS

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

c489c0
c489c0

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

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

c489c0

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

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

c489c0
c489c0
c489c0

3.46.2.2 Links

c489c0
c489c0

Creation of symbolic links helps us to alternate between different

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

c489c0

Creation of symbolic links helps us to reuse components from repository

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

c489c0

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

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

c489c0
c489c0
c489c0

3.46.2.3 Environment variables

c489c0
c489c0

Definition of environemnt variables helps us to set default values to

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

c489c0

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

c489c0
evaluates the following environment variables:
3207df

c489c0
c489c0
EDITOR
c489c0

Default text editor.

280c77

c489c0

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

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

c489c0

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

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

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

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

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

    aaa0e9
    c489c0
    TEXTDOMAIN
    c489c0
    c489c0

    Default domain used to retrieve translated messages. This variable is

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

    aaa0e9
    c489c0
    TEXTDOMAINDIR
    c489c0
    c489c0

    Default directory used to retrieve translated messages. This variable

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

    aaa0e9
    c489c0
    LANG
    c489c0
    c489c0

    Default locale information.

    c489c0

    c489c0

    This variable is initially set in the configuration process of CentOS

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

    c489c0

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

    c489c0
    variable to know in which language the script messages are printed
    c489c0
    out.
    4224f4

    4224f4
    c489c0
    TZ
    c489c0
    c489c0

    Default time zone representation.

    aaa0e9

    c489c0

    This variable is initially set in the configuration process of CentOS

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

    c489c0

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

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

    c489c0

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

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

    c489c0
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    aaa0e9
    c489c0

    The format of TZ environment variable is described in

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

    c489c0
    c489c0
    c489c0
    c489c0
    c489c0
    aaa0e9

    3.46.3 Usage

    aaa0e9
    aaa0e9
    c489c0
    centos-art verify --packages
    c489c0
    c489c0

    Verify required packages your workstation needs in order to run the

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

    c489c0

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

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

    4224f4
    c489c0
    centos-art verify --links
    c489c0
    c489c0

    Verify required links your workstation needs in order to run the

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

    c489c0

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

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

    c489c0

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

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

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

    Output a brief description of environment variables used by

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

    c489c0

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

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

    c489c0
    c489c0
    4224f4
    c489c0
    c489c0
    4c79b5

    3.46.4 See also

    4c79b5
    008ee0
    c489c0
    3.36 trunk/Scripts/Bash  
    3d6160
    c489c0
    3.37 trunk/Scripts/Bash/Functions  
    e37211
    008ee0
    4c79b5
    4c79b5
    4c79b5
    c489c0
    [ < ]
    c489c0
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    c489c0
    [ Up ]
    c489c0
    [ >> ]
    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>