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

3.47 trunk/Scripts/Bash/Functions/Verify

49b888
49b888
49b888
49b888

3.47.1 Goals

49b888
49b888

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

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

49b888
49b888
49b888

3.47.2 Description

49b888
49b888

The first time you download CentOS Artwork Repository you need to

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

49b888

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

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

49b888
3d6160
49b888

3.47.2.1 Packages

4c79b5
49b888

Installation of auxiliar RPM packages provides the software required

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

49b888
info

Note

Configuration of third party repositories inside CentOS

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

49b888
49b888

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

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

49b888

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

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

4c79b5
3d6160
49b888

3.47.2.2 Links

4c79b5
49b888

Creation of symbolic links helps us to alternate between different

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

49b888

Creation of symbolic links helps us to reuse components from repository

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

49b888

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

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

eae802
3d6160
49b888

3.47.2.3 Environment variables

eae802
49b888

Definition of environemnt variables helps us to set default values to

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

49b888

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

49b888
evaluates the following environment variables:
49b888

49b888
49b888
EDITOR
49b888

Default text editor.

035049

49b888

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

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

49b888

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

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

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

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

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

    49b888
    49b888
    TZ
    49b888
    49b888

    Default time zone representation.

    49b888

    49b888

    Time representation inside repository server is set to Coordinated

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

    49b888

    When repository working copies time representation be defined, it

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

    49b888
    Info

    Tip

    Coordinated Univeral Time (UTC) representation can be

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

    49b888
    49b888
    info

    Note

    If you set your system clock to use UTC representation,

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

    export TZ=UTC
    49b888

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

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

    49b888
    49b888
    49b888
    TEXTDOMAIN
    49b888
    49b888

    Default domain used to retrieve translated messages. This value is

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

    49b888
    49b888
    TEXTDOMAINDIR
    49b888
    49b888

    Default directory used to retrieve translated messages. This value is

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

    49b888
    49b888
    LANG
    49b888
    49b888

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

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

    49b888
    49b888
    54b5a5
    3d6160
    2c8180

    3.47.3 Usage

    6aec21
    49b888
    49b888
    <samp>`centos-art verify --packages'</samp>
    49b888

    Verify required packages your workstation needs in order to run the

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

    49b888

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

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

    49b888
    49b888
    <samp>`centos-art verify --links'</samp>
    49b888

    Verify required links your workstation needs in order to run the

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

    49b888

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

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

    49b888

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

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

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

    Output a brief description of environment variables used by

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

    49b888

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

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

    49b888
    49b888
    6aec21
    3d6160
    4c79b5

    3.47.4 See also

    4c79b5
    035049
    49b888
    3.36 trunk/Scripts/Bash  
    035049
    49b888
    3.37 trunk/Scripts/Bash/Functions  
    035049
    035049
    4c79b5
    4c79b5
    4c79b5
    3d6160
    [ < ]
    3d6160
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    49b888
    [ Up ]
    49b888
    [ >> ]
    4c79b5
    4c79b5

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

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