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

3.46 trunk/Scripts/Bash/Functions/Verify

4c79b5
300762
63f275
c9b54d

3.46.1 Goals

6ba043
63f275

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

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

55c2ff
63f275
2c8180

3.46.2 Description

55c2ff
63f275

The first time you download CentOS Artwork Repository you need to

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

63f275

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

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

63f275
63f275
63f275

3.46.2.1 Packages

63f275
63f275

Installation of auxiliar RPM packages provides the software required

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

63f275
info

Note

Configuration of third party repositories inside CentOS

63f275
distribution is described in CentOS wiki, specifically in the
63f275
following URL:
63f275
http://wiki.centos.org/AdditionalResources/Repositories
54b5a5

008ee0
63f275

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

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

63f275

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

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

63f275
63f275
63f275

3.46.2.2 Links

63f275
63f275

Creation of symbolic links helps us to alternate between different

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

63f275

Creation of symbolic links helps us to reuse components from repository

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

63f275

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

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

63f275
63f275
63f275

3.46.2.3 Environment variables

63f275
63f275

Definition of environemnt variables helps us to set default values to

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

63f275

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

63f275
evaluates the following environment variables:
008ee0

63f275
63f275
EDITOR
63f275

Default text editor.

008ee0

63f275

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

63f275
pre-commit subversion messages, translation files, configuration
63f275
files, script files, and similar text-based files.
008ee0

63f275

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

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

63f275
    63f275
  • <tt>`/usr/bin/vim'</tt>
  • 63f275
  • <tt>`/usr/bin/emacs'</tt>
  • 63f275
  • <tt>`/usr/bin/nano'</tt>
  • 63f275
    008ee0
    63f275

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

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

    63f275
    63f275
    TZ
    63f275
    63f275

    Default time zone representation.

    63f275

    63f275

    Time representation inside repository server is set to Coordinated

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

    63f275

    When repository working copies time representation be defined, it

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

    63f275
    Info

    Tip

    Coordinated Univeral Time (UTC) representation can be

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

    55c2ff
    63f275
    info

    Note

    If you set your system clock to use UTC representation,

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

    export TZ=UTC
    63f275

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

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

    081970
    63f275
    63f275
    TEXTDOMAIN
    63f275
    63f275

    Default domain used to retrieve translated messages. This value is

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

    63f275
    63f275
    TEXTDOMAINDIR
    63f275
    63f275

    Default directory used to retrieve translated messages. This value is

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

    63f275
    63f275
    LANG
    63f275
    63f275

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

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

    008ee0
    008ee0
    54b5a5
    63f275
    63f275

    3.46.3 Usage

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

    Verify required packages your workstation needs in order to run the

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

    63f275

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

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

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

    Verify required links your workstation needs in order to run the

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

    63f275

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

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

    63f275

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

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

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

    Output a brief description of environment variables used by

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

    63f275

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

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

    63f275
    081970
    63f275
    63f275
    4c79b5

    3.46.4 See also

    4c79b5
    008ee0
    63f275
    3.36 trunk/Scripts/Bash  
    008ee0
    63f275
    3.37 trunk/Scripts/Bash/Functions  
    008ee0
    008ee0
    4c79b5
    4c79b5
    4c79b5
    63f275
    [ < ]
    63f275
    [ > ]
    4c79b5
       
    4c79b5
    [ << ]
    63f275
    [ Up ]
    63f275
    [ >> ]
    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>