Blame Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook

e68d9f
<sect1 id="scripts-bash-prepare">
d2638e
e68d9f
    <title>The <function>prepare</function> functionality</title>
eebdc3
eebdc3
    <para>
d2638e
        The <function>prepare</function> functionality is the
d2638e
        interface the <command>centos-art.sh</command> script provides
d2638e
        to standardize the final configuration stuff your workstation
d2638e
        needs, once the working copy of &TCAR; has been downloaded
d2638e
        inside it already.
d2638e
    </para>
d2638e
d2638e
    <simplesect>
d2638e
d2638e
    <title>Synopsis</title>
d2638e
d2638e
    <para>
eebdc3
        Assuming this is the very first time you run the
eebdc3
        <command>centos-art.sh</command> script, you'll find that
eebdc3
        it isn't found in your workstation.  This is correct because
eebdc3
        you haven't create the command-line interface symbolic link
eebdc3
        that make it available in the execution path. In order to make
eebdc3
        the <command>centos-art.sh</command> command-line
eebdc3
        available in the execution path of your workstation, you need
eebdc3
        to run it using its absolute path first:
eebdc3
    </para>
eebdc3
eebdc3
    <screen>~/artwork/trunk/Scripts/centos-art.sh prepare [OPTIONS]</screen>
eebdc3
eebdc3
    <para>
eebdc3
        Later, once the <command>centos-art.sh</command> script is
eebdc3
        available in the execution path of your system, there is no
eebdc3
        need for you to use the absolute path again.  From this time
eebdc3
        on, you can use the <command>centos-art</command> command-line
eebdc3
        interface directly, as the following example describes:
eebdc3
    </para>
eebdc3
eebdc3
    <screen>centos-art prepare [OPTIONS]</screen>
eebdc3
eebdc3
    <para>
d2638e
        The <function>prepare</function> functionality accepts the
d2638e
        following options: 
d2638e
    </para>
d2638e
d2638e
    <variablelist>
d2638e
    <varlistentry>
d2638e
    <term><option>--quiet</option></term>
d2638e
    <listitem>
d2638e
    <para>
d2638e
        Supress all output messages except error messages.  When this
d2638e
        option is passed, all confirmation requests are supressed and
d2638e
        a possitive answer is assumed for them, just as if the
d2638e
        <option>--answer-yes</option> option had been provided.
d2638e
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
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>
d2638e
        This option verifies whether required packages need to be
d2638e
        installed or updated. In both cases, the <command>sudo
d2638e
        yum</command> command is used to perform such tasks. This
d2638e
        configuration requires you to configure the
d2638e
        <command>sudo</command> command first, as described in 
d2638e
        linkend="repo-ws-config-sudo" />.
d2638e
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
d2638e
    <varlistentry>
d2638e
    <term><option>--links</option></term>
d2638e
    <listitem>
d2638e
    <para>
d2638e
        This option creates/updates the symbolic links information
d2638e
        required in your workstation to connect it with the files
d2638e
        inside the working copy of &TCAR;. When you provide this
d2638e
        option, the <command>centos-art.sh</command> put itself into
a2d108
        your system's execution path and make common brushes,
a2d108
        patterns, palettes and fonts available inside applications
a2d108
        like GIMP, so you can make use of them without loosing version
a2d108
        control over them.
d2638e
    </para>
a2d108
    <caution>
a2d108
    <para>
a2d108
        This option removes all common fonts, brushes, patterns, and
a2d108
        palettes from your home configuration directories, in order to
a2d108
        create a fresh installation of them all, again, using the
a2d108
        working copy as reference.
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
d2638e
        <command>centos-art.sh</command> scripts renders image files
d2638e
        from all design models available in the working copy. This
d2638e
        step is required in order to satisfy dependencies from
d2638e
        different components inside the working copy.
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
d2638e
       <command>centos-art.sh</command> script renders all
d2638e
       documentation manuals from their related source files so you
d2638e
       can read them nicely.
eebdc3
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
d2638e
    <varlistentry>
d2638e
    <term><option>--environment</option></term>
d2638e
    <listitem>
d2638e
    <para>
d2638e
       Print the name and value of some of the environment variables
d2638e
       used by <command>centos-art.sh</command> scripts.  
d2638e
    </para>
d2638e
    </listitem>
d2638e
    </varlistentry>
d2638e
    </variablelist>
d2638e
d2638e
    <para>
d2638e
        As default behaviour, when no option is provided to
d2638e
        <function>prepare</function> functionality, the
d2638e
        <command>centos-art.sh</command> script
d2638e
        excecutes as is it had been executed with the
d2638e
        <option>--packages</option>, <option>--links</option>,
d2638e
        <option>--images</option> and <option>--manuals</option>
d2638e
        options. Otherwise, if you provide any option, the
d2638e
        <command>centos-art.sh</command> script executes the
d2638e
        <function>prepare</function> functionality as specified by the
d2638e
        options.
d2638e
    </para>
d2638e
d2638e
    <para>
d2638e
        Notice that is possible for you to execute the
d2638e
        <function>prepare</function> functionality as much times as
d2638e
        you need to.  This is specially useful when you need to keep
d2638e
        syncronized the relation between content produced inside your
d2638e
        working copy and the applications you use outside it. For
d2638e
        example, considering you've added new brushes to or removed
d2638e
        old brushes from your working copy of &TCAR;, the link
d2638e
        information related to those files need to be updated in the
d2638e
        <filename class="directory">~/.gimp-2.2/brushes</filename>
d2638e
        directory too, in a way the addition/deletion change that took
d2638e
        place in your working copy can be reflected there, as well.
d2638e
        The same is true for other similar components like fonts,
d2638e
        patterns and palettes.
d2638e
    </para>
d2638e
    </simplesect>
d2638e
d2638e
    <simplesect>
d2638e
    <title>Examples</title>
d2638e
    <para>
d2638e
        The examples here seem to be pretty obvious once you've read
d2638e
        both the synopsis section and the options supported by this
d2638e
        functionality.  Isn't it?
d2638e
    </para>
d2638e
    </simplesect>
d2638e
d2638e
    <simplesect>
d2638e
    <title>Reporting Bugs</title>
d2638e
    <para>
d2638e
        Report bugs to &TCAML;.
d2638e
    </para>
d2638e
    </simplesect>
d2638e
d2638e
    <simplesect>
d2638e
    <title>Copyright</title>
d2638e
    <para>
d2638e
        Copyright © 2009, 2010, 2011 &TCAS;.
d2638e
    </para>
d2638e
    <para>
d2638e
        This  is free software.  You may redistribute copies of it
d2638e
        under the terms of the <xref linkend="licenses-gpl"/>.  There
d2638e
        is NO WARRANTY, to the extent permitted by law.
d2638e
    </para>
d2638e
    </simplesect>
d2638e
e68d9f
</sect1>