Blame Identity/Manual/repository-html/repository_79.html

632e8b
632e8b
<html>
632e8b
632e8b
organization, and administration of CentOS Artwork Repository.
632e8b
632e8b
Copyright C 2009-2011 Alain Reguera Delgado
632e8b
632e8b
Permission is granted to copy, distribute and/or modify this document
632e8b
under the terms of the GNU Free Documentation License, Version 1.2 or
632e8b
any later version published by the Free Software Foundation; with no
632e8b
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
632e8b
copy of the license is included in the section entitled GNU Free
632e8b
Documentation License.  
632e8b
-->
f456e5
632e8b
632e8b
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
632e8b
            Karl Berry  <karl@freefriends.org>
632e8b
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
632e8b
            and many others.
632e8b
Maintained by: Many creative people <dev@texi2html.cvshome.org>
632e8b
Send bugs and suggestions to <users@texi2html.cvshome.org>
632e8b
632e8b
-->
632e8b
<head>
ed9de5
<title>CentOS Artwork Repository: 2.72 The trunk/Scripts/Functions/Verify Directory</title>
632e8b
ed9de5
<meta name="description" content="CentOS Artwork Repository: 2.72 The trunk/Scripts/Functions/Verify Directory">
ed9de5
<meta name="keywords" content="CentOS Artwork Repository: 2.72 The trunk/Scripts/Functions/Verify Directory">
632e8b
<meta name="resource-type" content="document">
632e8b
<meta name="distribution" content="global">
632e8b
<meta name="Generator" content="texi2html 1.76">
632e8b
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
632e8b
<style type="text/css">
632e8b
f456e5
@import "/home/centos/artwork/trunk/Identity/Manual/repository.css";
632e8b
632e8b
a.summary-letter {text-decoration: none}
632e8b
pre.display {font-family: serif}
632e8b
pre.format {font-family: serif}
632e8b
pre.menu-comment {font-family: serif}
632e8b
pre.menu-preformatted {font-family: serif}
632e8b
pre.smalldisplay {font-family: serif; font-size: smaller}
632e8b
pre.smallexample {font-size: smaller}
632e8b
pre.smallformat {font-family: serif; font-size: smaller}
632e8b
pre.smalllisp {font-size: smaller}
632e8b
span.sansserif {font-family:sans-serif; font-weight:normal;}
632e8b
ul.toc {list-style: none}
632e8b
-->
632e8b
</style>
632e8b
632e8b
632e8b
</head>
632e8b
632e8b
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
632e8b
632e8b
ed9de5
[ < ]
ed9de5
[ > ]
632e8b
   
1075b9
[ << ]
1075b9
[ Up ]
ed9de5
[ >> ]
632e8b
   
632e8b
   
632e8b
   
632e8b
   
1075b9
[Top]
1075b9
[Contents]
ed9de5
[Index]
1075b9
[ ? ]
632e8b
ed9de5
ed9de5
ed9de5

2.72 The <tt>`trunk/Scripts/Functions/Verify'</tt> Directory

06d106
06d106
ed9de5
52772c

2.72.1 Goals

06d106
ed9de5

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

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

06d106
ed9de5
52772c

2.72.2 Description

06d106
ed9de5

The first time you download CentOS Artwork Repository you need to

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

ed9de5

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

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

ed9de5
ed9de5
ed9de5

2.72.2.1 Packages

ed9de5
ed9de5

Installation of auxiliar RPM packages provides the software required

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

f456e5
info

Note

Configuration of third party repositories inside CentOS

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

06d106
ed9de5

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

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

ed9de5

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

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

06d106
ed9de5
ed9de5

2.72.2.2 Links

ed9de5
ed9de5

Creation of symbolic links helps us to alternate between different

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

ed9de5

Creation of symbolic links helps us to reuse components from repository

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

ed9de5

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

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

ed9de5
ed9de5
ed9de5

2.72.2.3 Environment variables

06d106
ed9de5

Definition of environemnt variables helps us to set default values to

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

ed9de5

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

ed9de5
evaluates the following environment variables:
06d106

06d106
ed9de5
EDITOR
ed9de5

Default text editor.

ed9de5

ed9de5

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

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

ed9de5

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

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

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

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

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

    ed9de5
    ed9de5
    TEXTDOMAIN
    06d106
    ed9de5

    Default domain used to retrieve translated messages. This variable is

    ed9de5
    set in <tt>`initFunctions.sh'</tt> and shouldn't be changed.
    06d106

    06d106
    ed9de5
    TEXTDOMAINDIR
    06d106
    ed9de5

    Default directory used to retrieve translated messages. This variable

    ed9de5
    is set in <tt>`initFunctions.sh'</tt> and shouldn't be changed.
    06d106

    06d106
    ed9de5
    LANG
    06d106
    ed9de5

    Default locale information.

    ed9de5

    ed9de5

    This variable is initially set in the configuration process of CentOS

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

    ed9de5

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

    ed9de5
    variable to know in which language the script messages are printed
    ed9de5
    out.
    06d106

    06d106
    ed9de5
    TZ
    06d106
    ed9de5

    Default time zone representation.

    ed9de5

    ed9de5

    This variable is initially set in the configuration process of CentOS

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

    ed9de5

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

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

    ed9de5

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

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

    f456e5
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    ed9de5
    ed9de5

    The format of TZ environment variable is described in

    ed9de5
    <tt>`tzset(3)'</tt> manual page.
    06d106

    06d106
    06d106
    06d106
    ed9de5
    ed9de5
    ed9de5

    2.72.3 Usage

    ed9de5
    ed9de5
    ed9de5
    centos-art verify --packages
    ed9de5
    ed9de5

    Verify required packages your workstation needs in order to run the

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

    ed9de5

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

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

    ed9de5
    ed9de5
    centos-art verify --links
    ed9de5
    ed9de5

    Verify required links your workstation needs in order to run the

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

    ed9de5

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

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

    ed9de5

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

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

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

    Output a brief description of environment variables used by

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

    ed9de5

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

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

    ed9de5
    ed9de5
    ed9de5
    06d106
    ed9de5
    52772c

    2.72.4 See also

    06d106
    06d106
    ed9de5
    2.60 The <tt>`trunk/Scripts'</tt> Directory  
    06d106
    9bfd15
    632e8b
    632e8b
    ed9de5
    ed9de5
    632e8b
    ed9de5
    [ < ]
    ed9de5
    [ > ]
    632e8b
       
    1075b9
    [ << ]
    ed9de5
    [ Up ]
    ed9de5
    [ >> ]
    632e8b
    632e8b

    632e8b
     <font size="-1">
    f456e5
      This document was generated on March, 24 2011 using texi2html 1.76.
    632e8b
     </font>
    632e8b
     
    632e8b
    632e8b

    632e8b
    </body>
    632e8b
    </html>