Blame Manuals/en/Html/Repository/repository_48.html

4c79b5
4c79b5
<html>
09d4f2
09d4f2
09d4f2
The CentOS Artwork Repository exists to organize and automate The
09d4f2
CentOS Project corporate visual identity (, to
09d4f2
start on).
4c79b5
6c4982
Copyright C 2009, 2010 Alain Reguera Delgado. All rights
4c79b5
reserved.
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
-->
008ee0
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>
e68a7a
<title>CentOS Artwork Repository: 3.45 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
e68a7a
<meta name="description" content="CentOS Artwork Repository: 3.45 trunk/Scripts/Bash/Functions/Verify">
e68a7a
<meta name="keywords" content="CentOS Artwork Repository: 3.45 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
4c79b5
e68a7a
[ < ]
e68a7a
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
e68a7a
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
e68a7a
[Index]
4c79b5
[ ? ]
4c79b5
e68a7a
e68a7a
e68a7a

3.45 trunk/Scripts/Bash/Functions/Verify

5fb024
4c79b5
e68a7a
6aec21

3.45.1 Goals

4c79b5
e68a7a

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

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

c9b54d
e68a7a
efa7b7

3.45.2 Description

2c8180
e68a7a

The first time you download CentOS Artwork Repository you need to

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

e68a7a

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

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

2c8180
e68a7a
e68a7a

3.45.2.1 Packages

c9b54d
e68a7a

Installation of auxiliar RPM packages provides the software required

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

e68a7a
info

Note

Configuration of third party repositories inside CentOS

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

e68a7a
e68a7a

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

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

e68a7a

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

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

e68a7a
e68a7a
e68a7a

3.45.2.2 Links

e68a7a
e68a7a

Creation of symbolic links helps us to alternate between different

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

e68a7a

Creation of symbolic links helps us to reuse components from repository

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

e68a7a

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

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

e68a7a
e68a7a
e68a7a

3.45.2.3 Environment variables

e68a7a
e68a7a

Definition of environemnt variables helps us to set default values to

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

e68a7a

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

e68a7a
evaluates the following environment variables:
54b5a5

e68a7a
e68a7a
EDITOR
e68a7a

Default text editor.

54b5a5

e68a7a

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

e68a7a
pre-commit subversion messages, translation files, configuration
e68a7a
files, script files, and similar text-based files.
54b5a5

e68a7a

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

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

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

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

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

    63f275
    e68a7a
    TZ
    e68a7a
    e68a7a

    Default time zone representation.

    54b5a5

    e68a7a

    Time representation inside repository server is set to Coordinated

    e68a7a
    Universal Time (UTC).  Time represetation inside repository working
    e68a7a
    copies is set as their administrators personally define.  
    54b5a5

    e68a7a

    When repository working copies time representation be defined, it

    e68a7a
    would be a very good convention to follow if working copies
    e68a7a
    administrators would set their systems clock to use UTC.  Otherwise it
    e68a7a
    would be difficult for working copies users to find out when changes
    e68a7a
    were committed up to repository server exactly in time.
    54b5a5

    e68a7a
    Info

    Tip

    Coordinated Univeral Time (UTC) representation can be

    e68a7a
    configured when you install CentOS distribution; or later, runing the
    e68a7a
    system-config-date command at a shell prompt from your
    e68a7a
    graphical interface.
    e68a7a

    e68a7a
    e68a7a
    info

    Note

    If you set your system clock to use UTC representation,

    e68a7a
    you also need to set the TZ environment variable inside
    e68a7a
    <tt>`~/.bash_profile'</tt> as follows:
    e68a7a

    export TZ=UTC
    e68a7a

    This is required in order for your terminal to display the correct

    e68a7a
    time information of your zone, taking UTC representation as reference.
    e68a7a

    e68a7a
    54b5a5
    e68a7a
    TEXTDOMAIN
    e68a7a
    e68a7a

    Default domain used to retrieve translated messages. This value is

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

    54b5a5
    e68a7a
    TEXTDOMAINDIR
    e68a7a
    e68a7a

    Default directory used to retrieve translated messages. This value is

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

    54b5a5
    e68a7a
    LANG
    e68a7a
    e68a7a

    Default locale information. This value is set when you start your

    e68a7a
    session and can be changed using the <samp>`locale'</samp> functionality of
    e68a7a
    <tt>`centos-art.sh'</tt> script (see section trunk/Scripts/Bash/Functions/Locale, for more information).
    63f275

    54b5a5
    54b5a5
    63f275
    e68a7a
    63f275

    3.45.3 Usage

    63f275
    63f275
    e68a7a
    <samp>`centos-art verify --packages'</samp>
    e68a7a

    Verify required packages your workstation needs in order to run the

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

    e68a7a

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

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

    63f275
    e68a7a
    <samp>`centos-art verify --links'</samp>
    e68a7a

    Verify required links your workstation needs in order to run the

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

    e68a7a

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

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

    e68a7a

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

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

    e68a7a
    e68a7a
    <samp>`centos-art verify --environment'</samp>
    e68a7a
    <samp>`centos-art verify --environment --filter='regex''</samp>
    e68a7a

    Output a brief description of environment variables used by

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

    e68a7a

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

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

    e68a7a
    63f275
    e68a7a
    e68a7a
    300762

    3.45.4 See also

    4c79b5
    2c8180
    63f275
    3.36 trunk/Scripts/Bash  
    54b5a5
    63f275
    3.37 trunk/Scripts/Bash/Functions  
    2c8180
    2c8180
    4c79b5
    4c79b5
    4c79b5
    e68a7a
    [ < ]
    e68a7a
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    e68a7a
    [ Up ]
    e68a7a
    [ >> ]
    4c79b5
    4c79b5

    4c79b5
     <font size="-1">
    008ee0
      This document was generated on December, 2 2010 using texi2html 1.76.
    4c79b5
     </font>
    4c79b5
     
    4c79b5
    4c79b5

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