Blame Manual/repository-html/repository_63.html

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

2.61 Filesystem/trunk/Scripts/Bash/Cli/Functions/Verify

982d5c
982d5c
982d5c
982d5c

2.61.1 Goals

982d5c
982d5c

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

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

982d5c
982d5c
982d5c

2.61.2 Description

982d5c
982d5c

The first time you download CentOS Artwork Repository you need to

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

982d5c

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

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

982d5c
010b2d
982d5c

2.61.2.1 Packages

ee1f37
982d5c

Installation of auxiliar RPM packages provides the software required

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

982d5c
info

Note

Configuration of third party repositories inside CentOS

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

ee1f37
982d5c

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

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

982d5c

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

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

7ba52f
982d5c
982d5c

2.61.2.2 Links

7ba52f
982d5c

Creation of symbolic links helps us to alternate between different

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

982d5c

Creation of symbolic links helps us to reuse components from repository

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

982d5c

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

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

7ba52f
7ba52f
982d5c

2.61.2.3 Environment variables

7ba52f
982d5c

Definition of environemnt variables helps us to set default values to

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

982d5c

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

982d5c
evaluates the following environment variables:
982d5c

982d5c
982d5c
EDITOR
982d5c

Default text editor.

982d5c

982d5c

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

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

982d5c

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

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

7ba52f
    982d5c
  • <tt>`/usr/bin/vim'</tt>
  • 982d5c
  • <tt>`/usr/bin/emacs'</tt>
  • 982d5c
  • <tt>`/usr/bin/nano'</tt>
  • 7ba52f
    7ba52f
    982d5c

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

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

    982d5c
    982d5c
    TEXTDOMAIN
    982d5c
    982d5c

    Default domain used to retrieve translated messages. This variable is

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

    982d5c
    982d5c
    TEXTDOMAINDIR
    982d5c
    982d5c

    Default directory used to retrieve translated messages. This variable

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

    982d5c
    982d5c
    LANG
    982d5c
    982d5c

    Default locale information.

    982d5c

    982d5c

    This variable is initially set in the configuration process of CentOS

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

    982d5c

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

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

    982d5c
    982d5c
    TZ
    982d5c
    982d5c

    Default time zone representation.

    982d5c

    982d5c

    This variable is initially set in the configuration process of CentOS

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

    982d5c

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

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

    982d5c

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

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

    982d5c
    Convenction

    Convenction

    In order to keep changes syncronized between

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

    7ba52f
    982d5c

    The format of TZ environment variable is described in

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

    982d5c
    982d5c
    7ba52f
    7ba52f
    982d5c
    982d5c

    2.61.3 Usage

    7ba52f
    982d5c
    982d5c
    centos-art verify --packages
    982d5c
    982d5c

    Verify required packages your workstation needs in order to run the

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

    982d5c

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

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

    982d5c
    982d5c
    centos-art verify --links
    982d5c
    982d5c

    Verify required links your workstation needs in order to run the

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

    982d5c

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

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

    982d5c

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

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

    982d5c
    982d5c
    centos-art verify --environment
    982d5c
    centos-art verify --environment --filter='regex'
    982d5c
    982d5c

    Output a brief description of environment variables used by

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

    982d5c

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

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

    982d5c
    982d5c
    7ba52f
    ee1f37
    982d5c
    982d5c

    2.61.4 See also

    193ea4
    982d5c
    5cb5a7
    2.49 Filesystem/trunk/Scripts/Bash  
    982d5c
    982d5c
    193ea4
    193ea4
    ee1f37
    7ba52f
    [ < ]
    56a476
    [ > ]
    ee1f37
       
    982d5c
    [ << ]
    982d5c
    [ Up ]
    5cb5a7
    [ >> ]
    ee1f37
    ee1f37

    ee1f37
     <font size="-1">
    406f69
      This document was generated on March, 1 2011 using texi2html 1.76.
    ee1f37
     </font>
    ee1f37
     
    ee1f37
    ee1f37

    ee1f37
    </body>
    ee1f37
    </html>