diff --git a/Manuals/en/Html/Repository/repository_40.html b/Manuals/en/Html/Repository/repository_40.html index 83ed270..733600c 100644 --- a/Manuals/en/Html/Repository/repository_40.html +++ b/Manuals/en/Html/Repository/repository_40.html @@ -735,10 +735,46 @@ function, and occasionally, farther redefined (by

-
Function: cli_getActionArguments +
Function: cli_getActionArguments [$@]
-
+

Initialize function name (FUNCNAM), action name +(ACTIONNAM), and action value (ACTIONVAL) global +variables, using positional parameters passed in $@ variable. +

+

The cli_getActionsArguments function is called from +cli.sh function script. The cli_getActionsArguments +function is call from cli.sh function script using cli +function positional parameters (i.e., the positional parameters passed +as arguments in the command-line) as first function argument. +

+

Once command-line positional parameters are accesible, +cli-getActionsArguments uses regular expression to retrive +action variables from first and second argument. The first argument +defines the value use as function name (FUNCNAM), and the second +argument defines the value used as action name (ACTIONNAM) and +action value (ACTIONVAL), respectively. +

+

The first argument is a word in lower case. This word specifies the +name of the functionality you want to use (e.g., `render' to +rener images, `manual' to work on documentation, and so on.) +

+

The second argument has a long option style (e.g., +`--option=value'). The `--option' represents the action name +(ACTIONNAM), and the characters after the equal sign (`='), +and before the first space character, are considered as the action +value (ACTIONVAL). In order to provide action values with space +characters you need to enclose it with quotes like in +`--option='This is long value''. Generally, action values are +used to specify paths over which the action name acts on. +

+

Once action related variables (i.e., FUNCNAM, ACTIONNAM, +and ACTIONVAL) are defined and validated, +cli_getActionsArguments shifts the positional arguments to +remove the first two arguments passed (i.e., those one used to retrive +action related variables) and redefine the arguments (ARGUMENTS) +global variable with the new positional parameters information. +

Function: cli_getActionBuild diff --git a/Manuals/en/Info/Repository/repository.info.bz2 b/Manuals/en/Info/Repository/repository.info.bz2 index f095098..0d67d95 100644 Binary files a/Manuals/en/Info/Repository/repository.info.bz2 and b/Manuals/en/Info/Repository/repository.info.bz2 differ diff --git a/Manuals/en/Plaintext/Repository/repository.txt b/Manuals/en/Plaintext/Repository/repository.txt index 13a4f1b..fb6f37a 100644 --- a/Manuals/en/Plaintext/Repository/repository.txt +++ b/Manuals/en/Plaintext/Repository/repository.txt @@ -3361,7 +3361,43 @@ introductory information to global functions you can use inside function, and occasionally, farther redefined (by `cli_doParseArgumentsReDef') as far as it may be convenient. - -- Function: cli_getActionArguments + -- Function: cli_getActionArguments [$@] + Initialize function name (FUNCNAM), action name (ACTIONNAM), and + action value (ACTIONVAL) global variables, using positional + parameters passed in $@ variable. + + The `cli_getActionsArguments' function is called from `cli.sh' + function script. The `cli_getActionsArguments' function is call + from `cli.sh' function script using `cli' function positional + parameters (i.e., the positional parameters passed as arguments in + the command-line) as first function argument. + + Once command-line positional parameters are accesible, + `cli-getActionsArguments' uses regular expression to retrive + action variables from first and second argument. The first argument + defines the value use as function name (FUNCNAM), and the second + argument defines the value used as action name (ACTIONNAM) and + action value (ACTIONVAL), respectively. + + The first argument is a word in lower case. This word specifies the + name of the functionality you want to use (e.g., `render' to rener + images, `manual' to work on documentation, and so on.) + + The second argument has a long option style (e.g., + `--option=value'). The `--option' represents the action name + (ACTIONNAM), and the characters after the equal sign (`='), and + before the first space character, are considered as the action + value (ACTIONVAL). In order to provide action values with space + characters you need to enclose it with quotes like in + `--option='This is long value''. Generally, action values are used + to specify paths over which the action name acts on. + + Once action related variables (i.e., FUNCNAM, ACTIONNAM, and + ACTIONVAL) are defined and validated, `cli_getActionsArguments' + shifts the positional arguments to remove the first two arguments + passed (i.e., those one used to retrive action related variables) + and redefine the arguments (ARGUMENTS) global variable with the + new positional parameters information. -- Function: cli_getActionBuild @@ -6009,24 +6045,24 @@ Index ***** branches: See 1. (line 390) -Common translation files: See 3.50.2.5. (line 5438) -How to render brands' translation files: See 3.52.3. (line 5742) -How to render fonts' translation files: See 3.54.3. (line 5815) -How to render translation files: See 3.50.3. (line 5608) -Metadata maintainance: See 3.45.2. (line 4582) -Specific translation files: See 3.50.2.6. (line 5463) +Common translation files: See 3.50.2.5. (line 5474) +How to render brands' translation files: See 3.52.3. (line 5778) +How to render fonts' translation files: See 3.54.3. (line 5851) +How to render translation files: See 3.50.3. (line 5644) +Metadata maintainance: See 3.45.2. (line 4618) +Specific translation files: See 3.50.2.6. (line 5499) tags: See 2. (line 393) -Template translation files: See 3.50.2.4. (line 5268) -Translation brands file names: See 3.52.2.1. (line 5699) -Translation configuration scripts: See 3.50.2.8. (line 5497) -Translation entries: See 3.50.2.1. (line 5084) -Translation files: See 3.50.2.3. (line 5200) -Translation markers: See 3.50.2.2. (line 5165) -Translation paths: See 3.50.2.1. (line 5084) +Template translation files: See 3.50.2.4. (line 5304) +Translation brands file names: See 3.52.2.1. (line 5735) +Translation configuration scripts: See 3.50.2.8. (line 5533) +Translation entries: See 3.50.2.1. (line 5120) +Translation files: See 3.50.2.3. (line 5236) +Translation markers: See 3.50.2.2. (line 5201) +Translation paths: See 3.50.2.1. (line 5120) Translation pre-rendering configuration scripts:See 3.50.2.8. - (line 5497) -Translation rendering: See 3.50.2.7. (line 5486) -Translation rendering default functionality: See 3.50.2.9. (line 5583) + (line 5533) +Translation rendering: See 3.50.2.7. (line 5522) +Translation rendering default functionality: See 3.50.2.9. (line 5619) trunk: See 3. (line 396) trunk Identity: See 3.1. (line 399) trunk Identity Brands: See 3.2. (line 819) @@ -6071,31 +6107,31 @@ trunk Manuals: See 3.34. (line 2579) trunk Scripts: See 3.35. (line 2633) trunk Scripts Bash: See 3.36. (line 2657) trunk Scripts Bash Functions: See 3.37. (line 2769) -trunk Scripts Bash Functions Html: See 3.38. (line 3673) -trunk Scripts Bash Functions Locale: See 3.39. (line 3694) -trunk Scripts Bash Functions Manual: See 3.40. (line 3774) -trunk Scripts Bash Functions Path: See 3.41. (line 3795) -trunk Scripts Bash Functions Render: See 3.42. (line 4197) -trunk Scripts Bash Functions Render Config: See 3.43. (line 4218) -trunk Scripts Bash Functions Shell: See 3.44. (line 4396) -trunk Scripts Bash Functions Svg: See 3.45. (line 4564) -trunk Scripts Bash Functions Verify: See 3.46. (line 4752) -trunk Scripts Bash Locale: See 3.47. (line 4968) -trunk Scripts Perl: See 3.48. (line 4997) -trunk Scripts Python: See 3.49. (line 5014) -trunk Translations: See 3.50. (line 5035) -trunk Translations Identity: See 3.51. (line 5637) -trunk Translations Identity Brands: See 3.52. (line 5658) -trunk Translations Identity Brands Tpl: See 3.53. (line 5753) -trunk Translations Identity Fonts: See 3.54. (line 5768) -trunk Translations Identity Models: See 3.55. (line 5831) -trunk Translations Identity Release: See 3.56. (line 5846) -trunk Translations Identity Themes: See 3.57. (line 5861) -trunk Translations Identity Themes Backgrounds:See 3.58. (line 5876) +trunk Scripts Bash Functions Html: See 3.38. (line 3709) +trunk Scripts Bash Functions Locale: See 3.39. (line 3730) +trunk Scripts Bash Functions Manual: See 3.40. (line 3810) +trunk Scripts Bash Functions Path: See 3.41. (line 3831) +trunk Scripts Bash Functions Render: See 3.42. (line 4233) +trunk Scripts Bash Functions Render Config: See 3.43. (line 4254) +trunk Scripts Bash Functions Shell: See 3.44. (line 4432) +trunk Scripts Bash Functions Svg: See 3.45. (line 4600) +trunk Scripts Bash Functions Verify: See 3.46. (line 4788) +trunk Scripts Bash Locale: See 3.47. (line 5004) +trunk Scripts Perl: See 3.48. (line 5033) +trunk Scripts Python: See 3.49. (line 5050) +trunk Translations: See 3.50. (line 5071) +trunk Translations Identity: See 3.51. (line 5673) +trunk Translations Identity Brands: See 3.52. (line 5694) +trunk Translations Identity Brands Tpl: See 3.53. (line 5789) +trunk Translations Identity Fonts: See 3.54. (line 5804) +trunk Translations Identity Models: See 3.55. (line 5867) +trunk Translations Identity Release: See 3.56. (line 5882) +trunk Translations Identity Themes: See 3.57. (line 5897) +trunk Translations Identity Themes Backgrounds:See 3.58. (line 5912) trunk Translations Identity Themes Distro Anaconda Progress:See 3.59. - (line 5897) -trunk Translations Identity Widgets: See 3.60. (line 5990) -Unused definitions: See 3.45.2.1. (line 4689) + (line 5933) +trunk Translations Identity Widgets: See 3.60. (line 6026) +Unused definitions: See 3.45.2.1. (line 4725) List of Figures *************** diff --git a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi index ae7bec1..83b8026 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi @@ -631,7 +631,44 @@ function, and occasionally, farther redefined (by @code{cli_doParseArgumentsReDef}) as far as it may be convenient. @end defun -@defun cli_getActionArguments +@defun cli_getActionArguments [$@@] + +Initialize function name (@var{FUNCNAM}), action name +(@var{ACTIONNAM}), and action value (@var{ACTIONVAL}) global +variables, using positional parameters passed in @var{$@@} variable. + +The @code{cli_getActionsArguments} function is called from +@code{cli.sh} function script. The @code{cli_getActionsArguments} +function is call from @code{cli.sh} function script using @code{cli} +function positional parameters (i.e., the positional parameters passed +as arguments in the command-line) as first function argument. + +Once command-line positional parameters are accesible, +@code{cli-getActionsArguments} uses regular expression to retrive +action variables from first and second argument. The first argument +defines the value use as function name (@var{FUNCNAM}), and the second +argument defines the value used as action name (@var{ACTIONNAM}) and +action value (@var{ACTIONVAL}), respectively. + +The first argument is a word in lower case. This word specifies the +name of the functionality you want to use (e.g., @samp{render} to +rener images, @samp{manual} to work on documentation, and so on.) + +The second argument has a long option style (e.g., +@samp{--option=value}). The @samp{--option} represents the action name +(@var{ACTIONNAM}), and the characters after the equal sign (@samp{=}), +and before the first space character, are considered as the action +value (@var{ACTIONVAL}). In order to provide action values with space +characters you need to enclose it with quotes like in +@samp{--option='This is long value'}. Generally, action values are +used to specify paths over which the action name acts on. + +Once action related variables (i.e., @var{FUNCNAM}, @var{ACTIONNAM}, +and @var{ACTIONVAL}) are defined and validated, +@code{cli_getActionsArguments} shifts the positional arguments to +remove the first two arguments passed (i.e., those one used to retrive +action related variables) and redefine the arguments (@var{ARGUMENTS}) +global variable with the new positional parameters information. @end defun @defun cli_getActionBuild