Blame Identity/Manual/repository-xhtml/repository_2.72.xhtml

728c6d
728c6d
<html>
728c6d
728c6d
organization, and administration of CentOS Artwork Repository.
728c6d
728c6d
Copyright C 2009-2011 Alain Reguera Delgado
728c6d
728c6d
Permission is granted to copy, distribute and/or modify this document
728c6d
under the terms of the GNU Free Documentation License, Version 1.2 or
728c6d
any later version published by the Free Software Foundation; with no
728c6d
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
728c6d
copy of the license is included in the section entitled GNU Free
728c6d
Documentation License.  
728c6d
-->
728c6d
728c6d
728c6d
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
728c6d
            Karl Berry  <karl@freefriends.org>
728c6d
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
728c6d
            and many others.
728c6d
Maintained by: Many creative people <dev@texi2html.cvshome.org>
728c6d
Send bugs and suggestions to <users@texi2html.cvshome.org>
728c6d
728c6d
-->
728c6d
<head>
728c6d
<title>CentOS Artwork Repository: 2.72 The trunk/Scripts/Functions/Verify Directory</title>
728c6d
728c6d
<meta name="description" content="CentOS Artwork Repository: 2.72 The trunk/Scripts/Functions/Verify Directory">
728c6d
<meta name="keywords" content="CentOS Artwork Repository: 2.72 The trunk/Scripts/Functions/Verify Directory">
728c6d
<meta name="resource-type" content="document">
728c6d
<meta name="distribution" content="global">
728c6d
<meta name="Generator" content="texi2html 1.76">
728c6d
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
728c6d
<style type="text/css">
728c6d
728c6d
/* CSS
728c6d
 *
728c6d
 * repository.css -- This file provides visual style for repository
728c6d
 * documentation manual in HTML format, as output by Texi2html
728c6d
 * program.
728c6d
 *
728c6d
 * Copyright (C) 2009-2011 Alain Reguera Delgado
728c6d
 *
728c6d
 * This program is free software; you can redistribute it and/or
728c6d
 * modify it under the terms of the GNU General Public License as
728c6d
 * published by the Free Software Foundation; either version 2 of the
728c6d
 * License, or (at your option) any later version.
728c6d
 * 
728c6d
 * This program is distributed in the hope that it will be useful, but
728c6d
 * WITHOUT ANY WARRANTY; without even the implied warranty of
728c6d
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
728c6d
 * General Public License for more details.
728c6d
 *
728c6d
 * You should have received a copy of the GNU General Public License
728c6d
 * along with this program; if not, write to the Free Software
728c6d
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
728c6d
 * USA.
728c6d
 * ----------------------------------------------------------------------
728c6d
 * $Id$
728c6d
 * ----------------------------------------------------------------------
728c6d
 */
728c6d
728c6d
@import url("/home/centos/artwork/trunk/Identity/Webenv/Css/base.css");
728c6d
@import url("/home/centos/artwork/trunk/Identity/Webenv/Css/base-app.css");
728c6d
728c6d
a.summary-letter {text-decoration: none}
728c6d
pre.display {font-family: serif}
728c6d
pre.format {font-family: serif}
728c6d
pre.menu-comment {font-family: serif}
728c6d
pre.menu-preformatted {font-family: serif}
728c6d
pre.smalldisplay {font-family: serif; font-size: smaller}
728c6d
pre.smallexample {font-size: smaller}
728c6d
pre.smallformat {font-family: serif; font-size: smaller}
728c6d
pre.smalllisp {font-size: smaller}
728c6d
span.sansserif {font-family:sans-serif; font-weight:normal;}
728c6d
ul.toc {list-style: none}
728c6d
-->
728c6d
</style>
728c6d
728c6d
728c6d
</head>
728c6d
728c6d
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
728c6d
728c6d
728c6d
[ < ]
728c6d
[ > ]
728c6d
   
728c6d
[Contents]
728c6d
[Index]
728c6d
[ ? ]
728c6d
728c6d
728c6d
728c6d

2.72 The <tt>`trunk/Scripts/Functions/Verify'</tt> Directory

728c6d
    728c6d
    2.72.1 Goals 
    728c6d
    2.72.2 Description 
    728c6d
      728c6d
      2.72.2.1 Packages 
      728c6d
      2.72.2.2 Links 
      728c6d
      2.72.2.3 Environment variables 
      728c6d
      728c6d
      2.72.3 Usage 
      728c6d
      2.72.4 See also 
      728c6d
      728c6d
      728c6d
      728c6d
      728c6d

      2.72.1 Goals

      728c6d
      728c6d

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

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

      728c6d
      728c6d
      728c6d

      2.72.2 Description

      728c6d
        728c6d
        2.72.2.1 Packages 
        728c6d
        2.72.2.2 Links 
        728c6d
        2.72.2.3 Environment variables 
        728c6d
        728c6d
        728c6d

        The first time you download CentOS Artwork Repository you need to

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

        728c6d

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

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

        728c6d
        728c6d
        728c6d

        2.72.2.1 Packages

        728c6d
        728c6d

        Installation of auxiliar RPM packages provides the software required

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

        728c6d
        info

        Note

        Configuration of third party repositories inside CentOS

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

        728c6d
        728c6d

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

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

        728c6d

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

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

        728c6d
        728c6d
        728c6d

        2.72.2.2 Links

        728c6d
        728c6d

        Creation of symbolic links helps us to alternate between different

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

        728c6d

        Creation of symbolic links helps us to reuse components from repository

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

        728c6d

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

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

        728c6d
        728c6d
        728c6d

        2.72.2.3 Environment variables

        728c6d
        728c6d

        Definition of environemnt variables helps us to set default values to

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

        728c6d

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

        728c6d
        evaluates the following environment variables:
        728c6d

        728c6d
        728c6d
        EDITOR
        728c6d

        Default text editor.

        728c6d

        728c6d

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

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

        728c6d

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

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

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

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

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

          728c6d
          728c6d
          TEXTDOMAIN
          728c6d
          728c6d

          Default domain used to retrieve translated messages. This variable is

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

          728c6d
          728c6d
          TEXTDOMAINDIR
          728c6d
          728c6d

          Default directory used to retrieve translated messages. This variable

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

          728c6d
          728c6d
          LANG
          728c6d
          728c6d

          Default locale information.

          728c6d

          728c6d

          This variable is initially set in the configuration process of CentOS

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

          728c6d

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

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

          728c6d
          728c6d
          TZ
          728c6d
          728c6d

          Default time zone representation.

          728c6d

          728c6d

          This variable is initially set in the configuration process of CentOS

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

          728c6d

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

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

          728c6d

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

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

          728c6d
          Convenction

          Convenction

          In order to keep changes syncronized between

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

          728c6d
          728c6d

          The format of TZ environment variable is described in

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

          728c6d
          728c6d
          728c6d
          728c6d
          728c6d
          728c6d

          2.72.3 Usage

          728c6d
          728c6d
          728c6d
          centos-art verify --packages
          728c6d
          728c6d

          Verify required packages your workstation needs in order to run the

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

          728c6d

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

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

          728c6d
          728c6d
          centos-art verify --links
          728c6d
          728c6d

          Verify required links your workstation needs in order to run the

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

          728c6d

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

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

          728c6d

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

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

          728c6d
          728c6d
          centos-art verify --environment
          728c6d
          centos-art verify --environment --filter='regex'
          728c6d
          728c6d

          Output a brief description of environment variables used by

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

          728c6d

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

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

          728c6d
          728c6d
          728c6d
          728c6d
          728c6d
          728c6d

          2.72.4 See also

          728c6d
          728c6d
          728c6d
          728c6d
          728c6d
          728c6d
          728c6d
          [Contents]
          728c6d
          [Index]
          728c6d
          [ ? ]
          728c6d
          728c6d

          728c6d
           <font size="-1">
          728c6d
            This document was generated on March, 30 2011 using texi2html 1.76.
          728c6d
           </font>
          728c6d
           
          728c6d
          728c6d

          728c6d
          </body>
          728c6d
          </html>