From ba86a3c604fc9b12f574ea3d33b1f8174624dfd6 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Aug 10 2011 03:26:14 +0000 Subject: Update `Scripts/Bash/help.docbook'. --- diff --git a/Manuals/Tcar-ug/Scripts/Bash/help.docbook b/Manuals/Tcar-ug/Scripts/Bash/help.docbook index bb8181a..041f4d5 100644 --- a/Manuals/Tcar-ug/Scripts/Bash/help.docbook +++ b/Manuals/Tcar-ug/Scripts/Bash/help.docbook @@ -5,24 +5,25 @@ The help functionality is the interface the centos-art.sh script provides to - control frequent documentation tasks (e.g., reading, editing, - update output files, etc.) requied by specific documentation - backends. Documentation backends supported by - help functionality are described in . + standardize frequent documentation tasks, based on specific + documentation backends described in . - centos-art help [OPTIONS] [DIRECTORY] + + centos-art help [OPTIONS] [DOCENTRY] + - 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. + The DOCENTRY parameter specifies the + documentation entry you want to process. It can be provided + one or more times in the form + MANUAL:PART:CHAPTER:SECTION or + MANUAL::CHAPTER:SECTION based on whether the + manual documentation backend you are using supports + structuring through parts or not. When + DOCENTRY parameter is not provided, the + Repository File System documentation manual is + used as default value. @@ -64,28 +65,12 @@ - - - - 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. - - - - - - + - 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. + This option looks for KEYWORD inside the + manual specified in the documentation entry and display + related information you to read. @@ -95,12 +80,12 @@ Edit documentation entry related to path specified by - DIRECTORY parameter. + DOCENTRY parameter. - The DIRECTORY parameter must point to any + The DOCENTRY parameter must point to any directory inside the working copy. When more than one - DIRECTORY are passed as non-option + DOCENTRY 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 @@ -117,7 +102,7 @@ Read documentation entry specified by - DIRECTORY path. This option is used + DOCENTRY 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. @@ -157,9 +142,9 @@ Delete documentation entries specified by - DIRECTORY inside the working copy. It is + DOCENTRY inside the working copy. It is possible to delete more than one documentation entry by - specifying more DIRECTORY parameters in the + specifying more DOCENTRY parameters in the command-line.