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
-->
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>
749e81
<title>CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify</title>
4c79b5
749e81
<meta name="description" content="CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify">
749e81
<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
749e81
[ < ]
749e81
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
749e81
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
749e81
[Index]
4c79b5
[ ? ]
4c79b5
749e81
749e81
749e81

3.46 trunk/Scripts/Bash/Functions/Verify

035049
035049
749e81
035049

3.46.1 Goals

035049
749e81

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

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

035049
749e81
035049

3.46.2 Description

035049
749e81

The first time you download CentOS Artwork Repository you need to

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

749e81

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

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

035049
749e81
749e81

3.46.2.1 Packages

63f275
749e81

Installation of auxiliar RPM packages provides the software required

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

749e81
info

Note

Configuration of third party repositories inside CentOS

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

749e81
749e81

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

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

749e81

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

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

749e81
749e81
749e81

3.46.2.2 Links

749e81
749e81

Creation of symbolic links helps us to alternate between different

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

749e81

Creation of symbolic links helps us to reuse components from repository

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

749e81

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

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

749e81
749e81
749e81

3.46.2.3 Environment variables

749e81
749e81

Definition of environemnt variables helps us to set default values to

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

749e81

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

749e81
evaluates the following environment variables:
035049

749e81
749e81
EDITOR
749e81

Default text editor.

b0644c

749e81

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

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

749e81

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

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

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

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

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

    035049
    749e81
    TZ
    749e81
    749e81

    Default time zone representation.

    035049

    749e81

    Time representation inside repository server is set to Coordinated

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

    749e81

    When repository working copies time representation be defined, it

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

    749e81
    Info

    Tip

    Coordinated Univeral Time (UTC) representation can be

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

    749e81
    749e81
    info

    Note

    If you set your system clock to use UTC representation,

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

    export TZ=UTC
    749e81

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

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

    749e81
    035049
    749e81
    TEXTDOMAIN
    749e81
    749e81

    Default domain used to retrieve translated messages. This value is

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

    035049
    749e81
    TEXTDOMAINDIR
    749e81
    749e81

    Default directory used to retrieve translated messages. This value is

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

    035049
    749e81
    LANG
    749e81
    749e81

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

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

    035049
    035049
    0d952c
    749e81
    0d952c

    3.46.3 Usage

    0d952c
    0d952c
    749e81
    <samp>`centos-art verify --packages'</samp>
    749e81

    Verify required packages your workstation needs in order to run the

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

    749e81

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

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

    c6292c
    749e81
    <samp>`centos-art verify --links'</samp>
    749e81

    Verify required links your workstation needs in order to run the

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

    749e81

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

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

    749e81

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

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

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

    Output a brief description of environment variables used by

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

    749e81

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

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

    749e81
    c6292c
    749e81
    749e81
    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
    749e81
    [ < ]
    749e81
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    749e81
    [ Up ]
    749e81
    [ >> ]
    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>