Documentation: use command line arguments in the format --arg=<value>

refs #8472
Icinga · Jun 10, 2015 · 98b2699 · 98b2699
1 parent 392047b
commit 98b2699
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/modules/monitoring/application/clicommands/ConferenceCommand.php b/modules/monitoring/application/clicommands/ConferenceCommand.php
@@ -20,7 +20,7 @@ class ConferenceCommand extends Command
      * Use this command in case you feel that you should be friendly. Should
      * be executed as follows:
      *
-     * icingacli monitoring conference welcome --watch 1
+     * icingacli monitoring conference welcome --watch=1
      */
     public function welcomeAction()
     {

diff --git a/modules/monitoring/application/clicommands/ListCommand.php b/modules/monitoring/application/clicommands/ListCommand.php
@@ -124,19 +124,19 @@ protected function showFormatted($query, $format, $columns)
      *   --verbose  Show detailled output
      *   --showsql  Dump generated SQL query (DB backend only)
      *
-     *   --format <csv|json|<custom>>
+     *   --format=<csv|json|<custom>>
      *     Dump columns in the given format. <custom> format allows $column$
-     *     placeholders, e.g. --format '$host$: $service$'
+     *     placeholders, e.g. --format='$host$: $service$'
      *
-     *   --<column> [filter]
+     *   --<column>[=filter]
      *     Filter given column by optional filter. Boolean (1/0) columns are
      *     true if no filter value is given.
      *
      * EXAMPLES
      *
      *   icingacli monitoring list --unhandled
-     *   icingacli monitoring list --host local* --service *disk*
-     *   icingacli monitoring list --format '$host$: $service$'
+     *   icingacli monitoring list --host=local* --service=*disk*
+     *   icingacli monitoring list --format='$host$: $service$'
      */
     public function statusAction()
     {

diff --git a/modules/monitoring/application/clicommands/NrpeCommand.php b/modules/monitoring/application/clicommands/NrpeCommand.php
@@ -27,8 +27,8 @@ class NrpeCommand extends Command
      *
      * EXAMPLE
      *
-     * icingacli monitoring nrpe 127.0.0.1 CheckMEM --ssl --MaxWarn 80% \
-     *   --MaxCrit 90% --type physical
+     * icingacli monitoring nrpe 127.0.0.1 CheckMEM --ssl --MaxWarn=80% \
+     *   --MaxCrit=90% --type=physical
      */
     public function checkAction()
     {

diff --git a/modules/setup/application/clicommands/ConfigCommand.php b/modules/setup/application/clicommands/ConfigCommand.php
@@ -29,7 +29,7 @@ class ConfigCommand extends Command
      *
      *  icingacli setup config directory
      *
-     *  icingacli setup config directory --mode 2775 --config /opt/icingaweb2/etc
+     *  icingacli setup config directory --mode=2775 --config=/opt/icingaweb2/etc
      */
     public function directoryAction()
     {
@@ -96,7 +96,7 @@ public function directoryAction()
      *
      *  --path=<urlpath>                    The URL path to Icinga Web 2 [/icingaweb2]
      *
-     *  --root/--document-root=<directory>  The directory from which the webserver will serve files [/path/to/icingaweb2/public]
+     *  --root|--document-root=<directory>  The directory from which the webserver will serve files [/path/to/icingaweb2/public]
      *
      *  --config=<directory>                Path to Icinga Web 2's configuration files [/etc/icingaweb2]
      *
@@ -106,9 +106,9 @@ public function directoryAction()
      *
      *  icingacli setup config webserver apache
      *
-     *  icingacli setup config webserver apache --path /icingaweb2 --document-root /usr/share/icingaweb2/public --config=/etc/icingaweb2
+     *  icingacli setup config webserver apache --path=/icingaweb2 --document-root=/usr/share/icingaweb2/public --config=/etc/icingaweb2
      *
-     *  icingacli setup config webserver apache --file /etc/apache2/conf.d/icingaweb2.conf
+     *  icingacli setup config webserver apache --file=/etc/apache2/conf.d/icingaweb2.conf
      *
      *  icingacli setup config webserver nginx
      */

diff --git a/modules/test/application/clicommands/PhpCommand.php b/modules/test/application/clicommands/PhpCommand.php
@@ -41,7 +41,7 @@ class PhpCommand extends Command
      *
      *   icingacli test php unit --verbose
      *   icingacli test php unit --build
-     *   icingacli test php unit --include *SpecialTest
+     *   icingacli test php unit --include=*SpecialTest
      */
     public function unitAction()
     {
@@ -109,8 +109,8 @@ public function unitAction()
      *
      *   icingacli test php style --verbose
      *   icingacli test php style --build
-     *   icingacli test php style --include path/to/your/file
-     *   icingacli test php style --exclude *someFile* --exclude someOtherFile*
+     *   icingacli test php style --include=path/to/your/file
+     *   icingacli test php style --exclude=*someFile* --exclude=someOtherFile*
      */
     public function styleAction()
     {