diff --git a/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook b/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook index 2566320..5748e53 100644 --- a/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook +++ b/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook @@ -1,6 +1,6 @@ - The <function>prepare</function> functionality + <function>prepare</function> — Standardize Configuration Tasks The prepare functionality is the @@ -10,19 +10,15 @@ inside it already. - - - Synopsis - Assuming this is the very first time you run the centos-art.sh script, you'll find that it isn't found in your workstation. This is correct because - you haven't create the command-line interface symbolic link - that make it available in the execution path. In order to make - the centos-art.sh command-line - available in the execution path of your workstation, you need - to run it using its absolute path first: + you haven't created the symbolic link that make it available + in the execution path, yet. In order to make the + centos-art.sh script available in the + execution path of your workstation, you need to run it using + its absolute path first: ~/artwork/trunk/Scripts/centos-art.sh prepare [OPTIONS] @@ -50,7 +46,7 @@ Supress all output messages except error messages. When this option is passed, all confirmation requests are supressed and a possitive answer is assumed for them, just as if the - option had been provided. + option whould have been provided. @@ -68,12 +64,16 @@ - This option verifies whether required packages need to be - installed or updated. In both cases, the sudo - yum command is used to perform such tasks. This - configuration requires you to configure the - sudo command first, as described in . + This option verifies packeges required by + centos-art.sh script. installs or updates + required packages. When required packages aren't installed, + this option uses sudo yum install + command to perform the installation task. When required + packages are installed, this option uses sudo yum + update to update them, if there is any related + actualization to be applied on. In both cases, it is required + that you configure the sudo command first, + as described in . @@ -82,20 +82,21 @@ - This option creates/updates the symbolic links information - required in your workstation to connect it with the files - inside the working copy of &TCAR;. When you provide this - option, the centos-art.sh put itself into - your system's execution path and make common brushes, - patterns, palettes and fonts available inside applications - like GIMP, so you can make use of them without loosing version - control over them. + This option maintains the file relation between your working + copy and configuration files inside your workstation through + symbolic links. When you provide this option, the + centos-art.sh puts itself into your + system's execution path through its command line interface + centos-art and makes common brushes, + patterns, palettes and fonts inside the working copy, + available to applications like GIMP in order for you to make + use of them without loosing version control over them. This option removes all common fonts, brushes, patterns, and - palettes from your home configuration directories, in order to - create a fresh installation of them all, again, using the + palettes currently installed in your home directory, in order + to create a fresh installation of them all again, using the working copy as reference. @@ -110,7 +111,7 @@ When you provide this option, the centos-art.sh scripts renders image files from all design models available in the working copy. This - step is required in order to satisfy dependencies from + step is required in order to satisfy file dependencies among different components inside the working copy. @@ -123,8 +124,8 @@ This option initializes documentation files inside the working copy. When you provide this option, the centos-art.sh script renders all - documentation manuals from their related source files so you - can read them nicely. + documentation manuals from their related source files to + different output formats, so you can read them nicely. @@ -134,27 +135,27 @@ Print the name and value of some of the environment variables - used by centos-art.sh scripts. + used by centos-art.sh scripts as described + in . - As default behaviour, when no option is provided to - prepare functionality, the - centos-art.sh script - excecutes as is it had been executed with the - , , - and - options. Otherwise, if you provide any option, the - centos-art.sh script executes the - prepare functionality as specified by the - options. + When no option is provided to prepare + functionality, the centos-art.sh script + uses the , + , and + options as default behaviour. + Otherwise, if you provide any option, the + centos-art.sh script avoids its default + behaviour and executes the prepare + functionality as specified by the options you provides. - Notice that is possible for you to execute the + Notice that it is possible for you to execute the prepare functionality as much times as you need to. This is specially useful when you need to keep syncronized the relation between content produced inside your @@ -168,34 +169,5 @@ The same is true for other similar components like fonts, patterns and palettes. - - - - Examples - - The examples here seem to be pretty obvious once you've read - both the synopsis section and the options supported by this - functionality. Isn't it? - - - - - Reporting Bugs - - Report bugs to &TCAML;. - - - - - Copyright - - Copyright © 2009, 2010, 2011 &TCAS;. - - - This is free software. You may redistribute copies of it - under the terms of the . There - is NO WARRANTY, to the extent permitted by law. - -