Blame Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/prepare.docbook

5cbf0a
<refentry id="scripts-bash-prepare">
d2638e
5cbf0a
    <refmeta>
5cbf0a
        <refentrytitle>prepare</refentrytitle>
5cbf0a
        <indexterm type="specific-function">
5cbf0a
            <primary>Standardize configuration tasks inside &TCAR;</primary>
5cbf0a
        </indexterm>
5cbf0a
    </refmeta>
eebdc3
5cbf0a
    <refnamediv>
5cbf0a
        <refname>prepare</refname>
5cbf0a
        <refpurpose>Standardize configuration tasks inside &TCAR;</refpurpose>
5cbf0a
    </refnamediv>
0b7bc3
5cbf0a
    <refsynopsisdiv>
d2638e
    <para>
eebdc3
        Assuming this is the very first time you run the
888694
        <command>centos-art</command> command, you'll find that there
888694
        isn't such a command in your workstation.  This is correct
888694
        because you haven't created the symbolic link that makes it
888694
        available in your execution path, yet. In order to make the
888694
        <command>centos-art</command> command available in the
888694
        execution path of your workstation, you need to run the
888694
        <command>centos-art.sh</command> script using its absolute
888694
        path first:
eebdc3
    </para>
eebdc3
65f94a
    <cmdsynopsis>
65f94a
        <command>~/artwork/trunk/Scripts/Bash/centos-art.sh</command>
65f94a
        <arg choice="req">prepare</arg>
65f94a
        <arg>--quiet</arg>
65f94a
        <arg>--answer-yes</arg>
65f94a
        <arg>--set-environment</arg>
65f94a
        <arg>--see-environment</arg>
65f94a
        <arg>--packages</arg>
65f94a
        <arg>--locales</arg>
65f94a
        <arg>--links</arg>
65f94a
        <arg>--images</arg>
65f94a
        <arg>--manuals</arg>
65f94a
        <arg>--sync-changes</arg>
65f94a
    </cmdsynopsis>
eebdc3
eebdc3
    <para>
888694
        Later, once the <command>centos-art</command> command is
888694
        available in your execution path, there is no need for you to
888694
        use any absolute path again.  From this time on, you can use
888694
        the <command>centos-art</command> command-line interface
888694
        directly, as the following example describes:
eebdc3
    </para>
eebdc3
65f94a
    <cmdsynopsis>
65f94a
        <command>centos-art</command>
65f94a
        <arg choice="req">prepare</arg>
5cbf0a
        <arg>--help</arg>
65f94a
        <arg>--quiet</arg>
65f94a
        <arg>--answer-yes</arg>
65f94a
        <arg>--set-environment</arg>
65f94a
        <arg>--see-environment</arg>
65f94a
        <arg>--packages</arg>
65f94a
        <arg>--locales</arg>
65f94a
        <arg>--links</arg>
65f94a
        <arg>--images</arg>
65f94a
        <arg>--manuals</arg>
65f94a
        <arg>--sync-changes</arg>
65f94a
    </cmdsynopsis>
5cbf0a
    </refsynopsisdiv>
eebdc3
5cbf0a
    <refsection>
5cbf0a
    <title>Description</title>
5cbf0a
    <para>
5cbf0a
        The <function>prepare</function> function exists to set
5cbf0a
        environment variables, install/update required packages,
5cbf0a
        create symbolic links for content reusing, render images based
5cbf0a
        on available design models and artistic motifs, render
5cbf0a
        documentation manuals, build language-specific files required
5cbf0a
        for content localization and anything else needed in order to
5cbf0a
        make the working copy of &TCAR; ready to be used.
5cbf0a
    </para>
0b7bc3
5cbf0a
    <para>
5cbf0a
        When no option is provided to <function>prepare</function>
5cbf0a
        functionality, the <command>centos-art.sh</command> script
5cbf0a
        uses the <option>--set-environment</option>,
5cbf0a
        <option>--packages</option>, <option>--locales</option>
5cbf0a
        <option>--links</option>, <option>--images</option> and
5cbf0a
        <option>--manuals</option> options, in that order, as default
5cbf0a
        behaviour.  Otherwise, if you provide any option, the
5cbf0a
        <command>centos-art.sh</command> script avoids its default
5cbf0a
        behaviour and executes the <function>prepare</function>
5cbf0a
        functionality as specified by the options you provided.
5cbf0a
    </para>
0b7bc3
eebdc3
    <para>
5cbf0a
        Notice that it is possible for you to execute the
5cbf0a
        <function>prepare</function> functionality as many times as
5cbf0a
        you need to.  This is specially useful when you need to keep
5cbf0a
        syncronized the relation between content produced inside your
5cbf0a
        working copy and the applications you use outside it. For
5cbf0a
        example, considering you've added new brushes to or removed
5cbf0a
        old brushes from your working copy of &TCAR;, the link
5cbf0a
        information related to those files need to be updated in the
5cbf0a
        <filename class="directory">~/.gimp-2.2/brushes</filename>
5cbf0a
        directory too, in a way the addition/deletion change that took
5cbf0a
        place in your working copy can be reflected there, as well.
5cbf0a
        The same is true for other similar components like fonts,
5cbf0a
        patterns and palettes.
d2638e
    </para>
d2638e
5cbf0a
    </refsection>
5cbf0a
5cbf0a
    <refsection>
5cbf0a
    <title>Usage</title>
d2638e
    <para>
5cbf0a
        Use the <function>prepare</function> functionality the first
5cbf0a
        time you download a working copy of &TCAR; or later, to be
5cbf0a
        sure your workstation has all the components it needs so you
5cbf0a
        can use the working copy of &TCAR; in all its extension.
d2638e
    </para>
5cbf0a
    </refsection>
5cbf0a
5cbf0a
    <refsection id="scripts-bash-prepare-options">
5cbf0a
    <title>Options</title>
d2638e
5cbf0a
    <para>
5cbf0a
        The <command>centos-art prepare</command> command accepts
5cbf0a
        common options described in 
5cbf0a
        linkend="scripts-bash-cli-commonoptions" /> and the following
5cbf0a
        specific options:
5cbf0a
    </para>
5cbf0a
5cbf0a
    <variablelist>
d2638e
    <varlistentry>
d2638e
    <term><option>--answer-yes</option></term>
d2638e
    <listitem>
d2638e
    <para>
d2638e
       Assume <emphasis>yes</emphasis> to all confirmation requests.
d2638e
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
d2638e
    <varlistentry>
d2638e
    <term><option>--packages</option></term>
d2638e
    <listitem>
d2638e
    <para>
888694
        This option verifies packeges required by automation scripts
888694
        and installs or updates them as required. When required
888694
        packages aren't installed or need to be updated, the
888694
        <command>centos-art</command> uses the <command>sudo</command>
888694
        and <command>yum</command> to perform either installations or
888694
        actualizations tasks.  In both cases, it is required that you
888694
        configure the <filename>/etc/sudoers</filename> configuration
888694
        file first, as discribed in 
888694
        linkend="repo-ws-config-sudoers" />.
d2638e
    </para>
f6191b
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
d2638e
    <varlistentry>
0b7bc3
    <term><option>--locales</option></term>
0b7bc3
    <listitem>
0b7bc3
    <para>
888694
        This option creates or updates the portable objects (PO) and
888694
        machine object (MO) used by <application>gettext</application>
888694
        to retrive translated strings related to
888694
        <command>centos-art.sh</command> script.  This option calls
888694
        the <function>locale</function> functionality of centos-art.sh
888694
        with the <option>--update</option> option, as described in
0b7bc3
        <xref linkend="scripts-bash-locale" />.
0b7bc3
    </para>
0b7bc3
    </listitem>
0b7bc3
    </varlistentry>
0b7bc3
0b7bc3
    <varlistentry>
d2638e
    <term><option>--links</option></term>
d2638e
    <listitem>
d2638e
    <para>
a714a6
        This option maintains the file relation between your working
a714a6
        copy and configuration files inside your workstation through
a714a6
        symbolic links. When you provide this option, the
888694
        <command>centos-art.sh</command> script puts itself into your
a714a6
        system's execution path through its command line interface
a714a6
        <command>centos-art</command> and makes common brushes,
a714a6
        patterns, palettes and fonts inside the working copy,
a714a6
        available to applications like GIMP in order for you to make
a714a6
        use of them without loosing version control over them.
d2638e
    </para>
a2d108
    <caution>
a2d108
    <para>
a2d108
        This option removes all common fonts, brushes, patterns, and
a714a6
        palettes currently installed in your home directory, in order
a714a6
        to create a fresh installation of them all again, using the
65f94a
        working copy as section.
a2d108
    </para>
a2d108
    </caution>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
    
d2638e
    <varlistentry>
d2638e
    <term><option>--images</option></term>
d2638e
    <listitem>
d2638e
    <para>
d2638e
        This option initializes image files inside the working copy.
d2638e
        When you provide this option, the
888694
        <command>centos-art.sh</command> calls the
888694
        <function>render</function> functionality to create images
888694
        related to each design model available in your working copy,
888694
        as described in <xref linkend="scripts-bash-render" />.
d2638e
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
d2638e
    <varlistentry>
d2638e
    <term><option>--manuals</option></term>
d2638e
    <listitem>
d2638e
    <para>
d2638e
       This option initializes documentation files inside the working
d2638e
       copy. When you provide this option, the
888694
       <command>centos-art.sh</command> script calls both the
888694
       <function>render</function> and <function>help</function>
888694
       functionality to produce DocBook and Texinfo manuals,
888694
       respectively.
eebdc3
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
d2638e
    <varlistentry>
0b7bc3
    <term><option>--see-environment</option></term>
d2638e
    <listitem>
d2638e
    <para>
d2638e
       Print the name and value of some of the environment variables
888694
       used by <command>centos-art.sh</command> script as described
0b7bc3
       in <xref linkend="scripts-bash-environment" />.  
0b7bc3
    </para>
0b7bc3
    </listitem>
0b7bc3
    </varlistentry>
0b7bc3
0b7bc3
    <varlistentry>
0b7bc3
    <term><option>--set-environment</option></term>
0b7bc3
    <listitem>
0b7bc3
    <para>
0b7bc3
       Set default environment values to your personal profile
0b7bc3
       (<filename>~/.bash_profile</filename>).
d2638e
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
    </variablelist>
d2638e
5cbf0a
    </refsection>
d2638e
5cbf0a
    <refsection id="scripts-bash-prepare-example">
5cbf0a
    <title>Examples</title>
d2638e
    <para>
5cbf0a
        None.
d2638e
    </para>
5cbf0a
    </refsection>
d2638e
5cbf0a
    <refsection id="scripts-bash-prepare-bugs">
65f94a
    <title>Bugs</title>
874f49
    <para>
65f94a
        To report bugs related to this function, please create a new
3bff97
        ticket 
3bff97
        url="https://projects.centos.org/trac/artwork/newticket?summary=Error%20Standardizing%20Configuration%20Tasks&component=Scripts">here</ulink>
3bff97
        refering the specific problems you found in it. For example,
3bff97
        it would be useful if you copy and paste any error output from
3bff97
        <command>centos-art.sh</command> script.
874f49
    </para>
5cbf0a
    </refsection>
874f49
5cbf0a
    <refsection id="scripts-bash-prepare-authors">
0b7bc3
    <title>Authors</title>
874f49
    <para>
5cbf0a
        The following people have worked in this functionality:
874f49
    </para>
0b7bc3
    <itemizedlist>
0b7bc3
    <listitem>
874f49
    <para>
c272b0
        Alain Reguera Delgado <<ulink url="mailto:alain.reguera@gmail.com">alain.reguera@gmail.com</ulink>>, =COPYRIGHT_YEAR_LIST=
874f49
    </para>
0b7bc3
    </listitem>
0b7bc3
    </itemizedlist>
5cbf0a
    </refsection>
874f49
5cbf0a
    <refsection id="scripts-bash-prepare-licence">
0b7bc3
    <title>License</title>
c272b0
874f49
    <para>
c272b0
        Copyright © =COPYRIGHT_YEAR_LIST= The CentOS Project
c272b0
    </para>
0b7bc3
 
c272b0
    <para>
c272b0
        This program is free software; you can redistribute it and/or
c272b0
        modify it under the terms of the GNU General Public License as
c272b0
        published by the Free Software Foundation; either version 2 of
c272b0
        the License, or (at your option) any later version.
c272b0
    </para>
0b7bc3
 
c272b0
    <para>
c272b0
        This program is distributed in the hope that it will be
c272b0
        useful, but WITHOUT ANY WARRANTY; without even the implied
c272b0
        warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
c272b0
        PURPOSE.  See the GNU General Public License for more details.
c272b0
    </para>
0b7bc3
 
c272b0
    <para>
c272b0
        You should have received a copy of the GNU General Public
c272b0
        License along with this program; if not, write to the Free
c272b0
        Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
c272b0
        USA.
874f49
    </para>
5cbf0a
    </refsection>
874f49
5cbf0a
</refentry>