diff options
| author | merakor <cem@ckyln.com> | 2021-08-07 22:38:14 +0000 |
|---|---|---|
| committer | merakor <cem@ckyln.com> | 2021-08-07 22:38:14 +0000 |
| commit | 683c2f54835533c980db3e6741ed369bf899d610 (patch) | |
| tree | 2829db7b47543361b547191ba789ff7d6f7119eb /docs | |
| parent | ff0623f728912b3551496d5f79cf5b6500bd0635 (diff) | |
| download | cpt-683c2f54835533c980db3e6741ed369bf899d610.tar.gz | |
docs: update
FossilOrigin-Name: def88de1bebd59e59a529e36bc61e8da5cca0c389d23c8101ccdc07a4f077b51
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cpt.org | 8 | ||||
| -rw-r--r-- | docs/cpt.texi | 12 | ||||
| -rw-r--r-- | docs/cpt.txt | 10 |
3 files changed, 24 insertions, 6 deletions
diff --git a/docs/cpt.org b/docs/cpt.org index abdcd62..adf45f7 100644 --- a/docs/cpt.org +++ b/docs/cpt.org @@ -880,8 +880,12 @@ that can be used inside most =cpt= tools. It defines the following flags: | ~-v~ | ~--version~ | =version()= | | | ~--verbose~ | =CPT_VERBOSE= | -If you don't want these options to be printed on the usage, you can disable it -by calling ~global_options silent~ instead. +This function can take two arguments: + +- =silent= :: If this argument is specified, the function does not print the usage + information defined by its flags. +- =compact= :: If this argument is specified, the function only prints the help + output of the ~--help~ and ~--version~ flags. ** Message functions :PROPERTIES: diff --git a/docs/cpt.texi b/docs/cpt.texi index ab1df89..5ff1757 100644 --- a/docs/cpt.texi +++ b/docs/cpt.texi @@ -1058,8 +1058,16 @@ that can be used inside most @samp{cpt} tools. It defines the following flags: @tab @samp{CPT_VERBOSE} @end multitable -If you don't want these options to be printed on the usage, you can disable it -by calling @code{global_options silent} instead. +This function can take two arguments: + +@table @asis +@item @samp{silent} +If this argument is specified, the function does not print the usage +information defined by its flags. +@item @samp{compact} +If this argument is specified, the function only prints the help +output of the @code{--help} and @code{--version} flags. +@end table @node Message functions @section Message functions diff --git a/docs/cpt.txt b/docs/cpt.txt index ab99f4d..e965da7 100644 --- a/docs/cpt.txt +++ b/docs/cpt.txt @@ -933,8 +933,14 @@ development manual for *Carbs Packaging Tools*. For development logs see `-v' `--version' `version()' `--verbose' `CPT_VERBOSE' - If you don't want these options to be printed on the usage, you can - disable it by calling `global_options silent' instead. + This function can take two arguments: + + `silent' + If this argument is specified, the function does not print the + usage information defined by its flags. + `compact' + If this argument is specified, the function only prints the help + output of the `--help' and `--version' flags. 8.3 Message functions |