X-Git-Url: http://www.aleph1.co.uk/gitweb/?p=yaffs-website;a=blobdiff_plain;f=vendor%2Fsymfony%2Fconsole%2FTests%2FFixtures%2Fapplication_1.md;fp=vendor%2Fsymfony%2Fconsole%2FTests%2FFixtures%2Fapplication_1.md;h=b46c975a79082b61f9072de4f78734999c634191;hp=f1d88c5b7d1abcd031e9f1bf9dacb92186e25702;hb=af6d1fb995500ae68849458ee10d66abbdcfb252;hpb=680c79a86e3ed402f263faeac92e89fb6d9edcc0 diff --git a/vendor/symfony/console/Tests/Fixtures/application_1.md b/vendor/symfony/console/Tests/Fixtures/application_1.md index f1d88c5b7..b46c975a7 100644 --- a/vendor/symfony/console/Tests/Fixtures/application_1.md +++ b/vendor/symfony/console/Tests/Fixtures/application_1.md @@ -1,181 +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 [--format FORMAT] [--raw] [--] []` +### Usage -The help command displays help for a given command: +* `help [--format FORMAT] [--raw] [--] []` - php app/console help list +The help command displays help for a given command: -You can also output the help in other formats by using the --format option: + php app/console help list - php app/console help --format=xml list +You can also output the help in other formats by using the --format option: -To display the list of available commands, please use the list 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: +### Options -**format:** +#### `--format` + +The output format (txt, xml, json, or md) -* Name: `--format` -* Shortcut: * 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: * 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: * 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: * 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 [--raw] [--format FORMAT] [--] []` +* `list [--raw] [--format FORMAT] [--] []` -The list command lists all commands: +The list command lists all commands: - php app/console list + php app/console list You can also display the commands for a specific namespace: - php app/console list test + php app/console list test -You can also output the information in other formats by using the --format option: +You can also output the information in other formats by using the --format option: - php app/console list --format=xml + php app/console list --format=xml It's also possible to get raw list of commands (useful for embedding command runner): - php app/console list --raw + 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 + +#### `--raw` -**raw:** +To output raw command list -* Name: `--raw` -* Shortcut: * 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: * Accept value: yes * Is value required: yes * Is multiple: no -* Description: The output format (txt, xml, json, or md) * Default: `'txt'`