From d2638ec3e6dccbd58b63e0f76bbb3a7fb17f553c Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jul 01 2011 01:55:51 +0000 Subject: Update repository documentation manual in docbook format. --- diff --git a/Manuals/TCAR-UG/Docbook/Repository/Workstation/config.docbook b/Manuals/TCAR-UG/Docbook/Repository/Workstation/config.docbook index 629550c..a9ec457 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Workstation/config.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Workstation/config.docbook @@ -1,4 +1,4 @@ - + Configuring Your Workstation @@ -10,9 +10,9 @@ copy of &TCAR; and prepare it for start using it. - + - The Workplace + Workplace Once you've installed the workstation and it is up and @@ -138,8 +138,8 @@ - - The Environment Variables + + Environment Variables Once you've created the centos user name @@ -270,8 +270,8 @@ - - The Administrative Tasks + + Administrative Tasks Sometimes it is necessary that you perform administrative @@ -325,8 +325,8 @@ centos ALL=(ALL) ALL - - The Working Copy + + Working Copy Once you've installed and configured the workstation, it is diff --git a/Manuals/TCAR-UG/Docbook/Repository/Workstation/install.docbook b/Manuals/TCAR-UG/Docbook/Repository/Workstation/install.docbook index 577250c..fdb8f4a 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Workstation/install.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Workstation/install.docbook @@ -51,7 +51,7 @@ - The Partition Information + Partition Information The partition information you set in your workstation is very @@ -114,7 +114,7 @@ tmpfs tmpfs 1.1G /dev/shm - The Packages Selection + Packages Selection The packages selection lets you to specify which software does diff --git a/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook b/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook index 91c480b..3bdf04a 100644 --- a/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook +++ b/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook @@ -13,255 +13,234 @@ - Synopsis + centos-art help [OPTIONS] path/to/dir ... + + The path/to/dir parameter specifies the + directory structure inside the working copy of The CentOS + Artwork Repository you want to process the related + documentation entry for. More than one directory structure can + be passed as path/to/dir parameter. + - centos-art help [OPTIONS] path/to/dir ... - - - The path/to/dir parameter specifies - the directory structure inside the working copy of The - CentOS Artwork Repository you want to process the related - documentation entry for. More than one directory structure - can be passed as path/to/dir - parameter. - - - - The help functionality accepts the - following options: - - - - - - - - Supress all output messages except error messages. - When this option is passed, all confirmation requests - are supressed as well and a possitive answer is - assumed for them, just as if the - option had been - provided. - - - + + The help functionality accepts the + following options: + - - - - - Assume yes to all confirmation requests. - - - + + + + + + Supress all output messages except error messages. When this + option is passed, all confirmation requests are supressed as + well and a possitive answer is assumed for them, just as if + the option had been provided. + + + - - - - - Supress all commit and update actions realized over - files, before and after the action itself had took - place over files in the working copy. - - - + + + + + Assume yes to all confirmation requests. + + + - - - - - Specify STRING as - default documentation backend to use. Possible - arguments to this options are: - texinfo - or docbook. If this option is not - provided, texinfo is used as - default documentation backend. - - - + + + + + Supress all commit and update actions realized over files, + before and after the action itself had took place over files + in the working copy. + + + - - - - - Go to node pointed by index entry STRING. - - - + + + + + Specify STRING as default + documentation backend to use. Possible arguments to this + options are: texinfo or + docbook. If this option is not provided, + texinfo is used as default documentation + backend. + + + - - - - - Edit documentation entry related to path specified by - path/to/dir parameter. - - - The path/to/dir parameter must - point to any directory inside the repository. When - more than one path/to/dir are - passed as non-option arguments to the - centos-art.sh script command-line, - they are queued for further edition. The edition - itself takes place through your default text editor - (e.g., the one you specified in the - EDITOR environment variable) and the - text editor opens one file at time (i.e., the queue of - files to edit is not loaded in the text editor.). - - - + + + + + Go to node pointed by index entry STRING. + + + - - - - - Read documentation entry specified by - path/to/dir path. This option - is used internally by centos-art.sh - script to print out the reference you can follow to - know more about an error message. - - - + + + + + Edit documentation entry related to path specified by + path/to/dir parameter. + + + The path/to/dir parameter must point to + any directory inside the repository. When more than one + path/to/dir are passed as non-option + arguments to the centos-art.sh script + command-line, they are queued for further edition. The + edition itself takes place through your default text editor + (e.g., the one you specified in the EDITOR + environment variable) and the text editor opens one file at + time (i.e., the queue of files to edit is not loaded in the + text editor.). + + + - - - - - Update output files rexporting them from the specified - backend source files. - - - + + + + + Read documentation entry specified by + path/to/dir path. This option is used + internally by centos-art.sh script to print + out the reference you can follow to know more about an error + message. + + + - - - - - Duplicate documentation entries inside the working - copy of the repository. - - - When documentation entries are copied, it is required - to pass two non-option parameters in the command-line. - The first non-option parameter is considered the - source location and the second one the target - location. Both source location and target location - must point to a directory under the working copy. - - - + + + + + Update output files rexporting them from the specified backend + source files. + + + - - - - - Delete documentation entries specified by - path/to/dir inside the working - copy. It is possible to delete more than one - documentation entry by specifying more - path/to/dir parameters in the - command-line. - - - + + + + + Duplicate documentation entries inside the working copy of the + repository. + + + When documentation entries are copied, it is required to pass + two non-option parameters in the command-line. The first + non-option parameter is considered the source location and the + second one the target location. Both source location and + target location must point to a directory under the working + copy. + + + - - - - - Rename documentation entries inside the working copy. - - - When documentation entries are renamed, it is required - to pass only two non-option parameters to the - command-line. The first non-option parameter is - considered the source location and the second one the - target location. Both source location and target - location must point to a directory under the working - copy. - - - + + + + + Delete documentation entries specified by + path/to/dir inside the working copy. It + is possible to delete more than one documentation entry by + specifying more path/to/dir parameters + in the command-line. + + + - - + + + + + Rename documentation entries inside the working copy. + + + When documentation entries are renamed, it is required to pass + only two non-option parameters to the command-line. The first + non-option parameter is considered the source location and the + second one the target location. Both source location and + target location must point to a directory under the working + copy. + + + - - When documentation entries are removed (e.g., through - or - options), the help functionality - takes care of updating nodes, menus and cross references - related to documentation entries in order to keep the - manual structure in a correct state. - + + + When documentation entries are removed (e.g., through + or + options), the help functionality takes + care of updating nodes, menus and cross references related to + documentation entries in order to keep the manual structure in + a correct state. + - Examples + + + centos-art help --edit trunk/Identity + - - - centos-art help --edit trunk/Identity - - - This command edits the documentation entry related to - trunk/Identity - directory inside the repository working copy. - - - - - - centos-art help --read trunk/Identity - - - This command reads the documentation entry related to - trunk/Identity - directory inside the repository working copy. - - - + This command edits the documentation entry related to + trunk/Identity + directory inside the repository working copy. + + + - + + centos-art help --read trunk/Identity + + + This command reads the documentation entry related to + trunk/Identity + directory inside the repository working copy. + + + - - Author - - - Written by Alain Reguera Delgado. - - + Author + + Written by Alain Reguera Delgado. + - Reporting bugs - - Report bugs to centos-artwork@centos.org - mailing list. - + Reporting Bugs + + Report bugs to &TCAML;. + - Copyright - - Copyright © 2009, 2010, 2011 The CentOS Artwork SIG. - - - 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. - + 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. + diff --git a/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook b/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook index b643613..f49ebc0 100644 --- a/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook +++ b/Manuals/TCAR-UG/Docbook/Scripts/Bash/prepare.docbook @@ -1,7 +1,20 @@ + The <function>prepare</function> functionality + The prepare functionality is the + interface the centos-art.sh script provides + to standardize the final configuration stuff your workstation + needs, once the working copy of &TCAR; has been downloaded + 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 @@ -25,16 +38,157 @@ centos-art prepare [OPTIONS] - Notice that you can execute the prepare functionality more - than once. This is specially useful to keep the link - information syncronized. For example, considering you've added - new brushes to or removed old brushes from your working copy - of &TCAR;, the link information related to those files need to - be updated in the ~/.gimp-2.2/brushes directory - too, in a way the addition/deletion change that took place in - your working copy can be reflected there, as well. The same - is true for other similar components like fonts, patterns and - palettes. + The prepare functionality accepts the + following options: + + + + + + + + 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. + + + + + + + + + Assume yes to all confirmation requests. + + + + + + + + + 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 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 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 initializes image files inside the working copy. + 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 + different components inside the working copy. + + + + + + + + + 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. + + + + + + + + Print the name and value of some of the environment variables + used by centos-art.sh scripts. + + + + + + + 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. + + + + Notice that 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 + working copy and the applications you use outside it. For + example, considering you've added new brushes to or removed + old brushes from your working copy of &TCAR;, the link + information related to those files need to be updated in the + ~/.gimp-2.2/brushes + directory too, in a way the addition/deletion change that took + place in your working copy can be reflected there, as well. + 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. + + +