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

3.59 trunk/Scripts/Bash/Functions/Verify

70ef27
70ef27
70ef27
70ef27

3.59.1 Goals

70ef27
70ef27

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

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

70ef27
70ef27
70ef27

3.59.2 Description

70ef27
70ef27

The first time you download CentOS Artwork Repository you need to

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

70ef27

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

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

70ef27
d11e55
70ef27

3.59.2.1 Packages

008ee0
70ef27

Installation of auxiliar RPM packages provides the software required

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

70ef27
info

Note

Configuration of third party repositories inside CentOS

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

70ef27
70ef27

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

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

70ef27

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

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

d11e55
d11e55
70ef27

3.59.2.2 Links

d11e55
70ef27

Creation of symbolic links helps us to alternate between different

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

70ef27

Creation of symbolic links helps us to reuse components from repository

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

70ef27

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

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

d11e55
2c3589
70ef27

3.59.2.3 Environment variables

70ef27
70ef27

Definition of environemnt variables helps us to set default values to

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

70ef27

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

70ef27
evaluates the following environment variables:
70ef27

70ef27
70ef27
EDITOR
70ef27

Default text editor.

70ef27

70ef27

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

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

70ef27

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

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

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

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

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

    70ef27
    70ef27
    TEXTDOMAIN
    70ef27
    70ef27

    Default domain used to retrieve translated messages. This variable is

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

    70ef27
    70ef27
    TEXTDOMAINDIR
    70ef27
    70ef27

    Default directory used to retrieve translated messages. This variable

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

    70ef27
    70ef27
    LANG
    70ef27
    70ef27

    Default locale information.

    70ef27

    70ef27

    This variable is initially set in the configuration process of CentOS

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

    70ef27

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

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

    70ef27
    70ef27
    TZ
    70ef27
    70ef27

    Default time zone representation.

    70ef27

    70ef27

    This variable is initially set in the configuration process of CentOS

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

    70ef27

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

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

    70ef27

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

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

    70ef27
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    d11e55
    70ef27

    The format of TZ environment variable is described in

    70ef27
    <tt>`tzset(3)'</tt> manual page.
    42563b

    70ef27
    70ef27
    70ef27
    d11e55
    d11e55
    008ee0

    3.59.3 Usage

    008ee0
    70ef27
    70ef27
    centos-art verify --packages
    70ef27
    70ef27

    Verify required packages your workstation needs in order to run the

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

    70ef27

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

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

    70ef27
    70ef27
    centos-art verify --links
    70ef27
    70ef27

    Verify required links your workstation needs in order to run the

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

    70ef27

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

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

    70ef27

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

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

    70ef27
    70ef27
    centos-art verify --environment
    70ef27
    centos-art verify --environment --filter='regex'
    70ef27
    70ef27

    Output a brief description of environment variables used by

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

    70ef27

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

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

    70ef27
    70ef27
    70ef27
    d11e55
    d11e55
    008ee0

    3.59.4 See also

    008ee0
    42563b
    70ef27
    3.49 trunk/Scripts/Bash  
    42563b
    70ef27
    3.50 trunk/Scripts/Bash/Functions  
    42563b
    42563b
    38bcd9
    4a9d2a
    bc3531
    d11e55
    [ < ]
    d11e55
    [ > ]
    bc3531
       
    38bcd9
    [ << ]
    70ef27
    [ Up ]
    70ef27
    [ >> ]
    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>