Tree - centos/artwork-archive - CentOS Git server

centos / artwork-archive

Files

Commit: be6bef07debeb0fefb0172ab4833002aaeec401d
Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!--This manual describes what the CentOS Artwork Repository is and what
can you do inside it.

Copyright C 2009, 2010 Alain Reguera Delgado. All rights
reserved.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled GNU Free
Documentation License.  
-->
<!-- Created on November, 3 2010 by texi2html 1.76 -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
            Karl Berry  <karl@freefriends.org>
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
            and many others.
Maintained by: Many creative people <dev@texi2html.cvshome.org>
Send bugs and suggestions to <users@texi2html.cvshome.org>

-->
<head>
<title>CentOS Artwork Repository: 3.35 trunk/Scripts/Bash/Functions</title>

<meta name="description" content="CentOS Artwork Repository: 3.35 trunk/Scripts/Bash/Functions">
<meta name="keywords" content="CentOS Artwork Repository: 3.35 trunk/Scripts/Bash/Functions">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.76">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<style type="text/css">
<!--
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";

a.summary-letter {text-decoration: none}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">

<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="repository_37.html#SEC199" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC201" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="repository_3.html#SEC3" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="repository_3.html#SEC3" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="repository_62.html#SEC342" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="repository.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="repository_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="repository_62.html#SEC342" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="repository_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="trunk-Scripts-Bash-Functions"></a>
<a name="SEC200"></a>
<h2 class="section"> 3.35 trunk/Scripts/Bash/Functions </h2>


<a name="SEC201"></a>
<h3 class="subsection"> 3.35.1 Goals </h3>

<p>The <tt>`trunk/Scripts/Bash/Functions'</tt> directory exists to organize
<tt>`centos-art.sh'</tt> specific functionalities.
</p>

<a name="SEC202"></a>
<h3 class="subsection"> 3.35.2 Description </h3>

<p>The specific functions of <tt>`centos-art.sh'</tt> script are designed
with &quot;Software Toolbox&quot; philosophy (see <a href="../coreutils/Toolbox-introduction.html#Toolbox-introduction">(coreutils.info)Toolbox introduction</a>) in mind: each program &quot;should do one
thing well&quot;.  Inside <tt>`centos-art.sh'</tt> script, each specific
functionality is considered a program that should do one thing well.
Of course, if you find that they still don't do it, feel free to
improve them in order for them to do so.
</p>
<p>The specific functions of <tt>`centos-art.sh'</tt> script are organized
inside specific directories under <tt>`trunk/Scripts/Bash/Functions'</tt>
location. Each specific function directory should be named as the
function it represents, with the first letter in uppercase. For
example, if the function name is <samp>`render'</samp>, the specific function
directory for it would be <samp>`trunk/Scripts/Bash/Functions/Render'</samp>.
</p>
<p>To better understand how specific functions of <tt>`centos-art.sh'</tt>
script are designed, lets create one function which only goal is to
output different kind of greetings to your screen.
</p>
<p>When creating specific functions for <tt>`centos-art.sh'</tt> script it is
crucial to know what these function will do exactly and if there is
any function that already does what we intend to do. If there is no
one, it is good time to create them then. Otherwise, if
functionalities already available don't do what you exactly expect,
contact their authors and work together to improve them.
</p>
<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-idea.png" alt="Info"><h3>Tip</h3><p> Join CentOS developers mailing list
(<a href="mailto:centos-devel@centos.org">centos-devel@centos.org</a>) to share your ideas.
</p></blockquote>

<p>It is also worth to know what global functions we have available, so
advantage can be taken from them. Global functions are stored
immediatly under <tt>`trunk/Scripts/Bash/Functions'</tt> directory in
files begining with <samp>`cli'</samp> prefix.
</p>
<p>OK, let's begin with our specific functionality example.
</p>
<p>What function name do we use? Well, lets use <code>greet</code>. Note that
<samp>`hello'</samp> is not a verb, but an expression, a kind of greeting, an
interjection specifically. In contrast, <code>greet</code> is a verb and
describes what we do when we say <samp>`Hello!'</samp>, <samp>`Hi!'</samp>, and so on.
</p>
<p>So far, we've gathered the following function information:
</p>
<pre class="verbatim">Name: greet
Path: trunk/Scripts/Bash/Functions/Greet
File: trunk/Scripts/Bash/Functions/Greet/greet.sh
</pre>
<blockquote class="blue"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-info.png" alt="info"><h3>Note</h3><p> Note how function name is used as reference to define
function path, function script, and function definition inside
function script.
</p></blockquote>

<p>As consistency convenction, files related to <code>greet</code>
functionality are stored under its own function path. The
<tt>`greet.sh'</tt> function script is the first file <tt>`centos-art.sh'</tt>
script loads when the <code>greet</code> functionality is called using
commands like <samp>`centos-art greet --hello='World''</samp>.
</p>
<p>The <tt>`greet.sh'</tt> function script contains the <code>greet</code> function
definition. Inside <tt>`centos-art.sh'</tt> script, each function
definition has its own top commentary, followed by one blank line, and
then one function defintion below it.  
</p>
<p>The function top commentary contains a brief description about what
the function does, one-line for copyright note --with your personal
information--, the license under which the function source code is
released --the <tt>`centos-art.sh'</tt> script is released as GPL, so do
all its functions--, and the subversion <code>$Id$</code> keyword--which
is later expanded when we do <code>svn propset</code> over
<tt>`greet.sh'</tt> file--. In our function example, the <tt>`greet.sh'</tt>
top commentary would look like the following:
</p>
<pre class="verbatim">#!/bin/bash
#
# greet.sh -- This function outputs different kind of greetings to
# your screen. Use this function to understand how centos-art.sh
# script specific functionalities work.
#
# Copyright (C) YEAR YOURFULLNAME
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA.
# 
# ----------------------------------------------------------------------
# $Id$
# ----------------------------------------------------------------------
</pre>
<p>The <code>greet</code> function defines variables that will be available
along <code>greet</code> function execution environment. Later, as final
definition, the <code>greet</code> function calls the
<tt>`greet_getActions'</tt> function defined inside
<tt>`greet_getActions.sh'</tt> function script. 
</p>
<p>In our example, the <code>greet</code> function definition would look as
follows:
</p>
<pre class="verbatim">function greet {

    # Define global variables.

    # Define command-line interface.
    greet_getActions

}
</pre>
<p>This time we didn't use global variable definitions for <code>greet</code>
execution environment, so we left the section empty.
</p>
<p>The <code>greet_getActions</code> function defines the command-line
interface of <code>greet</code> functionality. The command-line interface
defines what to do with arguments passed to <tt>`centos-art.sh'</tt>
script once <code>greet</code> has been specified as second argument.
</p>
<p>In our function example, the <code>greet_getActions</code> function
definition would look like the following:
</p>
<pre class="verbatim">function greet_getActions {

    case &quot;$OPTIONNAM&quot; in

        --hello )
            greet_doHello
            ;;

        --bye )
            greet_doBye
            ;;

        * )
            cli_printMessage &quot;`gettext &quot;The option provided is not valid.&quot;`&quot;
            cli_printMessage &quot;$(caller)&quot; 'AsToKnowMoreLine'

    esac

}
</pre>
<p>In the above example, we've defined a selection case based on second
argument's option name (<var>OPTIONNAM</var>). In our selection case, we
defined the <samp>`--hello'</samp> and <samp>`--bye'</samp> options as valid
options. If no one of them is provided as second command-line
argument, the <samp>`*'</samp> option is evaluated instead. 
</p>
<p>The <samp>`*'</samp> option and the two following lines, should always be
present in <tt>`*_getActions.sh'</tt> function scripts, no matter what
specific functionality you are creating. This convenction helps the
user to find out documentation about the current functionality in use.
Of course, function documentation needs to be created first
(see section <a href="repository_39.html#SEC208">trunk/Scripts/Bash/Functions/Help</a>, to know how), and that
task is something you --as author of specific functions-- probably
want to do personally. 
</p>
<p>Following with our example, the <code>greet_doHello</code>, and
<code>greet_doBye</code> function definitions are the core of <code>greet</code>
specific functionality.  In such function definitions is where we
define what our function realy does --output different kinds of
greetings, in the sake of our example--. 
</p>
<pre class="verbatim">function greet_doHello {

    cli_printMessage &quot;`gettext &quot;Hello&quot;` $OPTIONVAL&quot;

}
</pre>
<p>The <code>greet_doHello</code> function definition is stored in
<tt>`greet_doHello.sh'</tt> function script. 
</p>
<pre class="verbatim">function greet_doBye {

    cli_printMessage &quot;`gettext &quot;Goodbye&quot;` $OPTIONVAL&quot;

}
</pre>
<p>The <code>greet_doBye</code> function definition is stored in the
<tt>`greet_doBye.sh'</tt> function script. 
</p>
<p>Both <tt>`greet_doHello.sh'</tt> and <tt>`greet_doBye.sh'</tt> function
scripts are stored inside <code>greet</code>'s function directory path (i.e.
<tt>`trunk/Scripts/Bash/Functions/Greet'</tt>).
</p>
<p>In the examples above, we use the <var>OPTIONVAL</var> global variable.
The <var>OPTIONVAL</var> variable is defined in <tt>`cli.sh'</tt> function
script and contains the value passed after the equal sign (i.e.,
<samp>`='</samp>) in the second command-line argument of <tt>`centos-art.sh'</tt>
script. For example, if the second command-line argument is
<samp>`--hello='World''</samp>, the value of <var>OPTIONVAL</var> variable would
be <samp>`World'</samp> without quotes.
</p>
<p>Let's see how <code>greet</code> specific functionality files are organzied
under <code>greet</code>'s function directory. To see file organization, we
use the <code>tree</code> command:
</p>
<pre class="verbatim">trunk/Scripts/Bash/Functions/Greet
|-- greet_doBye.sh
|-- greet_doHello.sh
|-- greet_getActions.sh
`-- greet.sh
</pre>
<p>To try the <code>greet</code> specific functionality, pass <code>greet</code>
string as first argument to <tt>`centos-art.sh'</tt> script, and any of
the valid options as second argument. Some examples are illustrated
below:
</p>
<pre class="verbatim">[centos@projects ~]$ centos-art greet --hello='World'
Hello World
[centos@projects ~]$ centos-art greet --bye='World'
Goodbye World
[centos@projects ~]$ 
</pre>
<p>The word <samp>`World'</samp> in the examples above, can be anything. In fact,
change it to have a little fun :).
</p>
<p>Now that we have a specific function that works as we expect, it is
time to document it. To document <code>greet</code> specific functionality,
we need to use its directory path and the <code>help</code> functionality
(see section <a href="repository_39.html#SEC208">trunk/Scripts/Bash/Functions/Help</a>) of <tt>`centos-art.sh'</tt>
script, just as the following command illustrates: 
</p>
<pre class="verbatim">centos-art help --edit=trunk/Scripts/Bash/Functions/Greet
</pre>
<p>Well, it seems that our example is rather complete by now. 
</p>
<p>In <code>greet</code> example we've described so far, we only use the
<code>cli_printMessage</code> global function in action specific
functions, but more interesting things can be achieved inside them.
For example, if you pass a directory path as second argument option
value, you could retrive a list of files from therein, and process
them. If the list of files turns too long, you could add the third
argument in the form <samp>`--filter='regex''</samp> and reduce the amount
of files to process using a regular expression pattern.
</p>
<p>This description may serve you as an introduction to understand how
specific functionalities work inside <tt>`centos-art.sh'</tt> script. With
some of luck this introduction will also serve you as motivation to
create your own specific functionalities.
</p>
<p>By the way, the <code>greet</code> functionality doesn't exist inside
<tt>`centos-art.sh'</tt> script. Would you like to create it?
</p>

<a name="SEC203"></a>
<h3 class="subsection"> 3.35.3 Usage </h3>


<a name="SEC204"></a>
<h4 class="subsubsection"> 3.35.3.1 Global variables </h4>

<p>The following global variables of <tt>`centos-art.sh'</tt> script, are
available for you to use inside specific functions:
</p>
<dl>
<dt><u>Variable:</u> <b>TEXTDOMAIN</b>
<a name="IDX1"></a>
</dt>
<dd><p>Default domain used to retrieve translated messages. This value is set
in `initFunctions.sh' and shouldn't be changed.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>TEXTDOMAINDIR</b>
<a name="IDX2"></a>
</dt>
<dd><p>Default directory used to retrieve translated messages. This value is
set in `initFunctions.sh' and shouldn't be changed.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>ACTION</b>
<a name="IDX3"></a>
</dt>
<dd><p>Default action passed to <code>centos-art</code> command as first
argument. For example, in the command <samp>`centos-art render
--entry=path/to/dir --filter=regex'</samp>, the action passed to
<code>centos-art</code> is <samp>`render'</samp>.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>OPTIONNAM</b>
<a name="IDX4"></a>
</dt>
<dd><p>Default option name passed to <code>centos-art</code> command as second
argument. For example, in the command <samp>`centos-art render
--entry=path/to/dir --filter=regex'</samp>, the option name passed to
<code>centos-art</code> as second argument is <samp>`--entry'</samp>.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>OPTIONVAL</b>
<a name="IDX5"></a>
</dt>
<dd><p>Default option value passed to <code>centos-art</code> command as second
argument. For example, in the command <samp>`centos-art render
--entry=path/to/dir --filter=regex'</samp>, the option value passed to
<code>centos-art</code> as second argument is <samp>`path/to/dir'</samp>.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>REGEX</b>
<a name="IDX6"></a>
</dt>
<dd><p>Default option value passed to <code>centos-art</code> command as third
argument. For example, in the command <samp>`centos-art render
--entry=path/to/dir --filter=regex'</samp>, the option value passed to
<code>centos-art</code> as second argument is <samp>`regex'</samp>. 
</p>
<p>At present time, the option name passed as third argument is not
variable, as second argument option name is. The third argument option
name is stocked to <samp>`--filter'</samp> for whatever value it passed at
the right side of its equal sign. Generally, third argument option
value is used to pass regular expression patterns that modify the list
of files to process but this is not the only feature it may serve to.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>ANSWER</b>
<a name="IDX7"></a>
</dt>
<dd><p>Default answer for questions. As most questions are to request
confirmation about some specific action, default answer to this
variable is negative (i.e., <samp>`No'</samp>). Default answer value takes
place when no value is entered as response to confirmation questions
before pressing <kbd>RET</kbd> key.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>TMPFILE</b>
<a name="IDX8"></a>
</dt>
<dd><p>Default location to store temporal files. This variable contains a
value with the format <samp>`/tmp/centos-art-$$'</samp>. The <samp>`$$'</samp> expands
to the process id of <code>centos-art</code> current execution.
</p></dd></dl>

<dl>
<dt><u>Variable:</u> <b>EDITOR</b>
<a name="IDX9"></a>
</dt>
<dd><p>Default text editor. This variable contains the absolute path to
<tt>`centos-art.sh'</tt> script default text editor (i.e.,
<tt>`/usr/bin/vim'</tt>). If you want to use a different text editor set,
and export this variable in your <tt>`~/.bash_profile'</tt> file. The
<tt>`centos-art.sh'</tt> script recognizes one of the following text
editors only:
</p>
<ul class="toc">
<li> /usr/bin/vim
</li><li> /usr/bin/emacs
</li><li> /usr/bin/nano
</li></ul>
</dd></dl>


<a name="SEC205"></a>
<h4 class="subsubsection"> 3.35.3.2 Global functions </h4>

<p>The following global functions of <tt>`centos-art.sh'</tt> script, are
available for you to use inside specific functions:
</p>
<dl>
<dt><u>Function:</u> <b>cli_commitRepoChanges</b>
<a name="IDX10"></a>
</dt>
<dd><p>The <code>cli_commitRepoChanges</code> function uses the list of files
stored in the <var>FILES</var> variable and verifies changes inside your
repository working copy, using subversion commands.  If
<code>cli_commitRepoChanges</code> finds changes inside your working copy,
it asks you for confirmation to commit them up to central repository.
</p>
<p>Call <code>cli_commitRepoChanges</code> function after functions that modify
files inside your repository working copy.
</p>
</dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_checkFiles</b><i> FILE [TYPE [ACTION [OPTIONS]]]</i>
<a name="IDX11"></a>
</dt>
<dd><p><code>cli_checkFiles</code> receives a <var>FILE</var> absolute path and performs
verification as specified in <var>TYPE</var>.  
</p>
<p>When <var>TYPE</var> is not specified, <code>cli_checkFiles</code> verifies
<var>FILE</var> existence, no matter what kind of file it be.  If
<var>TYPE</var> is specified, it can take one of the following values:
</p>
<dl compact="compact">
<dt> <samp>`d'</samp></dt>
<dt> <samp>`directory'</samp></dt>
<dd><p>To evaluate <var>FILE</var> as directory.
</p></dd>
<dt> <samp>`f'</samp></dt>
<dt> <samp>`regular-file'</samp></dt>
<dd><p>To evaluate <var>FILE</var> as regular file.
</p></dd>
<dt> <samp>`h'</samp></dt>
<dt> <samp>`symbolic-link'</samp></dt>
<dd><p>To evaluate <var>FILE</var> as symbolic link.
</p></dd>
<dt> <samp>`fh'</samp></dt>
<dd><p>To evaluate <var>FILE</var> as regular file first and symbolic link later.
When <var>FILE</var> is neither a regular file or a symbolic link,
<code>cli_checkFiles</code> considers <var>FILE</var> as unexistent file.
</p></dd>
</dl>

<p>When <var>ACTION</var> is not specified, <code>cli_checkFiles</code> function uses
<samp>`Checking'</samp> as default action message. The action message is used
on left-column as description for verification action. It may be cases
where you need to change default action message with your own. In that
cases remember to use the <code>&quot;`gettext &quot;Your message&quot;`&quot;</code>
construction in order for <code>gettext</code> to know about it. This way
your action message can be translated to other languages too.
</p>
<p>By default <code>cli_checkFiles</code> output information about <var>FILE</var>
on the right column. When <var>OPTIONS</var> is specified, default behaivour
is modified as specified in <var>OPTIONS</var>. The <var>OPTIONS</var> can take
any of the following options:
</p><dl compact="compact">
<dt> <samp>`--quiet'</samp></dt>
<dd><p>If this option is specified, <code>cli_checkFiles</code> supresses
verification output.  This option is useful if you only want to do
file verifications but don't want to output any information about it.
</p>
<pre class="verbatim">cli_checkFiles $FILE 'f' '' '--quiet'
if [[ $? -eq 0 ]];then
    echo &quot;File exists.&quot;
else
    echo &quot;File doesn't exist&quot;
fi
</pre></dd>
</dl>
</dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_getCountryCodes</b><i> [FILTER]</i>
<a name="IDX12"></a>
</dt>
<dd><p><code>cli_getCountryCodes</code> function outputs a list with country codes
as defined in ISO3166 standard. When <var>FILTER</var> is provided,
<code>cli_getCountryCodes</code> outpus country codes that match
<var>FILTER</var> regular expression pattern.
</p></dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_getCountryNames</b><i> [FILTER]</i>
<a name="IDX13"></a>
</dt>
<dd><p><code>cli_getCountryNames</code> function reads one language locale code in
the format LL_CC and outputs the name of its related country as in
ISO3166. If filter is specified, just the country name that matches
<var>FILTER</var>, exactly, is returned. 
</p></dd></dl>
 
<dl>
<dt><u>Function:</u> <b>cli_getCurrentLocale</b>
<a name="IDX14"></a>
</dt>
<dd><p><code>cli_getCurrentLocale</code> function checks <var>LANG</var> environment
variable and returns the current locale from more specific to less
specific. For example, if the locale <samp>`en_GB'</samp> is the current one,
it should be used instead of just <samp>`en'</samp>.
</p></dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_getLangCodes</b><i> [FILTER]</i>
<a name="IDX15"></a>
</dt>
<dd><p><code>cli_getLangCodes</code> function outputs a list of language codes as
defined in ISO639 standard. When <var>FILTER</var> is provided,
<code>cli_getLangCodes</code> outputs language codes that match <var>FILTER</var>
regular expression pattern.
</p></dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_getLangNames</b>
<a name="IDX16"></a>
</dt>
<dd><p><code>cli_getLangNames</code> function reads one language locale code in the
format LL_CC and outputs its language name as defined in ISO639
standard. If filter is specified, just the language name that matches
<var>FILTER</var>, exactly, is returned.
</p></dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_getLocales</b>
<a name="IDX17"></a>
</dt>
<dd><p><code>cli_getLocales</code> function outputs locale codes in LL and LL_CC
format. Combine both ISO639 and ISO3166 specification in order to
build the final locale list. The <code>cli_getLocales</code> function
defines which translation locales are supported inside CentOS Artwork
Repository.
</p></dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_getRepoNames</b>
<a name="IDX18"></a>
</dt>
<dd><p><code>cli_getRepoNames</code> function sets naming convenction inside CentOS
Artowrk Repository. As convenction, regular files are written in lower
case and directories are written in CamelCase. Use this function to
sanitate the name of regular files and directories you work with.
</p></dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_getThemeName</b>
<a name="IDX19"></a>
</dt>
<dd><p><code>cli_getThemeName</code> function manipulates the current absolute path
to extract the theme name from it. If there is no theme in the path,
this function returns an empty string.
</p></dd></dl>

<dl>
<dt><u>Function:</u> <b>cli_printMessage</b><i> MESSAGE [FORMAT]</i>
<a name="IDX20"></a>
</dt>
<dd><p><code>cli_printMessage</code> function outputs information in predifined
formats. The <code>cli_printMessage</code> function is the standard way to
output information inside <tt>`centos-art.sh'</tt> script. Use this
function whenever you need to output information from
<tt>`centos-art.sh'</tt>.
</p>
<p>When <var>FORMAT</var> is not specified, <code>cli_printMessage</code> outputs
information just as it was passed in <var>MESSAGE</var> variable.
Otherwise, <var>FORMAT</var> can take one of the following values:
</p>
<dl compact="compact">
<dt> <samp>`AsHeadingLine'</samp></dt>
<dd><p>To standardize heading messages.
</p><pre class="verbatim">----------------------------------------------------------------------
$MESSAGE
----------------------------------------------------------------------
</pre>
</dd>
<dt> <samp>`AsWarningLine'</samp></dt>
<dd><p>To standardize warning messages.
</p><pre class="verbatim">----------------------------------------------------------------------
WARNING: $MESSAGE
----------------------------------------------------------------------
</pre>
</dd>
<dt> <samp>`AsNoteLine'</samp></dt>
<dd><p>To standardize note messages.
</p><pre class="verbatim">----------------------------------------------------------------------
NOTE: $MESSAGE
----------------------------------------------------------------------
</pre>
</dd>
<dt> <samp>`AsUpdatingLine'</samp></dt>
<dd><p>To standardize <samp>`Updating'</samp> messages using two-columns format.
</p><pre class="verbatim">Updating        $MESSAGE
</pre>
</dd>
<dt> <samp>`AsRemovingLine'</samp></dt>
<dd><p>To standardize <samp>`Removing'</samp> messages using two-columns format.
</p><pre class="verbatim">Removing        $MESSAGE
</pre>
</dd>
<dt> <samp>`AsCheckingLine'</samp></dt>
<dd><p>To standardize <samp>`Checking'</samp> messages using two-columns format.
</p><pre class="verbatim">Checking        $MESSAGE
</pre>
</dd>
<dt> <samp>`AsCreatingLine'</samp></dt>
<dd><p>To standardize <samp>`Creating'</samp> messages using two-columns format.
</p><pre class="verbatim">Creating        $MESSAGE
</pre>
</dd>
<dt> <samp>`AsSavedAsLine'</samp></dt>
<dd><p>To standardize <samp>`Saved as'</samp> messages using two-columns format.
</p><pre class="verbatim">Saved as        $MESSAGE
</pre>
</dd>
<dt> <samp>`AsLinkToLine'</samp></dt>
<dd><p>To standardize <samp>`Linked to'</samp> messages using two-columns format.
</p><pre class="verbatim">Linked to       $MESSAGE
</pre>
</dd>
<dt> <samp>`AsMovedToLine'</samp></dt>
<dd><p>To standardize <samp>`Moved to'</samp> messages using two-columns format.
</p><pre class="verbatim">Moved to        $MESSAGE
</pre>
</dd>
<dt> <samp>`AsTranslationLine'</samp></dt>
<dd><p>To standardize <samp>`Translation'</samp> messages using two-columns format.
</p><pre class="verbatim">Translation     $MESSAGE
</pre>
</dd>
<dt> <samp>`AsConfigurationLine'</samp></dt>
<dd><p>To standardize <samp>`Configuration'</samp> messages using two-columns format.
</p><pre class="verbatim">Configuration   $MESSAGE
</pre>
</dd>
<dt> <samp>`AsResponseLine'</samp></dt>
<dd><p>To standardize response messages using one-column format.
</p><pre class="verbatim">--&gt; $MESSAGE
</pre>
</dd>
<dt> <samp>`AsRequestLine'</samp></dt>
<dd><p>To standardize request messages using one-column format. Request
messages supress the trailing newline character from final output.
</p><pre class="verbatim">$MESSAGE
</pre>
</dd>
<dt> <samp>`AsYesOrNoRequestLine'</samp></dt>
<dd><p>To standardize <samp>`yes or no'</samp> request messages using one-column
format. If something different from <samp>`y'</samp> is answered (when using
<code>en_US.UTF-8</code> locale), script execution ends immediatly.  
</p>
<pre class="verbatim">$MESSAGE [y/N]:
</pre>
<p>When you are using <tt>`centos-art.sh'</tt> script in a locale different
from <code>en_US.UTF-8</code>, confirmation answer may be different from
<samp>`y'</samp>. For example, if you are using <code>es_ES.UTF-8</code> locale, the
confirmation question would look like:
</p>
<pre class="verbatim">$MESSAGE [s/N]:
</pre>
<p>and the confirmation answer would be <samp>`s'</samp>, as it is on Spanish
<samp>`sí'</samp> word.
</p>
<p>Definition of which confirmation word to use is set on translation
messages for your specific locale information. See section <a href="repository_41.html#SEC218">trunk/Scripts/Bash/Functions/Locale</a>, for more information about locale-specific
translation messages.
</p>
</dd>
<dt> <samp>`AsToKnowMoreLine'</samp></dt>
<dd>
<p>To standardize <samp>`to know more, run the following command:'</samp>
messages. When the <samp>`AsToKnowMoreLine'</samp> option is used, the
<var>MESSAGE</var> value should be set to <code>&quot;$(caller)&quot;</code>. <code>caller</code>
is a Bash builtin that returns the context of the current subroutine
call. <samp>`AsToKnowMoreLine'</samp> option uses <code>caller</code> builtin
output to build documentation entry dynamically.
</p>
<pre class="verbatim">----------------------------------------------------------------------
To know more, run the following command:
centos-art help --read='path/to/dir'
----------------------------------------------------------------------
</pre>
<p>Use <samp>`AsToKnowMoreLine'</samp> option after errors and for intentional
script termination. 
</p>
</dd>
<dt> <samp>`AsRegularLine'</samp></dt>
<dd><p>To standardize regular messages using one-column format. 
</p>
<p>When <var>MESSAGE</var> contains a colon inside (e.g., <samp>`description:
message'</samp>), the <code>cli_printMessage</code> function outputs <var>MESSAGE</var>
using two-columns format. 
</p>
<p>Two-columns format definition is taken from
<tt>`trunk/Scripts/Bash/Styles/output_forTwoColumns.awk'</tt> file.
</p></dd>
</dl>
</dd></dl>


<a name="SEC206"></a>
<h4 class="subsubsection"> 3.35.3.3 Specific functions </h4>

<p>The following specific functions of <tt>`centos-art.sh'</tt> script, are
available for you to use:
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="repository_39.html#SEC208">3.36 trunk/Scripts/Bash/Functions/Help</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_40.html#SEC213">3.37 trunk/Scripts/Bash/Functions/Html</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_41.html#SEC218">3.38 trunk/Scripts/Bash/Functions/Locale</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_42.html#SEC223">3.39 trunk/Scripts/Bash/Functions/Path</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_43.html#SEC228">3.40 trunk/Scripts/Bash/Functions/Render</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_44.html#SEC233">3.41 trunk/Scripts/Bash/Functions/Render/Config</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_45.html#SEC241">3.42 trunk/Scripts/Bash/Functions/Shell</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_46.html#SEC246">3.43 trunk/Scripts/Bash/Functions/Svg</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_47.html#SEC251">3.44 trunk/Scripts/Bash/Functions/Verify</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>


<a name="SEC207"></a>
<h3 class="subsection"> 3.35.4 See also </h3>

<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="repository_37.html#SEC195">3.34 trunk/Scripts/Bash</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="repository_48.html#SEC259">3.45 trunk/Scripts/Bash/Locale</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>


<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC206" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="repository_39.html#SEC208" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="repository_3.html#SEC3" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC200" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="repository_62.html#SEC342" title="Next chapter"> &gt;&gt; </a>]</td>
</tr></table>
<p>
 <font size="-1">
  This document was generated on <i>November, 3 2010</i> using <a href="http://texi2html.cvshome.org/"><i>texi2html 1.76</i></a>.
 </font>
 <br>

</p>
</body>
</html>
centos / artwork-archive

Source Code

Files
