Blame Manuals/Repository/repository-html/repository_62.html

4c79b5
4c79b5
<html>
ccb7a3
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
-->
bf28e1
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>
d11e55
<title>CentOS Artwork Repository: 3.59 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
d11e55
<meta name="description" content="CentOS Artwork Repository: 3.59 trunk/Scripts/Bash/Functions/Verify">
d11e55
<meta name="keywords" content="CentOS Artwork Repository: 3.59 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
bc3531
d11e55
[ < ]
d11e55
[ > ]
4c79b5
   
38bcd9
[ << ]
008ee0
[ Up ]
d11e55
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
d11e55
[Index]
4c79b5
[ ? ]
4c79b5
d11e55
d11e55
d11e55

3.59 trunk/Scripts/Bash/Functions/Verify

008ee0
008ee0
d11e55
7e35dc

3.59.1 Goals

008ee0
d11e55

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

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

008ee0
d11e55
7e35dc

3.59.2 Description

008ee0
d11e55

The first time you download CentOS Artwork Repository you need to

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

d11e55

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

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

d11e55
d11e55
d11e55

3.59.2.1 Packages

d11e55
d11e55

Installation of auxiliar RPM packages provides the software required

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

d11e55
info

Note

Configuration of third party repositories inside CentOS

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

008ee0
d11e55

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

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

d11e55

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

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

d11e55
d11e55
d11e55

3.59.2.2 Links

d11e55
d11e55

Creation of symbolic links helps us to alternate between different

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

d11e55

Creation of symbolic links helps us to reuse components from repository

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

d11e55

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

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

d11e55
d11e55
d11e55

3.59.2.3 Environment variables

d11e55
d11e55

Definition of environemnt variables helps us to set default values to

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

d11e55

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

d11e55
evaluates the following environment variables:
d11e55

d11e55
d11e55
EDITOR
d11e55

Default text editor.

d11e55

d11e55

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

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

d11e55

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

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

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

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

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

    d11e55
    d11e55
    TEXTDOMAIN
    d11e55
    d11e55

    Default domain used to retrieve translated messages. This variable is

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

    d11e55
    d11e55
    TEXTDOMAINDIR
    d11e55
    d11e55

    Default directory used to retrieve translated messages. This variable

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

    d11e55
    d11e55
    LANG
    d11e55
    d11e55

    Default locale information.

    d11e55

    d11e55

    This variable is initially set in the configuration process of CentOS

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

    d11e55

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

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

    d11e55
    d11e55
    TZ
    d11e55
    d11e55

    Default time zone representation.

    d11e55

    d11e55

    This variable is initially set in the configuration process of CentOS

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

    d11e55

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

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

    d11e55

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

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

    d11e55
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    d11e55
    d11e55

    The format of TZ environment variable is described in

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

    d11e55
    d11e55
    d11e55
    d11e55
    d11e55
    008ee0

    3.59.3 Usage

    008ee0
    d11e55
    d11e55
    centos-art verify --packages
    d11e55
    d11e55

    Verify required packages your workstation needs in order to run the

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

    d11e55

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

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

    d11e55
    d11e55
    centos-art verify --links
    d11e55
    d11e55

    Verify required links your workstation needs in order to run the

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

    d11e55

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

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

    d11e55

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

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

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

    Output a brief description of environment variables used by

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

    d11e55

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

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

    d11e55
    d11e55
    008ee0
    d11e55
    d11e55
    008ee0

    3.59.4 See also

    008ee0
    2dc146
    d11e55
    3.49 trunk/Scripts/Bash  
    2dc146
    d11e55
    3.50 trunk/Scripts/Bash/Functions  
    2dc146
    2dc146
    38bcd9
    4a9d2a
    bc3531
    d11e55
    [ < ]
    d11e55
    [ > ]
    bc3531
       
    38bcd9
    [ << ]
    d11e55
    [ Up ]
    d11e55
    [ >> ]
    bc3531
    4c79b5

    4c79b5
     <font size="-1">
    bf28e1
      This document was generated on February, 27 2011 using texi2html 1.76.
    4c79b5
     </font>
    4c79b5
     
    4c79b5
    4c79b5

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