Blame Manual/repository-html/repository_77.html

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

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

632e8b
632e8b
995423
632e8b

2.73.1 Goals

632e8b
9bfd15

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

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

632e8b
995423
632e8b

2.73.2 Description

632e8b
9bfd15

The first time you download CentOS Artwork Repository you need to

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

9bfd15

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

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

632e8b
995423
9bfd15

2.73.2.1 Packages

632e8b
9bfd15

Installation of auxiliar RPM packages provides the software required

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

9bfd15
info

Note

Configuration of third party repositories inside CentOS

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

632e8b
9bfd15

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

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

9bfd15

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

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

9bfd15
995423
9bfd15

2.73.2.2 Links

9bfd15
9bfd15

Creation of symbolic links helps us to alternate between different

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

9bfd15

Creation of symbolic links helps us to reuse components from repository

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

9bfd15

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

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

9bfd15
995423
9bfd15

2.73.2.3 Environment variables

9bfd15
9bfd15

Definition of environemnt variables helps us to set default values to

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

9bfd15

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

9bfd15
evaluates the following environment variables:
9bfd15

9bfd15
9bfd15
EDITOR
9bfd15

Default text editor.

9bfd15

9bfd15

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

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

9bfd15

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

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

632e8b
    9bfd15
  • <tt>`/usr/bin/vim'</tt>
  • 9bfd15
  • <tt>`/usr/bin/emacs'</tt>
  • 9bfd15
  • <tt>`/usr/bin/nano'</tt>
  • 632e8b
    632e8b
    9bfd15

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

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

    9bfd15
    9bfd15
    TEXTDOMAIN
    9bfd15
    9bfd15

    Default domain used to retrieve translated messages. This variable is

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

    9bfd15
    9bfd15
    TEXTDOMAINDIR
    9bfd15
    9bfd15

    Default directory used to retrieve translated messages. This variable

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

    9bfd15
    9bfd15
    LANG
    9bfd15
    9bfd15

    Default locale information.

    9bfd15

    9bfd15

    This variable is initially set in the configuration process of CentOS

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

    9bfd15

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

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

    9bfd15
    9bfd15
    TZ
    9bfd15
    9bfd15

    Default time zone representation.

    9bfd15

    9bfd15

    This variable is initially set in the configuration process of CentOS

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

    9bfd15

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

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

    9bfd15

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

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

    9bfd15
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    632e8b
    9bfd15

    The format of TZ environment variable is described in

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

    9bfd15
    9bfd15
    9bfd15
    9bfd15
    995423
    9bfd15

    2.73.3 Usage

    632e8b
    9bfd15
    9bfd15
    centos-art verify --packages
    9bfd15
    9bfd15

    Verify required packages your workstation needs in order to run the

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

    9bfd15

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

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

    9bfd15
    9bfd15
    centos-art verify --links
    9bfd15
    9bfd15

    Verify required links your workstation needs in order to run the

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

    9bfd15

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

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

    9bfd15

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

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

    9bfd15
    9bfd15
    centos-art verify --environment
    9bfd15
    centos-art verify --environment --filter='regex'
    9bfd15
    9bfd15

    Output a brief description of environment variables used by

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

    9bfd15

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

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

    9bfd15
    9bfd15
    632e8b
    632e8b
    995423
    9bfd15

    2.73.4 See also

    632e8b
    9bfd15
    995423
    2.61 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    9bfd15
    9bfd15
    632e8b
    632e8b
    632e8b
    995423
    [ < ]
    995423
    [ > ]
    632e8b
       
    632e8b
    [ << ]
    995423
    [ Up ]
    995423
    [ >> ]
    632e8b
    632e8b

    632e8b
     <font size="-1">
    995423
      This document was generated on March, 9 2011 using texi2html 1.76.
    632e8b
     </font>
    632e8b
     
    632e8b
    632e8b

    632e8b
    </body>
    632e8b
    </html>