Blame Identity/Manual/repository-html/repository_82.html

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

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

52772c
52772c
52772c
52772c

2.75.1 Goals

52772c
52772c

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

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

52772c
52772c
52772c

2.75.2 Description

52772c
52772c

The first time you download CentOS Artwork Repository you need to

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

52772c

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

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

52772c
52772c
52772c

2.75.2.1 Packages

52772c
52772c

Installation of auxiliar RPM packages provides the software required

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

52772c
info

Note

Configuration of third party repositories inside CentOS

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

52772c
52772c

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

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

52772c

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

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

52772c
52772c
52772c

2.75.2.2 Links

52772c
52772c

Creation of symbolic links helps us to alternate between different

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

52772c

Creation of symbolic links helps us to reuse components from repository

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

52772c

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

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

52772c
52772c
52772c

2.75.2.3 Environment variables

52772c
52772c

Definition of environemnt variables helps us to set default values to

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

52772c

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

52772c
evaluates the following environment variables:
52772c

52772c
52772c
EDITOR
52772c

Default text editor.

52772c

52772c

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

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

52772c

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

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

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

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

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

    52772c
    52772c
    TEXTDOMAIN
    52772c
    52772c

    Default domain used to retrieve translated messages. This variable is

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

    52772c
    52772c
    TEXTDOMAINDIR
    52772c
    52772c

    Default directory used to retrieve translated messages. This variable

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

    52772c
    52772c
    LANG
    52772c
    52772c

    Default locale information.

    52772c

    52772c

    This variable is initially set in the configuration process of CentOS

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

    52772c

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

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

    52772c
    52772c
    TZ
    52772c
    52772c

    Default time zone representation.

    52772c

    52772c

    This variable is initially set in the configuration process of CentOS

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

    52772c

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

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

    52772c

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

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

    52772c
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    52772c
    52772c

    The format of TZ environment variable is described in

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

    52772c
    52772c
    52772c
    52772c
    06d106
    52772c

    2.75.3 Usage

    52772c
    52772c
    52772c
    centos-art verify --packages
    52772c
    52772c

    Verify required packages your workstation needs in order to run the

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

    52772c

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

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

    52772c
    52772c
    centos-art verify --links
    52772c
    52772c

    Verify required links your workstation needs in order to run the

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

    52772c

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

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

    52772c

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

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

    52772c
    52772c
    centos-art verify --environment
    52772c
    centos-art verify --environment --filter='regex'
    52772c
    52772c

    Output a brief description of environment variables used by

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

    52772c

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

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

    52772c
    06d106
    06d106
    06d106
    52772c
    52772c

    2.75.4 See also

    52772c
    52772c
    1075b9
    2.62 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    52772c
    52772c
    52772c
    52772c
    06d106
    52772c
    [ < ]
    1075b9
    [ > ]
    06d106
       
    1075b9
    [ << ]
    52772c
    [ Up ]
    1075b9
    [ >> ]
    06d106
    06d106

    06d106
     <font size="-1">
    52772c
      This document was generated on March, 22 2011 using texi2html 1.76.
    06d106
     </font>
    06d106
     
    06d106
    06d106

    06d106
    </body>
    06d106
    </html>