Blame Manuals/Filesystem/filesystem-html/filesystem_62.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
-->
010b2d
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>
65cd8a
<title>CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/centos-art/Functions/Verify</title>
ee1f37
65cd8a
<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/centos-art/Functions/Verify">
65cd8a
<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/centos-art/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
010b2d
[ < ]
010b2d
[ > ]
ee1f37
   
db14a4
[ << ]
db14a4
[ Up ]
17d264
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
db14a4
[Top]
db14a4
[Contents]
17d264
[Index]
db14a4
[ ? ]
ee1f37
65cd8a
010b2d
65cd8a

3.59 trunk/Scripts/Bash/centos-art/Functions/Verify

ee1f37
ee1f37
010b2d
ee1f37

3.59.1 Goals

ee1f37
010b2d

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

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

010b2d
010b2d
010b2d

3.59.2 Description

010b2d
010b2d

The first time you download CentOS Artwork Repository you need to

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

010b2d

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

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

010b2d
010b2d
010b2d

3.59.2.1 Packages

010b2d
010b2d

Installation of auxiliar RPM packages provides the software required

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

010b2d
info

Note

Configuration of third party repositories inside CentOS

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

010b2d
010b2d

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

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

010b2d

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

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

010b2d
010b2d
010b2d

3.59.2.2 Links

010b2d
010b2d

Creation of symbolic links helps us to alternate between different

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

010b2d

Creation of symbolic links helps us to reuse components from repository

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

010b2d

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

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

010b2d
010b2d
010b2d

3.59.2.3 Environment variables

010b2d
010b2d

Definition of environemnt variables helps us to set default values to

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

010b2d

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

010b2d
evaluates the following environment variables:
010b2d

010b2d
010b2d
EDITOR
010b2d

Default text editor.

010b2d

010b2d

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

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

010b2d

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

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

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

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

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

    010b2d
    010b2d
    TEXTDOMAIN
    010b2d
    010b2d

    Default domain used to retrieve translated messages. This variable is

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

    010b2d
    010b2d
    TEXTDOMAINDIR
    010b2d
    010b2d

    Default directory used to retrieve translated messages. This variable

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

    010b2d
    010b2d
    LANG
    010b2d
    010b2d

    Default locale information.

    010b2d

    010b2d

    This variable is initially set in the configuration process of CentOS

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

    010b2d

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

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

    010b2d
    010b2d
    TZ
    010b2d
    010b2d

    Default time zone representation.

    010b2d

    010b2d

    This variable is initially set in the configuration process of CentOS

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

    010b2d

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

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

    010b2d

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

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

    010b2d
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    ee1f37
    010b2d

    The format of TZ environment variable is described in

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

    010b2d
    010b2d
    ee1f37
    ee1f37
    010b2d
    ee1f37

    3.59.3 Usage

    ee1f37
    010b2d
    010b2d
    centos-art verify --packages
    010b2d
    010b2d

    Verify required packages your workstation needs in order to run the

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

    010b2d

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

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

    010b2d
    010b2d
    centos-art verify --links
    010b2d
    010b2d

    Verify required links your workstation needs in order to run the

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

    010b2d

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

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

    010b2d

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

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

    010b2d
    010b2d
    centos-art verify --environment
    010b2d
    centos-art verify --environment --filter='regex'
    010b2d
    010b2d

    Output a brief description of environment variables used by

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

    010b2d

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

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

    010b2d
    010b2d
    010b2d
    ee1f37
    010b2d
    ee1f37

    3.59.4 See also

    ee1f37
    010b2d
    010b2d
    3.47 trunk/Scripts/Bash  
    010b2d
    010b2d
    ee1f37
    ee1f37
    ee1f37
    010b2d
    [ < ]
    010b2d
    [ > ]
    ee1f37
       
    db14a4
    [ << ]
    010b2d
    [ Up ]
    17d264
    [ >> ]
    ee1f37
    ee1f37

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

    ee1f37
    </body>
    ee1f37
    </html>