From 89114cd081aef287b9406bfae03f790df90ae800 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jul 09 2011 23:19:54 +0000 Subject: Update Docbook/Scripts/Bash/help.docbook. --- diff --git a/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook b/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook index 3bdf04a..c40870b 100644 --- a/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook +++ b/Manuals/TCAR-UG/Docbook/Scripts/Bash/help.docbook @@ -1,6 +1,7 @@ - The <function>help</function> functionality + <function>help</function> — Standardize Documentation + Tasks The help functionality is the interface @@ -12,15 +13,17 @@ linkend="doc"/>. - - Synopsis - centos-art help [OPTIONS] path/to/dir ... + centos-art help [OPTIONS] [DIRECTORY] + - 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 DIRECTORY parameter specifies the + directory path, inside the working copy of &TCAR;, where the + files you want to process the related documentation entry for. + This paramter can be provided more than once in order to + process more than one directory path in a single command + execution or not provided at all. When this parameter is not + provided, the current directory path where the command was + called from is used instead. @@ -34,9 +37,9 @@ 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. + option is passed, all confirmation requests are supressed and + a possitive answer is assumed for them, just as if the + option would have been provided. @@ -62,12 +65,12 @@ - + - Specify STRING as default - documentation backend to use. Possible arguments to this - options are: texinfo or + The NAME argument in this option specifies + what backend to use when processing documentation. Possible + arguments to this options are: texinfo or docbook. If this option is not provided, texinfo is used as default documentation backend. @@ -76,10 +79,14 @@ - + - Go to node pointed by index entry STRING. + Go to node pointed by ID argument. When + texinfo backend is used, this arguments refers the node you + want to read documentation for. When docbook backend is used, + this argument refers the section id you want to read + documentation for. @@ -89,12 +96,12 @@ Edit documentation entry related to path specified by - path/to/dir parameter. + DIRECTORY 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 + The DIRECTORY parameter must point to any + directory inside the working copy. When more than one + DIRECTORY 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 @@ -111,7 +118,7 @@ Read documentation entry specified by - path/to/dir path. This option is used + DIRECTORY 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. @@ -133,8 +140,7 @@ - Duplicate documentation entries inside the working copy of the - repository. + Duplicate documentation entries inside the working copy. When documentation entries are copied, it is required to pass @@ -152,10 +158,10 @@ 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. + DIRECTORY inside the working copy. It is + possible to delete more than one documentation entry by + specifying more DIRECTORY parameters in the + command-line. @@ -185,62 +191,7 @@ 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 - - - 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. - - - - - 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. + a consistent state. -