Blame Manual/repository-html/repository_76.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
-->
ff7772
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>
632e8b
<title>CentOS Artwork Repository: 2.72 The trunk/Scripts/Bash/Cli/Functions/Verify Directory</title>
632e8b
632e8b
<meta name="description" content="CentOS Artwork Repository: 2.72 The trunk/Scripts/Bash/Cli/Functions/Verify Directory">
632e8b
<meta name="keywords" content="CentOS Artwork Repository: 2.72 The trunk/Scripts/Bash/Cli/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
632e8b
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.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
ff7772
[ < ]
ff7772
[ > ]
632e8b
   
632e8b
[ << ]
632e8b
[ Up ]
ff7772
[ >> ]
632e8b
   
632e8b
   
632e8b
   
632e8b
   
632e8b
[Top]
632e8b
[Contents]
ff7772
[Index]
632e8b
[ ? ]
632e8b
632e8b
ff7772
632e8b

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

632e8b
632e8b
ff7772
632e8b

2.72.1 Goals

632e8b
632e8b

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

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

632e8b
ff7772
632e8b

2.72.2 Description

632e8b
632e8b

The first time you download CentOS Artwork Repository you need to

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

632e8b

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

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

632e8b
ff7772
632e8b

2.72.2.1 Packages

632e8b
632e8b

Installation of auxiliar RPM packages provides the software required

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

632e8b
info

Note

Configuration of third party repositories inside CentOS

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

632e8b
632e8b

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

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

632e8b

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

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

632e8b
ff7772
632e8b

2.72.2.2 Links

632e8b
632e8b

Creation of symbolic links helps us to alternate between different

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

632e8b

Creation of symbolic links helps us to reuse components from repository

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

632e8b

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

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

632e8b
ff7772
632e8b

2.72.2.3 Environment variables

632e8b
632e8b

Definition of environemnt variables helps us to set default values to

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

632e8b

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

632e8b
evaluates the following environment variables:
632e8b

632e8b
632e8b
EDITOR
632e8b

Default text editor.

632e8b

632e8b

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

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

632e8b

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

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

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

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

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

    632e8b
    632e8b
    TEXTDOMAIN
    632e8b
    632e8b

    Default domain used to retrieve translated messages. This variable is

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

    632e8b
    632e8b
    TEXTDOMAINDIR
    632e8b
    632e8b

    Default directory used to retrieve translated messages. This variable

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

    632e8b
    632e8b
    LANG
    632e8b
    632e8b

    Default locale information.

    632e8b

    632e8b

    This variable is initially set in the configuration process of CentOS

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

    632e8b

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

    632e8b
    variable to know in which language the script messages are printed
    632e8b
    out.
    632e8b

    632e8b
    632e8b
    TZ
    632e8b
    632e8b

    Default time zone representation.

    632e8b

    632e8b

    This variable is initially set in the configuration process of CentOS

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

    632e8b

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

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

    632e8b

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

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

    632e8b
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    632e8b
    632e8b

    The format of TZ environment variable is described in

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

    632e8b
    632e8b
    632e8b
    632e8b
    ff7772
    632e8b

    2.72.3 Usage

    632e8b
    632e8b
    632e8b
    centos-art verify --packages
    632e8b
    632e8b

    Verify required packages your workstation needs in order to run the

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

    632e8b

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

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

    632e8b
    632e8b
    centos-art verify --links
    632e8b
    632e8b

    Verify required links your workstation needs in order to run the

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

    632e8b

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

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

    632e8b

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

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

    632e8b
    632e8b
    centos-art verify --environment
    632e8b
    centos-art verify --environment --filter='regex'
    632e8b
    632e8b

    Output a brief description of environment variables used by

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

    632e8b

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

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

    632e8b
    632e8b
    632e8b
    632e8b
    ff7772
    632e8b

    2.72.4 See also

    632e8b
    632e8b
    ff7772
    2.60 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    632e8b
    632e8b
    632e8b
    632e8b
    632e8b
    ff7772
    [ < ]
    ff7772
    [ > ]
    632e8b
       
    632e8b
    [ << ]
    ff7772
    [ Up ]
    ff7772
    [ >> ]
    632e8b
    632e8b

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

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