From 286371c9b90edbdb82ab8c02f8b201422fb81513 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 29 2012 22:50:46 +0000 Subject: Update `Scripts/Bash/funref.docbook' file. --- diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook index 437a389..8a9f7de 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook @@ -224,11 +224,12 @@ The cli_printMessage function requires - two arguments. The first argument specifies the MESSAGE you - want to print and the second argument specifies the FORMAT - you'll use to print that message. Because this function is so - used inside the centos-art.sh script, it is convenient to - provide localization to strings passed as MESSAGE using + two arguments. The first argument specifies the + MESSAGE you want to print and the + second argument specifies the FORMAT you'll use to print that + message. Because this function is so used inside the + centos-art.sh script, it is convenient to provide localization + to strings passed as MESSAGE using gettext contructions when they aren't paths. @@ -243,10 +244,10 @@ - This format takes the first character passed as MESSAGE and - repeats it horizontally to build a separator line. Use this - format whenever you need to create a logical separation - between different actions. + This format takes the first character passed as + MESSAGE and repeats it horizontally + to build a separator line. Use this format whenever you need + to create a logical separation between different actions. @@ -255,10 +256,10 @@ - This format takes the string passed as MESSAGE and puts it - inside two horizontal separator lines. Use this format - whenever you need to print header information for following - lines. + This format takes the string passed as + MESSAGE and puts it inside two + horizontal separator lines. Use this format whenever you need + to print header information for following lines. @@ -267,10 +268,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been cropped. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been cropped. @@ -279,7 +280,8 @@ - This format is for two columns messages where MESSAGE + This format is for two columns messages where + MESSAGE generally refers to a file inside the repository. Use this format whenever you need to imply the fact that certain file has been tuned-up. @@ -290,11 +292,12 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been checked or verified (e.g., through - cli_checkFiles functionality). + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been checked or verified + (e.g., through cli_checkFiles + functionality). @@ -302,10 +305,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been combined. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been combined. @@ -313,10 +316,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been created. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been created. @@ -324,10 +327,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been read. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been read. @@ -335,10 +338,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been saved. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been saved. @@ -346,10 +349,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been linked. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been linked. @@ -357,10 +360,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been moved. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been moved. @@ -368,10 +371,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - has been validated. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file has been validated. @@ -379,10 +382,11 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - is a template or design model. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file is a template or design + model. @@ -390,10 +394,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - is a configuration file. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file is a configuration file. @@ -401,10 +405,10 @@ - This format is for two columns messages where MESSAGE - generally refers to a file inside the repository. Use this - format whenever you need to imply the fact that certain file - is a palette of colors. + This format is for two columns messages where + MESSAGE generally refers to a file + inside the repository. Use this format whenever you need to + imply the fact that certain file is a palette of colors. @@ -413,11 +417,11 @@ This format adds --> at the begining of the - string passed as MESSAGE. Use this format whenever you need - to imply the fact that certain file is considered part of a - response. For example, when you need to express that a group - of files will take ceratin action, you can use this option to - doing so. + string passed as MESSAGE. Use this + format whenever you need to imply the fact that certain file + is considered part of a response. For example, when you need + to express that a group of files will take ceratin action, you + can use this option to doing so. @@ -425,9 +429,9 @@ - This format prints MESSAGE without trailing new line. Use - this format whenever you need to imply a question or yes or no - request. + This format prints MESSAGE without + trailing new line. Use this format whenever you need to imply + a question or yes or no request. @@ -435,9 +439,10 @@ - This format uses each word in MESSAGE as item of a selection + This format uses each word in + MESSAGE as item of a selection list. Use this format whenever you need to select one of the - items provided as MESSAGE. + items provided as MESSAGE. @@ -457,10 +462,11 @@ - This format takes a function name as MESSAGE and prints the - command you can use to find more information about it. When - this option is passed the script finishes its execution - immediately. This option is used in combination with + This format takes a function name as + MESSAGE and prints the command you + can use to find more information about it. When this option is + passed the script finishes its execution immediately. This + option is used in combination with to finish the script execution after an error. @@ -471,7 +477,8 @@ - This format takes a question as MESSAGE and reads a yes or no + This format takes a question as + MESSAGE and reads a yes or no answer. When answer is negative, the script finishes its execution immediately. When answer is affirmative, the script continues its execution normally. @@ -483,7 +490,8 @@ - Print MESSAGE without any trailing newline. + Print MESSAGE without any trailing + newline. @@ -492,7 +500,7 @@ - Print MESSAGE to standard output. + Print MESSAGE to standard output. @@ -501,7 +509,8 @@ - Print MESSAGE to standard error output. + Print MESSAGE to standard error + output.