Blame Manuals/Repository-fs/repository-fs-html/repository_60.html

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

3.57 trunk/Scripts/Bash/Functions/Verify

4a9d2a
4a9d2a
1023f4
4a9d2a

3.57.1 Goals

4a9d2a
1023f4

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

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

4a9d2a
1023f4
4a9d2a

3.57.2 Description

4a9d2a
1023f4

The first time you download CentOS Artwork Repository you need to

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

1023f4

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

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

70ef27
1023f4
1023f4

3.57.2.1 Packages

2c3589
1023f4

Installation of auxiliar RPM packages provides the software required

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

1023f4
info

Note

Configuration of third party repositories inside CentOS

1023f4
distribution is described in CentOS wiki, specifically in the
1023f4
following URL:
1023f4
http://wiki.centos.org/AdditionalResources/Repositories
70ef27

42563b
1023f4

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

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

1023f4

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

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

42563b
1023f4
1023f4

3.57.2.2 Links

2c3589
1023f4

Creation of symbolic links helps us to alternate between different

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

1023f4

Creation of symbolic links helps us to reuse components from repository

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

1023f4

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

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

1023f4
1023f4
1023f4

3.57.2.3 Environment variables

1023f4
1023f4

Definition of environemnt variables helps us to set default values to

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

1023f4

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

1023f4
evaluates the following environment variables:
1023f4

2c3589
1023f4
EDITOR
1023f4

Default text editor.

1023f4

1023f4

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

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

1023f4

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

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

1023f4
    1023f4
  • <tt>`/usr/bin/vim'</tt>
  • 1023f4
  • <tt>`/usr/bin/emacs'</tt>
  • 1023f4
  • <tt>`/usr/bin/nano'</tt>
  • 1023f4
    2c3589
    1023f4

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

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

    1023f4
    1023f4
    TEXTDOMAIN
    1023f4
    1023f4

    Default domain used to retrieve translated messages. This variable is

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

    1023f4
    1023f4
    TEXTDOMAINDIR
    1023f4
    1023f4

    Default directory used to retrieve translated messages. This variable

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

    1023f4
    1023f4
    LANG
    1023f4
    1023f4

    Default locale information.

    1023f4

    1023f4

    This variable is initially set in the configuration process of CentOS

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

    1023f4

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

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

    1023f4
    1023f4
    TZ
    1023f4
    1023f4

    Default time zone representation.

    1023f4

    1023f4

    This variable is initially set in the configuration process of CentOS

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

    1023f4

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

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

    1023f4

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

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

    1023f4
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    42563b
    1023f4

    The format of TZ environment variable is described in

    1023f4
    <tt>`tzset(3)'</tt> manual page.
    42563b

    1023f4
    1023f4
    2c3589
    1023f4
    1023f4
    1023f4

    3.57.3 Usage

    1023f4
    1023f4
    1023f4
    centos-art verify --packages
    1023f4
    1023f4

    Verify required packages your workstation needs in order to run the

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

    1023f4

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

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

    1023f4
    1023f4
    centos-art verify --links
    1023f4
    1023f4

    Verify required links your workstation needs in order to run the

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

    1023f4

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

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

    1023f4

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

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

    1023f4
    1023f4
    centos-art verify --environment
    1023f4
    centos-art verify --environment --filter='regex'
    1023f4
    1023f4

    Output a brief description of environment variables used by

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

    1023f4

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

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

    1023f4
    1023f4
    1023f4
    1023f4
    1023f4
    38bcd9

    3.57.4 See also

    38bcd9
    4a9d2a
    1023f4
    3.47 trunk/Scripts/Bash  
    4a9d2a
    1023f4
    3.48 trunk/Scripts/Bash/Functions  
    4a9d2a
    4a9d2a
    008ee0
    6aec21
    300762
    1023f4
    [ < ]
    1023f4
    [ > ]
    300762
       
    300762
    [ << ]
    1023f4
    [ Up ]
    1023f4
    [ >> ]
    300762
    4c79b5

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

    4c79b5
    </body>
    4c79b5
    </html>