tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename help and documentation to icingacli. 

Refs #5802
This commit is contained in:
Michael Friedrich 2014-03-19 17:25:53 +01:00
parent 6d6d3c132f
commit 4ce7ea503f
9 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
application/clicommands/AutocompleteCommand.php
View File

@ -11,7 +11,7 @@ use Icinga\Cli\Loader;
* The autocomplete command shows help for a given command, module and also for a * The autocomplete command shows help for a given command, module and also for a
* given module's command or a specific command's action. * given module's command or a specific command's action.
* *
* Usage: icingaweb autocomplete [<module>] [<command> [<action>]] * Usage: icingacli autocomplete [<module>] [<command> [<action>]]
*/ */
class AutocompleteCommand extends Command class AutocompleteCommand extends Command
{ {
@ -36,7 +36,7 @@ class AutocompleteCommand extends Command
* The help command shows help for a given command, module and also for a * The help command shows help for a given command, module and also for a
* given module's command or a specific command's action. * given module's command or a specific command's action.
* *
* Usage: icingaweb autocomplete [<module>] [<command> [<action>]] * Usage: icingacli autocomplete [<module>] [<command> [<action>]]
*/ */
public function completeAction() public function completeAction()
{ {

4
application/clicommands/HelpCommand.php
View File

@ -12,7 +12,7 @@ use Icinga\Cli\Documentation;
* The help command shows help for a given command, module and also for a * The help command shows help for a given command, module and also for a
* given module's command or a specific command's action. * given module's command or a specific command's action.
* *
* Usage: icingaweb help [<module>] [<command> [<action>]] * Usage: icingacli help [<module>] [<command> [<action>]]
*/ */
class HelpCommand extends Command class HelpCommand extends Command
{ {
@ -24,7 +24,7 @@ class HelpCommand extends Command
* The help command shows help for a given command, module and also for a * The help command shows help for a given command, module and also for a
* given module's command or a specific command's action. * given module's command or a specific command's action.
* *
* Usage: icingaweb help [<module>] [<command> [<action>]] * Usage: icingacli help [<module>] [<command> [<action>]]
*/ */
public function showAction() public function showAction()
{ {

22
application/clicommands/ModuleCommand.php
View File

@ -9,7 +9,7 @@ use Icinga\Cli\Command;
* *
* The module command allows you to handle your IcingaWeb modules * The module command allows you to handle your IcingaWeb modules
* *
* Usage: icingaweb module [<action>] [<modulename>] * Usage: icingacli module [<action>] [<modulename>]
*/ */
class ModuleCommand extends Command class ModuleCommand extends Command
{ {
@ -27,7 +27,7 @@ class ModuleCommand extends Command
* even --installed) as a command parameter. If you enable --verbose even * even --installed) as a command parameter. If you enable --verbose even
* more details will be shown * more details will be shown
* *
* Usage: icingaweb module list [installed] [--verbose] * Usage: icingacli module list [installed] [--verbose]
*/ */
public function listAction() public function listAction()
{ {
@ -82,7 +82,7 @@ class ModuleCommand extends Command
/** /**
* Enable a given module * Enable a given module
* *
* Usage: icingaweb module enable <module-name> * Usage: icingacli module enable <module-name>
*/ */
public function enableAction() public function enableAction()
{ {
@ -98,7 +98,7 @@ class ModuleCommand extends Command
/** /**
* Disable a given module * Disable a given module
* *
* Usage: icingaweb module disable <module-name> * Usage: icingacli module disable <module-name>
*/ */
public function disableAction() public function disableAction()
{ {
@ -117,7 +117,7 @@ class ModuleCommand extends Command
* Asks each enabled module for all available restriction names and * Asks each enabled module for all available restriction names and
* descriptions and shows a quick overview * descriptions and shows a quick overview
* *
* Usage: icingaweb module restrictions * Usage: icingacli module restrictions
*/ */
public function restrictionsAction() public function restrictionsAction()
{ {
@ -141,7 +141,7 @@ class ModuleCommand extends Command
* Asks each enabled module for it's available permission names and * Asks each enabled module for it's available permission names and
* descriptions and shows a quick overview * descriptions and shows a quick overview
* *
* Usage: icingaweb module permissions * Usage: icingacli module permissions
*/ */
public function permissionsAction() public function permissionsAction()
{ {
@ -165,7 +165,7 @@ class ModuleCommand extends Command
* Does a lookup against your configured IcingaWeb app stores and tries to * Does a lookup against your configured IcingaWeb app stores and tries to
* find modules matching your search string * find modules matching your search string
* *
* Usage: icingaweb module search <search-string> * Usage: icingacli module search <search-string>
*/ */
public function searchAction() public function searchAction()
{ {
@ -177,8 +177,8 @@ class ModuleCommand extends Command
* *
* Downloads a given module or installes a module from a given archive * Downloads a given module or installes a module from a given archive
* *
* Usage: icingaweb module install <module-name> * Usage: icingacli module install <module-name>
* icingaweb module install </path/to/archive.tar.gz> * icingacli module install </path/to/archive.tar.gz>
*/ */
public function installAction() public function installAction()
{ {
@ -191,7 +191,7 @@ class ModuleCommand extends Command
* Removes the given module from your disk. Module configuration will be * Removes the given module from your disk. Module configuration will be
* preserved * preserved
* *
* Usage: icingaweb module remove <module-name> * Usage: icingacli module remove <module-name>
*/ */
public function removeAction() public function removeAction()
{ {
@ -204,7 +204,7 @@ class ModuleCommand extends Command
* Removes the given module from your disk. Also wipes configuration files * Removes the given module from your disk. Also wipes configuration files
* and other data stored and/or generated by this module * and other data stored and/or generated by this module
* *
* Usage: icingaweb module remove <module-name> * Usage: icingacli module remove <module-name>
*/ */
public function purgeAction() public function purgeAction()
{ {

12
library/Icinga/Cli/Documentation.php
View File

@ -32,7 +32,7 @@ class Documentation
public function globalUsage() public function globalUsage()
{ {
$d = "USAGE: icingaweb [module] <command> [action] [options]\n\n" $d = "USAGE: icingacli [module] <command> [action] [options]\n\n"
. "Available commands:\n\n"; . "Available commands:\n\n";
foreach ($this->loader->listCommands() as $command) { foreach ($this->loader->listCommands() as $command) {
if ($command !== 'autocomplete') { if ($command !== 'autocomplete') {
@ -55,8 +55,8 @@ class Documentation
. " --benchmark Show benchmark summary\n" . " --benchmark Show benchmark summary\n"
. " --watch [s] Refresh output each <s> seconds (default: 5)\n" . " --watch [s] Refresh output each <s> seconds (default: 5)\n"
; ;
$d .= "\nShow help on a specific command : icingaweb help <command>" $d .= "\nShow help on a specific command : icingacli help <command>"
. "\nShow help on a specific module : icingaweb help <module>" . "\nShow help on a specific module : icingacli help <module>"
. "\n"; . "\n";
return $d; return $d;
} }
@ -73,12 +73,12 @@ class Documentation
$obj = $this->loader->getModuleCommandInstance($module, $command); $obj = $this->loader->getModuleCommandInstance($module, $command);
} }
if ($command === null) { if ($command === null) {
$d = "USAGE: icingaweb $module <command> [<action>] [options]\n\n" $d = "USAGE: icingacli $module <command> [<action>] [options]\n\n"
. "Available commands:\n\n"; . "Available commands:\n\n";
foreach ($commands as $command) { foreach ($commands as $command) {
$d .= ' ' . $command . "\n"; $d .= ' ' . $command . "\n";
} }
$d .= "\nShow help on a specific command: icingaweb help $module <command>\n"; $d .= "\nShow help on a specific command: icingacli help $module <command>\n";
} elseif ($action === null) { } elseif ($action === null) {
$d .= $this->showCommandActions($obj, $command); $d .= $this->showCommandActions($obj, $command);
} else { } else {
@ -100,7 +100,7 @@ class Documentation
$this->getMethodTitle($command, $action) $this->getMethodTitle($command, $action)
); );
} }
$d .= "\nShow help on a specific action: icingaweb help $name <action>\n"; $d .= "\nShow help on a specific action: icingacli help $name <action>\n";
return $d; return $d;
} }

2
modules/monitoring/application/clicommands/ConferenceCommand.php
View File

@ -19,7 +19,7 @@ class ConferenceCommand extends Command
* Use this command in case you feel that you should be friendly. Should * Use this command in case you feel that you should be friendly. Should
* be executed as follows: * be executed as follows:
* *
* icingaweb monitoring conference welcome --watch 1 * icingacli monitoring conference welcome --watch 1
*/ */
public function welcomeAction() public function welcomeAction()
{ {

8
modules/monitoring/application/clicommands/ListCommand.php
View File

@ -114,7 +114,7 @@ class ListCommand extends Command
* *
* USAGE * USAGE
* *
* icingaweb monitoring list [<type>] [options] * icingacli monitoring list [<type>] [options]
* *
* OPTIONS * OPTIONS
* *
@ -131,9 +131,9 @@ class ListCommand extends Command
* *
* EXAMPLES * EXAMPLES
* *
* icingaweb monitoring list --unhandled * icingacli monitoring list --unhandled
* icingaweb monitoring list --host local* --service *disk* * icingacli monitoring list --host local* --service *disk*
* icingaweb monitoring list --format '$host$: $service$' * icingacli monitoring list --format '$host$: $service$'
*/ */
public function statusAction() public function statusAction()
{ {

4
modules/monitoring/application/clicommands/NrpeCommand.php
View File

@ -22,11 +22,11 @@ class NrpeCommand extends Command
* *
* USAGE * USAGE
* *
* icingaweb monitoring nrpe <host> <command> [--ssl] [nrpe options] * icingacli monitoring nrpe <host> <command> [--ssl] [nrpe options]
* *
* EXAMPLE * EXAMPLE
* *
* icingaweb monitoring nrpe 127.0.0.1 CheckMEM --ssl --MaxWarn 80% \ * icingacli monitoring nrpe 127.0.0.1 CheckMEM --ssl --MaxWarn 80% \
* --MaxCrit 90% --type physical * --MaxCrit 90% --type physical
*/ */
public function checkAction() public function checkAction()

12
modules/translation/application/clicommands/CompileCommand.php
View File

@ -53,12 +53,12 @@ class CompileCommand extends TranslationCommand
* *
* USAGE: * USAGE:
* *
* icingaweb translation compile icinga <locale> * icingacli translation compile icinga <locale>
* *
* EXAMPLES: * EXAMPLES:
* *
* icingaweb translation compile icinga de_DE * icingacli translation compile icinga de_DE
* icingaweb translation compile icinga fr_FR * icingacli translation compile icinga fr_FR
*/ */
public function icingaAction() public function icingaAction()
{ {
@ -75,12 +75,12 @@ class CompileCommand extends TranslationCommand
* *
* USAGE: * USAGE:
* *
* icingaweb translation compile <module> <locale> * icingacli translation compile <module> <locale>
* *
* EXAMPLES: * EXAMPLES:
* *
* icingaweb translation compile monitoring de_DE * icingacli translation compile monitoring de_DE
* icingaweb trnslations compile monitoring de_DE * icingacli trnslations compile monitoring de_DE
*/ */
public function moduleAction() public function moduleAction()
{ {

12
modules/translation/application/clicommands/RefreshCommand.php
View File

@ -53,12 +53,12 @@ class RefreshCommand extends TranslationCommand
* *
* USAGE: * USAGE:
* *
* icingaweb translation refresh icinga <locale> * icingacli translation refresh icinga <locale>
* *
* EXAMPLES: * EXAMPLES:
* *
* icingaweb translation refresh icinga de_DE * icingacli translation refresh icinga de_DE
* icingaweb translation refresh icinga fr_FR * icingacli translation refresh icinga fr_FR
*/ */
public function icingaAction() public function icingaAction()
{ {
@ -75,12 +75,12 @@ class RefreshCommand extends TranslationCommand
* *
* USAGE: * USAGE:
* *
* icingaweb translation refresh module <module> <locale> * icingacli translation refresh module <module> <locale>
* *
* EXAMPLES: * EXAMPLES:
* *
* icingaweb translation refresh module monitoring de_DE * icingacli translation refresh module monitoring de_DE
* icingaweb translation refresh module monitoring fr_FR * icingacli translation refresh module monitoring fr_FR
*/ */
public function moduleAction() public function moduleAction()
{ {