Blame Manual/repository-html/repository_62.html

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

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

aaf678
aaf678
aaf678
aaf678

1.61.1 Goals

ee1f37
aaf678

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

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

aaf678
aaf678
aaf678

1.61.2 Description

010b2d
aaf678

The first time you download CentOS Artwork Repository you need to

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

aaf678

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

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

aaf678
aaf678
aaf678

1.61.2.1 Packages

aaf678
aaf678

Installation of auxiliar RPM packages provides the software required

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

aaf678
info

Note

Configuration of third party repositories inside CentOS

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

010b2d
aaf678

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

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

aaf678

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

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

010b2d
aaf678
aaf678

1.61.2.2 Links

010b2d
aaf678

Creation of symbolic links helps us to alternate between different

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

aaf678

Creation of symbolic links helps us to reuse components from repository

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

aaf678

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

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

010b2d
aaf678
aaf678

1.61.2.3 Environment variables

010b2d
aaf678

Definition of environemnt variables helps us to set default values to

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

aaf678

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

aaf678
evaluates the following environment variables:
010b2d

010b2d
aaf678
EDITOR
aaf678

Default text editor.

010b2d

aaf678

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

aaf678
pre-commit subversion messages, translation files, configuration
aaf678
files, script files, and similar text-based files.
010b2d

aaf678

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

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

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

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

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

    010b2d
    aaf678
    TEXTDOMAIN
    aaf678
    aaf678

    Default domain used to retrieve translated messages. This variable is

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

    982d5c
    aaf678
    TEXTDOMAINDIR
    aaf678
    aaf678

    Default directory used to retrieve translated messages. This variable

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

    982d5c
    aaf678
    LANG
    aaf678
    aaf678

    Default locale information.

    010b2d

    aaf678

    This variable is initially set in the configuration process of CentOS

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

    aaf678

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

    aaf678
    variable to know in which language the script messages are printed
    aaf678
    out.
    010b2d

    982d5c
    aaf678
    TZ
    aaf678
    aaf678

    Default time zone representation.

    010b2d

    aaf678

    This variable is initially set in the configuration process of CentOS

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

    aaf678

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

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

    aaf678

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

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

    aaf678
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    ee1f37
    aaf678

    The format of TZ environment variable is described in

    aaf678
    <tt>`tzset(3)'</tt> manual page.
    010b2d

    aaf678
    aaf678
    982d5c
    aaf678
    aaf678
    aaf678

    1.61.3 Usage

    982d5c
    982d5c
    aaf678
    centos-art verify --packages
    aaf678
    aaf678

    Verify required packages your workstation needs in order to run the

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

    aaf678

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

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

    aaf678
    aaf678
    centos-art verify --links
    aaf678
    aaf678

    Verify required links your workstation needs in order to run the

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

    aaf678

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

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

    aaf678

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

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

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

    Output a brief description of environment variables used by

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

    aaf678

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

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

    010b2d
    010b2d
    010b2d
    982d5c
    aaf678
    aaf678

    1.61.4 See also

    ee1f37
    010b2d
    aaf678
    1.49 The <tt>`Filesystem/trunk/Scripts/Bash'</tt> Directory  
    010b2d
    010b2d
    ee1f37
    ee1f37
    ee1f37
    aaf678
    [ < ]
    aaf678
    [ > ]
    ee1f37
       
    aaf678
    [ << ]
    aaf678
    [ Up ]
    aaf678
    [ >> ]
    ee1f37
    ee1f37

    ee1f37
     <font size="-1">
    406f69
      This document was generated on March, 1 2011 using texi2html 1.76.
    ee1f37
     </font>
    ee1f37
     
    ee1f37
    ee1f37

    ee1f37
    </body>
    ee1f37
    </html>