Blame Manuals/Filesystem/filesystem-html/filesystem_60.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
-->
ee1f37
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>
db14a4
<title>CentOS Artwork Repository: 3.57 trunk/Scripts/Bash/Functions/Verify</title>
ee1f37
db14a4
<meta name="description" content="CentOS Artwork Repository: 3.57 trunk/Scripts/Bash/Functions/Verify">
db14a4
<meta name="keywords" content="CentOS Artwork Repository: 3.57 trunk/Scripts/Bash/Functions/Verify">
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
db14a4
[ < ]
ee1f37
[ > ]
ee1f37
   
db14a4
[ << ]
db14a4
[ Up ]
db14a4
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
db14a4
[Top]
db14a4
[Contents]
db14a4
[Index]
db14a4
[ ? ]
ee1f37
ee1f37
ee1f37
ee1f37

3.57 trunk/Scripts/Bash/Functions/Verify

ee1f37
ee1f37
ee1f37
ee1f37

3.57.1 Goals

ee1f37
ee1f37

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

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

ee1f37
ee1f37
ee1f37

3.57.2 Description

ee1f37
ee1f37

The first time you download CentOS Artwork Repository you need to

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

ee1f37

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

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

ee1f37
ee1f37
ee1f37

3.57.2.1 Packages

ee1f37
ee1f37

Installation of auxiliar RPM packages provides the software required

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

ee1f37
info

Note

Configuration of third party repositories inside CentOS

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

ee1f37
ee1f37

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

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

ee1f37

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

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

ee1f37
ee1f37
ee1f37

3.57.2.2 Links

ee1f37
ee1f37

Creation of symbolic links helps us to alternate between different

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

ee1f37

Creation of symbolic links helps us to reuse components from repository

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

ee1f37

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

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

ee1f37
ee1f37
ee1f37

3.57.2.3 Environment variables

ee1f37
ee1f37

Definition of environemnt variables helps us to set default values to

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

ee1f37

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

ee1f37
evaluates the following environment variables:
ee1f37

ee1f37
ee1f37
EDITOR
ee1f37

Default text editor.

ee1f37

ee1f37

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

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

ee1f37

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

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

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

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

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

    ee1f37
    ee1f37
    TEXTDOMAIN
    ee1f37
    ee1f37

    Default domain used to retrieve translated messages. This variable is

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

    ee1f37
    ee1f37
    TEXTDOMAINDIR
    ee1f37
    ee1f37

    Default directory used to retrieve translated messages. This variable

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

    ee1f37
    ee1f37
    LANG
    ee1f37
    ee1f37

    Default locale information.

    ee1f37

    ee1f37

    This variable is initially set in the configuration process of CentOS

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

    ee1f37

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

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

    ee1f37
    ee1f37
    TZ
    ee1f37
    ee1f37

    Default time zone representation.

    ee1f37

    ee1f37

    This variable is initially set in the configuration process of CentOS

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

    ee1f37

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

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

    ee1f37

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

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

    ee1f37
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    ee1f37
    ee1f37

    The format of TZ environment variable is described in

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

    ee1f37
    ee1f37
    ee1f37
    ee1f37
    ee1f37
    ee1f37

    3.57.3 Usage

    ee1f37
    ee1f37
    ee1f37
    centos-art verify --packages
    ee1f37
    ee1f37

    Verify required packages your workstation needs in order to run the

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

    ee1f37

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

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

    ee1f37
    ee1f37
    centos-art verify --links
    ee1f37
    ee1f37

    Verify required links your workstation needs in order to run the

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

    ee1f37

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

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

    ee1f37

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

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

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

    Output a brief description of environment variables used by

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

    ee1f37

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

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

    ee1f37
    ee1f37
    ee1f37
    ee1f37
    ee1f37
    ee1f37

    3.57.4 See also

    ee1f37
    ee1f37
    db14a4
    3.47 trunk/Scripts/Bash  
    ee1f37
    db14a4
    3.48 trunk/Scripts/Bash/Functions  
    ee1f37
    ee1f37
    ee1f37
    ee1f37
    ee1f37
    ee1f37
    [ < ]
    db14a4
    [ > ]
    ee1f37
       
    db14a4
    [ << ]
    ee1f37
    [ Up ]
    db14a4
    [ >> ]
    ee1f37
    ee1f37

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

    ee1f37
    </body>
    ee1f37
    </html>