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

3.47 trunk/Scripts/Bash/Functions/Verify

280c77
280c77
280c77
280c77

3.47.1 Goals

280c77
280c77

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

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

280c77
280c77
280c77

3.47.2 Description

280c77
280c77

The first time you download CentOS Artwork Repository you need to

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

280c77

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

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

280c77
01b527
280c77

3.47.2.1 Packages

4c79b5
280c77

Installation of auxiliar RPM packages provides the software required

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

280c77
info

Note

Configuration of third party repositories inside CentOS

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

280c77
280c77

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

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

280c77

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

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

4c79b5
01b527
280c77

3.47.2.2 Links

4c79b5
280c77

Creation of symbolic links helps us to alternate between different

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

280c77

Creation of symbolic links helps us to reuse components from repository

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

280c77

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

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

eae802
01b527
280c77

3.47.2.3 Environment variables

280c77
280c77

Definition of environemnt variables helps us to set default values to

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

280c77

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

280c77
evaluates the following environment variables:
280c77

280c77
280c77
EDITOR
280c77

Default text editor.

280c77

280c77

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

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

280c77

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

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

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

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

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

    280c77
    280c77
    TEXTDOMAIN
    280c77
    280c77

    Default domain used to retrieve translated messages. This variable is

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

    280c77
    280c77
    TEXTDOMAINDIR
    280c77
    280c77

    Default directory used to retrieve translated messages. This variable

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

    280c77
    280c77
    LANG
    280c77
    280c77

    Default locale information.

    280c77

    280c77

    This variable is initially set in the configuration process of CentOS

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

    280c77

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

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

    280c77
    280c77
    TZ
    280c77
    280c77

    Default time zone representation.

    280c77

    280c77

    This variable is initially set in the configuration process of CentOS

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

    280c77

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

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

    280c77

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

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

    280c77
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    6414c4
    280c77

    The format of TZ environment variable is described in

    280c77
    <tt>`tzset(3)'</tt> manual page.
    6414c4

    280c77
    280c77
    280c77
    54b5a5
    01b527
    2c8180

    3.47.3 Usage

    6aec21
    280c77
    280c77
    centos-art verify --packages
    280c77
    280c77

    Verify required packages your workstation needs in order to run the

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

    280c77

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

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

    280c77
    280c77
    centos-art verify --links
    280c77
    280c77

    Verify required links your workstation needs in order to run the

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

    280c77

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

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

    280c77

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

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

    280c77
    280c77
    centos-art verify --environment
    280c77
    centos-art verify --environment --filter='regex'
    280c77
    280c77

    Output a brief description of environment variables used by

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

    280c77

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

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

    280c77
    280c77
    280c77
    6aec21
    01b527
    4c79b5

    3.47.4 See also

    4c79b5
    035049
    280c77
    3.37 trunk/Scripts/Bash  
    c6292c
    280c77
    3.38 trunk/Scripts/Bash/Functions  
    749e81
    035049
    4c79b5
    4c79b5
    4c79b5
    01b527
    [ < ]
    01b527
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    280c77
    [ Up ]
    280c77
    [ >> ]
    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>