diff options
author | Frédéric Guillot <fred@kanboard.net> | 2017-12-15 11:24:35 -0800 |
---|---|---|
committer | Frédéric Guillot <fred@kanboard.net> | 2017-12-15 11:55:42 -0800 |
commit | a93b8e10f5954be0853eec693c13e84c4bd9e6f2 (patch) | |
tree | eda5de9494b819235616e8623bb3393e9cc373af /vendor/symfony/console/Tests/Fixtures/application_1.md | |
parent | 2c72a283f2d51034f85f4e2ca8b194d304a3c433 (diff) |
Kanboard requires at least PHP 5.6 now
Diffstat (limited to 'vendor/symfony/console/Tests/Fixtures/application_1.md')
-rw-r--r-- | vendor/symfony/console/Tests/Fixtures/application_1.md | 165 |
1 files changed, 68 insertions, 97 deletions
diff --git a/vendor/symfony/console/Tests/Fixtures/application_1.md b/vendor/symfony/console/Tests/Fixtures/application_1.md index 82a605da..b46c975a 100644 --- a/vendor/symfony/console/Tests/Fixtures/application_1.md +++ b/vendor/symfony/console/Tests/Fixtures/application_1.md @@ -1,201 +1,172 @@ -UNKNOWN -======= +Console Tool +============ -* help -* list +* [`help`](#help) +* [`list`](#list) -help ----- +`help` +------ -* Description: Displays help for a command -* Usage: +Displays help for a command - * `help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]` +### Usage -The <info>help</info> command displays help for a given command: +* `help [--format FORMAT] [--raw] [--] [<command_name>]` - <info>php app/console help list</info> +The help command displays help for a given command: -You can also output the help in other formats by using the <comment>--format</comment> option: + php app/console help list - <info>php app/console help --format=xml list</info> +You can also output the help in other formats by using the --format option: -To display the list of available commands, please use the <info>list</info> command. + php app/console help --format=xml list -### Arguments: +To display the list of available commands, please use the list command. -**command_name:** +### Arguments + +#### `command_name` + +The command name -* Name: command_name * Is required: no * Is array: no -* Description: The command name * Default: `'help'` -### Options: - -**xml:** +### Options -* Name: `--xml` -* Shortcut: <none> -* Accept value: no -* Is value required: no -* Is multiple: no -* Description: To output help as XML -* Default: `false` +#### `--format` -**format:** +The output format (txt, xml, json, or md) -* Name: `--format` -* Shortcut: <none> * Accept value: yes * Is value required: yes * Is multiple: no -* Description: The output format (txt, xml, json, or md) * Default: `'txt'` -**raw:** +#### `--raw` + +To output raw command help -* Name: `--raw` -* Shortcut: <none> * Accept value: no * Is value required: no * Is multiple: no -* Description: To output raw command help * Default: `false` -**help:** +#### `--help|-h` + +Display this help message -* Name: `--help` -* Shortcut: `-h` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this help message * Default: `false` -**quiet:** +#### `--quiet|-q` + +Do not output any message -* Name: `--quiet` -* Shortcut: `-q` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not output any message * Default: `false` -**verbose:** +#### `--verbose|-v|-vv|-vvv` + +Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug -* Name: `--verbose` -* Shortcut: `-v|-vv|-vvv` * Accept value: no * Is value required: no * Is multiple: no -* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug * Default: `false` -**version:** +#### `--version|-V` + +Display this application version -* Name: `--version` -* Shortcut: `-V` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this application version * Default: `false` -**ansi:** +#### `--ansi` + +Force ANSI output -* Name: `--ansi` -* Shortcut: <none> * Accept value: no * Is value required: no * Is multiple: no -* Description: Force ANSI output * Default: `false` -**no-ansi:** +#### `--no-ansi` + +Disable ANSI output -* Name: `--no-ansi` -* Shortcut: <none> * Accept value: no * Is value required: no * Is multiple: no -* Description: Disable ANSI output * Default: `false` -**no-interaction:** +#### `--no-interaction|-n` + +Do not ask any interactive question -* Name: `--no-interaction` -* Shortcut: `-n` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not ask any interactive question * Default: `false` -list ----- +`list` +------ -* Description: Lists commands -* Usage: +Lists commands - * `list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]` +### Usage -The <info>list</info> command lists all commands: +* `list [--raw] [--format FORMAT] [--] [<namespace>]` - <info>php app/console list</info> +The list command lists all commands: + + php app/console list You can also display the commands for a specific namespace: - <info>php app/console list test</info> + php app/console list test -You can also output the information in other formats by using the <comment>--format</comment> option: +You can also output the information in other formats by using the --format option: - <info>php app/console list --format=xml</info> + php app/console list --format=xml It's also possible to get raw list of commands (useful for embedding command runner): - <info>php app/console list --raw</info> + php app/console list --raw + +### Arguments -### Arguments: +#### `namespace` -**namespace:** +The namespace name -* Name: namespace * Is required: no * Is array: no -* Description: The namespace name * Default: `NULL` -### Options: +### Options -**xml:** +#### `--raw` -* Name: `--xml` -* Shortcut: <none> -* Accept value: no -* Is value required: no -* Is multiple: no -* Description: To output list as XML -* Default: `false` +To output raw command list -**raw:** - -* Name: `--raw` -* Shortcut: <none> * Accept value: no * Is value required: no * Is multiple: no -* Description: To output raw command list * Default: `false` -**format:** +#### `--format` + +The output format (txt, xml, json, or md) -* Name: `--format` -* Shortcut: <none> * Accept value: yes * Is value required: yes * Is multiple: no -* Description: The output format (txt, xml, json, or md) * Default: `'txt'` |