Blame Manual/repository-html/repository_63.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>
b130a0
<title>CentOS Artwork Repository: 1.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory</title>
ee1f37
b130a0
<meta name="description" content="CentOS Artwork Repository: 1.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory">
b130a0
<meta name="keywords" content="CentOS Artwork Repository: 1.62 The 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
b130a0
[ < ]
b130a0
[ > ]
ee1f37
   
aaf678
[ << ]
aaf678
[ Up ]
b130a0
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
56a476
[Top]
56a476
[Contents]
b130a0
[Index]
56a476
[ ? ]
ee1f37
b130a0
b130a0
b130a0

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

982d5c
ee1f37
b130a0
aaf678

1.62.1 Goals

ee1f37
b130a0

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

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

b130a0
b130a0
b130a0

1.62.2 Description

b130a0
b130a0

The first time you download CentOS Artwork Repository you need to

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

b130a0

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

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

b130a0
b130a0
b130a0

1.62.2.1 Packages

b130a0
b130a0

Installation of auxiliar RPM packages provides the software required

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

b130a0
info

Note

Configuration of third party repositories inside CentOS

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

7ba52f
b130a0

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

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

b130a0

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

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

b130a0
b130a0
b130a0

1.62.2.2 Links

b130a0
b130a0

Creation of symbolic links helps us to alternate between different

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

b130a0

Creation of symbolic links helps us to reuse components from repository

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

b130a0

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

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

7ba52f
aaf678
b130a0

1.62.2.3 Environment variables

7ba52f
b130a0

Definition of environemnt variables helps us to set default values to

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

b130a0

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

b130a0
evaluates the following environment variables:
b130a0

b130a0
b130a0
EDITOR
b130a0

Default text editor.

b130a0

b130a0

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

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

b130a0

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

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

7ba52f
    b130a0
  • <tt>`/usr/bin/vim'</tt>
  • b130a0
  • <tt>`/usr/bin/emacs'</tt>
  • b130a0
  • <tt>`/usr/bin/nano'</tt>
  • 7ba52f
    7ba52f
    b130a0

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

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

    b130a0
    b130a0
    TEXTDOMAIN
    b130a0
    b130a0

    Default domain used to retrieve translated messages. This variable is

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

    b130a0
    b130a0
    TEXTDOMAINDIR
    b130a0
    b130a0

    Default directory used to retrieve translated messages. This variable

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

    b130a0
    b130a0
    LANG
    b130a0
    b130a0

    Default locale information.

    b130a0

    b130a0

    This variable is initially set in the configuration process of CentOS

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

    b130a0

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

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

    b130a0
    b130a0
    TZ
    b130a0
    b130a0

    Default time zone representation.

    b130a0

    b130a0

    This variable is initially set in the configuration process of CentOS

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

    b130a0

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

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

    b130a0

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

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

    b130a0
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    b130a0
    b130a0

    The format of TZ environment variable is described in

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

    b130a0
    b130a0
    b130a0
    7ba52f
    aaf678
    aaf678

    1.62.3 Usage

    7ba52f
    b130a0
    b130a0
    centos-art verify --packages
    b130a0
    b130a0

    Verify required packages your workstation needs in order to run the

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

    b130a0

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

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

    b130a0
    b130a0
    centos-art verify --links
    b130a0
    b130a0

    Verify required links your workstation needs in order to run the

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

    b130a0

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

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

    b130a0

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

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

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

    Output a brief description of environment variables used by

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

    b130a0

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

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

    b130a0
    b130a0
    7ba52f
    7ba52f
    aaf678
    aaf678

    1.62.4 See also

    ee1f37
    b130a0
    b130a0
    1.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    b130a0
    b130a0
    193ea4
    193ea4
    ee1f37
    aaf678
    [ < ]
    aaf678
    [ > ]
    ee1f37
       
    aaf678
    [ << ]
    b130a0
    [ Up ]
    b130a0
    [ >> ]
    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>