Blame Manual/repository-html/repository_66.html

010b2d
010b2d
<html>
010b2d
010b2d
010b2d
Permission is granted to copy, distribute and/or modify this document
010b2d
under the terms of the GNU Free Documentation License, Version 1.2 or
010b2d
any later version published by the Free Software Foundation; with no
010b2d
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
010b2d
copy of the license is included in the section entitled GNU Free
010b2d
Documentation License.  
010b2d
-->
982d5c
010b2d
010b2d
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
010b2d
            Karl Berry  <karl@freefriends.org>
010b2d
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
010b2d
            and many others.
010b2d
Maintained by: Many creative people <dev@texi2html.cvshome.org>
010b2d
Send bugs and suggestions to <users@texi2html.cvshome.org>
010b2d
010b2d
-->
010b2d
<head>
063806
<title>CentOS Artwork Repository: 2.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory</title>
010b2d
063806
<meta name="description" content="CentOS Artwork Repository: 2.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory">
063806
<meta name="keywords" content="CentOS Artwork Repository: 2.62 The trunk/Scripts/Bash/Cli/Functions/Verify Directory">
010b2d
<meta name="resource-type" content="document">
010b2d
<meta name="distribution" content="global">
010b2d
<meta name="Generator" content="texi2html 1.76">
010b2d
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
010b2d
<style type="text/css">
010b2d
010b2d
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";
010b2d
010b2d
a.summary-letter {text-decoration: none}
010b2d
pre.display {font-family: serif}
010b2d
pre.format {font-family: serif}
010b2d
pre.menu-comment {font-family: serif}
010b2d
pre.menu-preformatted {font-family: serif}
010b2d
pre.smalldisplay {font-family: serif; font-size: smaller}
010b2d
pre.smallexample {font-size: smaller}
010b2d
pre.smallformat {font-family: serif; font-size: smaller}
010b2d
pre.smalllisp {font-size: smaller}
010b2d
span.sansserif {font-family:sans-serif; font-weight:normal;}
010b2d
ul.toc {list-style: none}
010b2d
-->
010b2d
</style>
010b2d
010b2d
010b2d
</head>
010b2d
010b2d
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
010b2d
010b2d
063806
[ < ]
063806
[ > ]
010b2d
   
063806
[ << ]
063806
[ Up ]
063806
[ >> ]
010b2d
   
010b2d
   
010b2d
   
010b2d
   
982d5c
[Top]
982d5c
[Contents]
063806
[Index]
982d5c
[ ? ]
010b2d
063806
063806
063806

2.62 The <tt>`trunk/Scripts/Bash/Cli/Functions/Verify'</tt> Directory

063806
063806
063806
063806

2.62.1 Goals

063806
063806

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

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

063806
063806
063806

2.62.2 Description

063806
063806

The first time you download CentOS Artwork Repository you need to

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

063806

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

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

063806
063806
063806

2.62.2.1 Packages

063806
063806

Installation of auxiliar RPM packages provides the software required

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

063806
info

Note

Configuration of third party repositories inside CentOS

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

063806
063806

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

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

063806

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

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

063806
063806
063806

2.62.2.2 Links

063806
063806

Creation of symbolic links helps us to alternate between different

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

063806

Creation of symbolic links helps us to reuse components from repository

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

063806

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

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

063806
063806
063806

2.62.2.3 Environment variables

063806
063806

Definition of environemnt variables helps us to set default values to

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

063806

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

063806
evaluates the following environment variables:
063806

063806
063806
EDITOR
063806

Default text editor.

063806

063806

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

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

063806

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

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

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

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

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

    063806
    063806
    TEXTDOMAIN
    063806
    063806

    Default domain used to retrieve translated messages. This variable is

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

    063806
    063806
    TEXTDOMAINDIR
    063806
    063806

    Default directory used to retrieve translated messages. This variable

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

    063806
    063806
    LANG
    063806
    063806

    Default locale information.

    063806

    063806

    This variable is initially set in the configuration process of CentOS

    063806
    distribution installer (i.e., Anaconda), specifically in the
    063806
    <samp>`Language'</samp> step; or once installed using the
    063806
    system-config-language tool.
    063806

    063806

    The <tt>`centos-art.sh'</tt> script uses the LANG environment

    063806
    variable to know in which language the script messages are printed
    063806
    out.
    063806

    063806
    063806
    TZ
    063806
    063806

    Default time zone representation.

    063806

    063806

    This variable is initially set in the configuration process of CentOS

    063806
    distribution installer (i.e., Anaconda), specifically in the
    063806
    <samp>`Date and time'</samp> step; or once installed using the
    063806
    system-config-date tool.
    063806

    063806

    The <tt>`centos-art.sh'</tt> script doesn't use the TZ environment

    063806
    variable information at all. Instead, this variable is used by the
    063806
    system shell to show the time information according to your phisical
    063806
    location on planet Earth.  
    063806

    063806

    Inside your computer, the time information is firstly set in the BIOS

    063806
    clock (which may need correction), and later in the configuration
    063806
    process of CentOS distribution installer (or later, by any of the
    063806
    related configuration tools inside CentOS distribution).  Generally,
    063806
    setting time information is a straight-forward task and configuration
    063806
    tools available do cover most relevant location. However, if you need
    063806
    a time precision not provided by the configuration tools available
    063806
    inside CentOS distribution then, using TZ variable may be
    063806
    necessary.
    063806

    063806
    Convenction

    Convenction

    In order to keep changes syncronized between

    063806
    central repository and its working copies: configure both repository
    063806
    server and workstations (i.e., the place where each working copy is
    063806
    set on) to use Coordinated Universal Time (UTC) as base time
    063806
    representation.  Later, correct the time information for your specific
    063806
    location using time zone correction.
    063806

    063806
    063806

    The format of TZ environment variable is described in

    063806
    <tt>`tzset(3)'</tt> manual page.
    063806

    063806
    063806
    063806
    063806
    063806
    063806

    2.62.3 Usage

    063806
    063806
    063806
    centos-art verify --packages
    063806
    063806

    Verify required packages your workstation needs in order to run the

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

    063806

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

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

    063806
    063806
    centos-art verify --links
    063806
    063806

    Verify required links your workstation needs in order to run the

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

    063806

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

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

    063806

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

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

    063806
    063806
    centos-art verify --environment
    063806
    centos-art verify --environment --filter='regex'
    063806
    063806

    Output a brief description of environment variables used by

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

    063806

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

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

    063806
    063806
    063806
    063806
    063806
    063806

    2.62.4 See also

    063806
    063806
    063806
    2.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    063806
    982d5c
    982d5c
    010b2d
    010b2d
    063806
    [ < ]
    063806
    [ > ]
    010b2d
       
    063806
    [ << ]
    063806
    [ Up ]
    063806
    [ >> ]
    010b2d
    010b2d

    010b2d
     <font size="-1">
    982d5c
      This document was generated on March, 1 2011 using texi2html 1.76.
    010b2d
     </font>
    010b2d
     
    010b2d
    010b2d

    010b2d
    </body>
    010b2d
    </html>