Blame Manual/repository-html/repository_79.html

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

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

06d106
06d106
06d106
06d106

2.75.1 Goals

06d106
06d106

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

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

06d106
06d106
06d106

2.75.2 Description

06d106
06d106

The first time you download CentOS Artwork Repository you need to

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

06d106

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

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

06d106
995423
06d106

2.75.2.1 Packages

06d106
06d106

Installation of auxiliar RPM packages provides the software required

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

06d106
info

Note

Configuration of third party repositories inside CentOS

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

06d106
06d106

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

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

06d106

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

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

06d106
06d106
06d106

2.75.2.2 Links

06d106
06d106

Creation of symbolic links helps us to alternate between different

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

06d106

Creation of symbolic links helps us to reuse components from repository

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

06d106

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

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

06d106
06d106
06d106

2.75.2.3 Environment variables

06d106
06d106

Definition of environemnt variables helps us to set default values to

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

06d106

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

06d106
evaluates the following environment variables:
06d106

06d106
06d106
EDITOR
06d106

Default text editor.

06d106

06d106

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

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

06d106

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

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

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

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

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

    06d106
    06d106
    TEXTDOMAIN
    06d106
    06d106

    Default domain used to retrieve translated messages. This variable is

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

    06d106
    06d106
    TEXTDOMAINDIR
    06d106
    06d106

    Default directory used to retrieve translated messages. This variable

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

    06d106
    06d106
    LANG
    06d106
    06d106

    Default locale information.

    06d106

    06d106

    This variable is initially set in the configuration process of CentOS

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

    06d106

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

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

    06d106
    06d106
    TZ
    06d106
    06d106

    Default time zone representation.

    06d106

    06d106

    This variable is initially set in the configuration process of CentOS

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

    06d106

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

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

    06d106

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

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

    06d106
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    06d106
    06d106

    The format of TZ environment variable is described in

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

    06d106
    06d106
    06d106
    06d106
    06d106
    06d106

    2.75.3 Usage

    06d106
    06d106
    06d106
    centos-art verify --packages
    06d106
    06d106

    Verify required packages your workstation needs in order to run the

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

    06d106

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

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

    06d106
    06d106
    centos-art verify --links
    06d106
    06d106

    Verify required links your workstation needs in order to run the

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

    06d106

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

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

    06d106

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

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

    06d106
    06d106
    centos-art verify --environment
    06d106
    centos-art verify --environment --filter='regex'
    06d106
    06d106

    Output a brief description of environment variables used by

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

    06d106

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

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

    06d106
    06d106
    06d106
    06d106
    06d106
    06d106

    2.75.4 See also

    06d106
    06d106
    06d106
    2.62 The <tt>`trunk/Scripts/Bash'</tt> Directory  
    06d106
    9bfd15
    632e8b
    632e8b
    632e8b
    06d106
    [ < ]
    06d106
    [ > ]
    632e8b
       
    9bfd15
    [ << ]
    06d106
    [ Up ]
    06d106
    [ >> ]
    632e8b
    632e8b

    632e8b
     <font size="-1">
    06d106
      This document was generated on March, 10 2011 using texi2html 1.76.
    632e8b
     </font>
    632e8b
     
    632e8b
    632e8b

    632e8b
    </body>
    632e8b
    </html>