diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook index c2e59ee..85333a5 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook @@ -20,6 +20,7 @@ --quiet --answer-yes --sync-changes + --format="KEYWORD" --search="KEYWORD" --edit --read @@ -51,7 +52,7 @@ The documentation entry identifies the specific file you want to work with inside a documentation manual. The help functionality recognizes documentation entries in the - following two formats: + following formats: @@ -132,24 +133,6 @@ - - Supported Documentation Formats - - - The help functionality provides support - for the following documentation formats: - - - - - - Texinfo, as described in . - - - - - - @@ -182,12 +165,65 @@ + + + + Specifies the format of documentation entry source file. This + information is used as reference to build the absolute path of + documentation entry, so you always have to provide it in order + to reach the documentation entry you want to work with. + Possible values for this option are shown in in . + + + Documentation formats + + + + Keyword + Description + Supported + + + + + + texinfo + + Yes + + + docbook + + No + + + latex + + No + + + linuxdoc + ... + No + + + + +
+
+
+ + - This option looks for KEYWORD - inside the documentation entry you provide and displays the - related information for you to read. + Looks for documentation entries that match the + KEYWORD specified as value and + display them one by one in the order they were found. The way + each documentation entry is presented to you depends on the + documentation format the related documentation manual was + written on. @@ -196,18 +232,11 @@ - Edit documentation entry. - - - The documentation entry must point to any directory inside the - working copy. When more than one documentation entry is - 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.). + Edit the documentation entry provided as argument. The + edition itself takes place through your default text editor + (e.g., the one you specified in the EDITOR + environment variable) one file at a time (i.e., the queue of + files to edit is not loaded in the text editor.). @@ -216,10 +245,10 @@ - Read documentation entry. This option is used 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. + Read the documentation entry provided as argument. This + option is used 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. @@ -308,14 +337,14 @@ Examples - New Document Structures + Creating Document Structures To create new documentation manuals inside &TCAR; use the following command: - centos-art help --edit "manual" + centos-art help --edit "manual:::" @@ -354,7 +383,7 @@ - Copying Document Structure + Copying Document Structures To copy one documentation entry, use the following command: @@ -369,7 +398,7 @@ - Deleting Document Structure + Deleting Document Structures To delete one documentation entry, use the following command: @@ -382,7 +411,7 @@ - Renaming Document Structure + Renaming Document Structures To rename one documentation entry, use the following command: @@ -390,18 +419,42 @@ centos-art help --copy "manual:part:chapter:section" "manual:part:chapter:section" + + + ... + - - Updating Document Structure + + Updating Document Structures To update the document structure of one manual, use the following command: - centos-art help --update-structure "manual" + centos-art help --update-structure "manual:part:chapter:section" + + + + ... + + + + + Updating Document Final Outputs + + To update the document final outputs of one manual, use the + following command: + + + + centos-art help --update-output "manual:::" + + + ... +