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

3.46 trunk/Scripts/Bash/Functions/Verify

63f275
63f275
cbf5a9
e68a7a

3.46.1 Goals

63f275
273af8

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

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

63f275
cbf5a9
e68a7a

3.46.2 Description

081970
273af8

The first time you download CentOS Artwork Repository you need to

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

273af8

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

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

54b5a5
cbf5a9
273af8

3.46.2.1 Packages

831389
273af8

Installation of auxiliar RPM packages provides the software required

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

273af8
info

Note

Configuration of third party repositories inside CentOS

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

273af8
273af8

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

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

273af8

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

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

831389
60c152
273af8

3.46.2.2 Links

273af8
273af8

Creation of symbolic links helps us to alternate between different

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

273af8

Creation of symbolic links helps us to reuse components from repository

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

273af8

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

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

273af8
273af8
273af8

3.46.2.3 Environment variables

273af8
273af8

Definition of environemnt variables helps us to set default values to

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

273af8

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

273af8
evaluates the following environment variables:
273af8

273af8
273af8
EDITOR
273af8

Default text editor.

273af8

273af8

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

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

273af8

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

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

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

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

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

    273af8
    273af8
    TZ
    273af8
    273af8

    Default time zone representation.

    273af8

    273af8

    Time representation inside repository server is set to Coordinated

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

    273af8

    When repository working copies time representation be defined, it

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

    273af8
    Info

    Tip

    Coordinated Univeral Time (UTC) representation can be

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

    273af8
    273af8
    info

    Note

    If you set your system clock to use UTC representation,

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

    export TZ=UTC
    273af8

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

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

    273af8
    273af8
    273af8
    TEXTDOMAIN
    273af8
    273af8

    Default domain used to retrieve translated messages. This value is

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

    273af8
    273af8
    TEXTDOMAINDIR
    273af8
    273af8

    Default directory used to retrieve translated messages. This value is

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

    273af8
    273af8
    LANG
    273af8
    273af8

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

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

    273af8
    273af8
    273af8
    273af8
    273af8

    3.46.3 Usage

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

    Verify required packages your workstation needs in order to run the

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

    273af8

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

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

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

    Verify required links your workstation needs in order to run the

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

    273af8

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

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

    273af8

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

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

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

    Output a brief description of environment variables used by

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

    273af8

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

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

    273af8
    273af8
    273af8
    273af8
    4c79b5

    3.46.4 See also

    4c79b5
    008ee0
    273af8
    3.36 trunk/Scripts/Bash  
    e68a7a
    273af8
    3.37 trunk/Scripts/Bash/Functions  
    60c152
    008ee0
    4c79b5
    4c79b5
    4c79b5
    273af8
    [ < ]
    273af8
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    e68a7a
    [ Up ]
    273af8
    [ >> ]
    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>