Blame Manuals/en/Html/Repository/repository_49.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
-->
684dc0
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>
035049
<title>CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
035049
<meta name="description" content="CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify">
035049
<meta name="keywords" content="CentOS Artwork Repository: 3.46 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
035049
[ < ]
035049
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
035049
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
035049
[Index]
4c79b5
[ ? ]
4c79b5
035049
035049
035049

3.46 trunk/Scripts/Bash/Functions/Verify

035049
035049
035049
035049

3.46.1 Goals

035049
035049

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

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

035049
035049
035049

3.46.2 Description

035049
035049

The first time you download CentOS Artwork Repository you need to

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

035049

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

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

035049
cbf5a9
035049

3.46.2.1 Packages

63f275
035049

Installation of auxiliar RPM packages provides the software required

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

035049
info

Note

Configuration of third party repositories inside CentOS

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

035049
035049

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

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

035049

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

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

63f275
cbf5a9
035049

3.46.2.2 Links

63f275
035049

Creation of symbolic links helps us to alternate between different

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

035049

Creation of symbolic links helps us to reuse components from repository

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

035049

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

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

63f275
cbf5a9
035049

3.46.2.3 Environment variables

b0644c
035049

Definition of environemnt variables helps us to set default values to

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

035049

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

035049
evaluates the following environment variables:
035049

035049
035049
EDITOR
035049

Default text editor.

b0644c

035049

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

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

035049

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

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

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

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

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

    035049
    035049
    TZ
    035049
    035049

    Default time zone representation.

    035049

    035049

    Time representation inside repository server is set to Coordinated

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

    035049

    When repository working copies time representation be defined, it

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

    035049
    Info

    Tip

    Coordinated Univeral Time (UTC) representation can be

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

    035049
    035049
    info

    Note

    If you set your system clock to use UTC representation,

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

    export TZ=UTC
    035049

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

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

    035049
    035049
    035049
    TEXTDOMAIN
    035049
    035049

    Default domain used to retrieve translated messages. This value is

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

    035049
    035049
    TEXTDOMAINDIR
    035049
    035049

    Default directory used to retrieve translated messages. This value is

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

    035049
    035049
    LANG
    035049
    035049

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

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

    035049
    035049
    54b5a5
    cbf5a9
    273af8

    3.46.3 Usage

    273af8
    035049
    035049
    <samp>`centos-art verify --packages'</samp>
    035049

    Verify required packages your workstation needs in order to run the

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

    035049

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

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

    035049
    035049
    <samp>`centos-art verify --links'</samp>
    035049

    Verify required links your workstation needs in order to run the

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

    035049

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

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

    035049

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

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

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

    Output a brief description of environment variables used by

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

    035049

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

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

    035049
    035049
    273af8
    3d6160
    4c79b5

    3.46.4 See also

    4c79b5
    008ee0
    035049
    3.36 trunk/Scripts/Bash  
    3d6160
    035049
    3.37 trunk/Scripts/Bash/Functions  
    e37211
    008ee0
    4c79b5
    4c79b5
    4c79b5
    3d6160
    [ < ]
    3d6160
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    035049
    [ Up ]
    035049
    [ >> ]
    4c79b5
    4c79b5

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

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