Blame Manuals/Repository/repository-html/repository_60.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>
2c3589
<title>CentOS Artwork Repository: 3.57 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
2c3589
<meta name="description" content="CentOS Artwork Repository: 3.57 trunk/Scripts/Bash/Functions/Verify">
2c3589
<meta name="keywords" content="CentOS Artwork Repository: 3.57 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
300762
2c3589
[ < ]
2c3589
[ > ]
4c79b5
   
4c79b5
[ << ]
38bcd9
[ Up ]
2c3589
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
2c3589
[Index]
4c79b5
[ ? ]
4c79b5
2c3589
2c3589
2c3589

3.57 trunk/Scripts/Bash/Functions/Verify

4a9d2a
4a9d2a
2c3589
4a9d2a

3.57.1 Goals

4a9d2a
2c3589

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

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

4a9d2a
2c3589
4a9d2a

3.57.2 Description

4a9d2a
2c3589

The first time you download CentOS Artwork Repository you need to

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

2c3589

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

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

d11e55
2c3589
2c3589

3.57.2.1 Packages

2dc146
2c3589

Installation of auxiliar RPM packages provides the software required

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

2c3589
info

Note

Configuration of third party repositories inside CentOS

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

2dc146
2c3589

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

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

2c3589

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

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

7e35dc
2c3589
2c3589

3.57.2.2 Links

008ee0
2c3589

Creation of symbolic links helps us to alternate between different

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

2c3589

Creation of symbolic links helps us to reuse components from repository

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

2c3589

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

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

2c3589
2c3589
2c3589

3.57.2.3 Environment variables

2c3589
2c3589

Definition of environemnt variables helps us to set default values to

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

2c3589

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

2c3589
evaluates the following environment variables:
2c3589

4a9d2a
2c3589
EDITOR
2c3589

Default text editor.

2c3589

2c3589

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

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

2c3589

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

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

2c3589
    2c3589
  • <tt>`/usr/bin/vim'</tt>
  • 2c3589
  • <tt>`/usr/bin/emacs'</tt>
  • 2c3589
  • <tt>`/usr/bin/nano'</tt>
  • 2c3589
    4a9d2a
    2c3589

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

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

    2c3589
    2c3589
    TEXTDOMAIN
    2c3589
    2c3589

    Default domain used to retrieve translated messages. This variable is

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

    2c3589
    2c3589
    TEXTDOMAINDIR
    2c3589
    2c3589

    Default directory used to retrieve translated messages. This variable

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

    2c3589
    2c3589
    LANG
    2c3589
    2c3589

    Default locale information.

    2c3589

    2c3589

    This variable is initially set in the configuration process of CentOS

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

    2c3589

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

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

    2c3589
    2c3589
    TZ
    2c3589
    2c3589

    Default time zone representation.

    2c3589

    2c3589

    This variable is initially set in the configuration process of CentOS

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

    2c3589

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

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

    2c3589

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

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

    2c3589
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    2dc146
    2c3589

    The format of TZ environment variable is described in

    2c3589
    <tt>`tzset(3)'</tt> manual page.
    2dc146

    2c3589
    2c3589
    008ee0
    2c3589
    2c3589
    2c3589

    3.57.3 Usage

    2c3589
    2c3589
    2c3589
    centos-art verify --packages
    2c3589
    2c3589

    Verify required packages your workstation needs in order to run the

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

    2c3589

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

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

    2c3589
    2c3589
    centos-art verify --links
    2c3589
    2c3589

    Verify required links your workstation needs in order to run the

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

    2c3589

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

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

    2c3589

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

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

    2c3589
    2c3589
    centos-art verify --environment
    2c3589
    centos-art verify --environment --filter='regex'
    2c3589
    2c3589

    Output a brief description of environment variables used by

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

    2c3589

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

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

    2c3589
    2c3589
    2c3589
    2c3589
    2c3589
    38bcd9

    3.57.4 See also

    38bcd9
    4a9d2a
    2c3589
    3.47 trunk/Scripts/Bash  
    4a9d2a
    2c3589
    3.48 trunk/Scripts/Bash/Functions  
    4a9d2a
    4a9d2a
    008ee0
    6aec21
    300762
    2c3589
    [ < ]
    2c3589
    [ > ]
    300762
       
    300762
    [ << ]
    2c3589
    [ Up ]
    2c3589
    [ >> ]
    300762
    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>