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_2.md | |
parent | 2c72a283f2d51034f85f4e2ca8b194d304a3c433 (diff) |
Kanboard requires at least PHP 5.6 now
Diffstat (limited to 'vendor/symfony/console/Tests/Fixtures/application_2.md')
-rw-r--r-- | vendor/symfony/console/Tests/Fixtures/application_2.md | 397 |
1 files changed, 216 insertions, 181 deletions
diff --git a/vendor/symfony/console/Tests/Fixtures/application_2.md b/vendor/symfony/console/Tests/Fixtures/application_2.md index f031c9e5..5b4896c0 100644 --- a/vendor/symfony/console/Tests/Fixtures/application_2.md +++ b/vendor/symfony/console/Tests/Fixtures/application_2.md @@ -1,396 +1,431 @@ -My Symfony application -====================== +My Symfony application v1.0 +=========================== -* alias1 -* alias2 -* help -* list +* [`alias1`](#descriptorcommand1) +* [`alias2`](#descriptorcommand1) +* [`help`](#help) +* [`list`](#list) + +**command4:** + +* [`command4:descriptor`](#descriptorcommand4) **descriptor:** -* descriptor:command1 -* descriptor:command2 +* [`descriptor:alias_command4`](#descriptorcommand4) +* [`descriptor:command1`](#descriptorcommand1) +* [`descriptor:command2`](#descriptorcommand2) +* [`descriptor:command4`](#descriptorcommand4) + +`help` +------ -help ----- +Displays help for a command -* Description: Displays help for a command -* Usage: +### Usage - * `help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]` +* `help [--format FORMAT] [--raw] [--] [<command_name>]` -The <info>help</info> command displays help for a given command: +The help command displays help for a given command: - <info>php app/console help list</info> + php app/console help list -You can also output the help in other formats by using the <comment>--format</comment> option: +You can also output the help in other formats by using the --format option: - <info>php app/console help --format=xml list</info> + php app/console help --format=xml list -To display the list of available commands, please use the <info>list</info> command. +To display the list of available commands, please use the list command. -### Arguments: +### Arguments -**command_name:** +#### `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` +------ + +Lists commands -* Description: Lists commands -* Usage: +### Usage - * `list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]` +* `list [--raw] [--format FORMAT] [--] [<namespace>]` -The <info>list</info> command lists all commands: +The list command lists all commands: - <info>php app/console list</info> + 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: - -**xml:** +### Options -* Name: `--xml` -* Shortcut: <none> -* Accept value: no -* Is value required: no -* Is multiple: no -* Description: To output list as XML -* Default: `false` +#### `--raw` -**raw:** +To output raw command list -* 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'` -descriptor:command1 -------------------- +`descriptor:command1` +--------------------- + +command 1 description -* Description: command 1 description -* Usage: +### Usage - * `descriptor:command1` - * `alias1` - * `alias2` +* `descriptor:command1` +* `alias1` +* `alias2` command 1 help -### Options: +### Options + +#### `--help|-h` -**help:** +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` -descriptor:command2 -------------------- +`descriptor:command2` +--------------------- -* Description: command 2 description -* Usage: +command 2 description - * `descriptor:command2 [-o|--option_name] [--] <argument_name>` - * `descriptor:command2 -o|--option_name <argument_name>` - * `descriptor:command2 <argument_name>` +### Usage + +* `descriptor:command2 [-o|--option_name] [--] <argument_name>` +* `descriptor:command2 -o|--option_name <argument_name>` +* `descriptor:command2 <argument_name>` command 2 help -### Arguments: +### Arguments -**argument_name:** +#### `argument_name` -* Name: argument_name * Is required: yes * Is array: no -* Description: <none> * Default: `NULL` -### Options: +### Options + +#### `--option_name|-o` + +* Accept value: no +* Is value required: no +* Is multiple: no +* Default: `false` + +#### `--help|-h` -**option_name:** +Display this help message -* Name: `--option_name` -* Shortcut: `-o` * Accept value: no * Is value required: no * Is multiple: no -* Description: <none> * Default: `false` -**help:** +#### `--quiet|-q` + +Do not output any message -* Name: `--help` -* Shortcut: `-h` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this help message * Default: `false` -**quiet:** +#### `--verbose|-v|-vv|-vvv` + +Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug -* Name: `--quiet` -* Shortcut: `-q` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not output any message * Default: `false` -**verbose:** +#### `--version|-V` + +Display this application version -* 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:** +#### `--ansi` + +Force ANSI output -* Name: `--version` -* Shortcut: `-V` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this application version * Default: `false` -**ansi:** +#### `--no-ansi` + +Disable 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-interaction|-n` + +Do not ask any interactive question -* Name: `--no-ansi` -* Shortcut: <none> * Accept value: no * Is value required: no * Is multiple: no -* Description: Disable ANSI output * Default: `false` -**no-interaction:** +`descriptor:command4` +--------------------- + +### Usage + +* `descriptor:command4` +* `descriptor:alias_command4` +* `command4:descriptor` + + +### Options + +#### `--help|-h` + +Display this help message + +* Accept value: no +* Is value required: no +* Is multiple: no +* Default: `false` + +#### `--quiet|-q` + +Do not output any message + +* Accept value: no +* Is value required: no +* Is multiple: no +* Default: `false` + +#### `--verbose|-v|-vv|-vvv` + +Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + +* Accept value: no +* Is value required: no +* Is multiple: no +* Default: `false` + +#### `--version|-V` + +Display this application version + +* Accept value: no +* Is value required: no +* Is multiple: no +* Default: `false` + +#### `--ansi` + +Force ANSI output + +* Accept value: no +* Is value required: no +* Is multiple: no +* Default: `false` + +#### `--no-ansi` + +Disable ANSI output + +* Accept value: no +* Is value required: no +* Is multiple: no +* Default: `false` + +#### `--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` |