Blame Manual/repository-html/repository_67.html

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

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

063806
063806
f66721
f66721

2.62.1 Goals

063806
f66721

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

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

063806
f66721
f66721

2.62.2 Description

063806
f66721

The first time you download CentOS Artwork Repository you need to

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

f66721

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

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

063806
f66721
f66721

2.62.2.1 Packages

063806
f66721

Installation of auxiliar RPM packages provides the software required

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

f66721
info

Note

Configuration of third party repositories inside CentOS

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

063806
f66721

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

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

f66721

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

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

f66721
f66721
f66721

2.62.2.2 Links

f66721
f66721

Creation of symbolic links helps us to alternate between different

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

f66721

Creation of symbolic links helps us to reuse components from repository

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

f66721

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

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

063806
f66721
f66721

2.62.2.3 Environment variables

f66721
f66721

Definition of environemnt variables helps us to set default values to

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

f66721

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

f66721
evaluates the following environment variables:
f66721

f66721
f66721
EDITOR
f66721

Default text editor.

f66721

f66721

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

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

f66721

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

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

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

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

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

    f66721
    f66721
    TEXTDOMAIN
    f66721
    f66721

    Default domain used to retrieve translated messages. This variable is

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

    f66721
    f66721
    TEXTDOMAINDIR
    f66721
    f66721

    Default directory used to retrieve translated messages. This variable

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

    f66721
    f66721
    LANG
    f66721
    f66721

    Default locale information.

    f66721

    f66721

    This variable is initially set in the configuration process of CentOS

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

    f66721

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

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

    f66721
    f66721
    TZ
    f66721
    f66721

    Default time zone representation.

    f66721

    f66721

    This variable is initially set in the configuration process of CentOS

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

    f66721

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

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

    f66721

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

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

    f66721
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    f66721
    f66721

    The format of TZ environment variable is described in

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

    f66721
    f66721
    f66721
    063806
    f66721
    f66721

    2.62.3 Usage

    063806
    f66721
    f66721
    centos-art verify --packages
    f66721
    f66721

    Verify required packages your workstation needs in order to run the

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

    f66721

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

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

    f66721
    f66721
    centos-art verify --links
    f66721
    f66721

    Verify required links your workstation needs in order to run the

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

    f66721

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

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

    f66721

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

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

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

    Output a brief description of environment variables used by

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

    f66721

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

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

    f66721
    f66721
    063806
    063806
    f66721
    f66721

    2.62.4 See also

    063806
    f66721
    f66721
    2.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    f66721
    f66721
    010b2d
    010b2d
    010b2d
    f66721
    [ < ]
    f66721
    [ > ]
    010b2d
       
    f66721
    [ << ]
    f66721
    [ Up ]
    f66721
    [ >> ]
    010b2d
    010b2d

    010b2d
     <font size="-1">
    a84624
      This document was generated on March, 1 2011 using texi2html 1.76.
    010b2d
     </font>
    010b2d
     
    010b2d
    010b2d

    010b2d
    </body>
    010b2d
    </html>