From 541cb9c1cc92a545ba52ba14d71b0eed93afa845 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 20 2011 22:53: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 5169c6c..9719af5 100644 --- a/Manuals/Tcar-ug/Scripts/Bash/help.docbook +++ b/Manuals/Tcar-ug/Scripts/Bash/help.docbook @@ -1,12 +1,13 @@ - Standardize Documentation Tasks + Standardizing Documentation Tasks The help functionality is the interface the centos-art.sh script provides to standardize frequent documentation tasks, based on specific - documentation backends described in . + documentation formats, as described in . @@ -27,6 +28,17 @@ + To determine the documentation format to use, when new + documentation manuals are created and no configuration file is + available, the help functionality request + you to enter one of the supported documentation formats and + then, uses it to create the documentation manual. Once the + documentation manual is created, the document configuration + file is available inside the manual directory structure and + used to retrive the document format information, instead. + + + The help functionality accepts the following options: @@ -103,9 +115,9 @@ Read documentation entry specified by 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. + internally by centos-art.sh script to refer + documentation based on errors, so you can know more about them + and the causes that could have provoked them.