www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/console/Tests/Fixtures/application_1.md

   1 Console Tool
   2 ============
   3
   4 * [`help`](#help)
   5 * [`list`](#list)
   6
   7 `help`
   8 ------
   9
  10 Displays help for a command
  11
  12 ### Usage
  13
  14 * `help [--format FORMAT] [--raw] [--] [<command_name>]`
  15
  16 The help command displays help for a given command:
  17
  18   php app/console help list
  19
  20 You can also output the help in other formats by using the --format option:
  21
  22   php app/console help --format=xml list
  23
  24 To display the list of available commands, please use the list command.
  25
  26 ### Arguments
  27
  28 #### `command_name`
  29
  30 The command name
  31
  32 * Is required: no
  33 * Is array: no
  34 * Default: `'help'`
  35
  36 ### Options
  37
  38 #### `--format`
  39
  40 The output format (txt, xml, json, or md)
  41
  42 * Accept value: yes
  43 * Is value required: yes
  44 * Is multiple: no
  45 * Default: `'txt'`
  46
  47 #### `--raw`
  48
  49 To output raw command help
  50
  51 * Accept value: no
  52 * Is value required: no
  53 * Is multiple: no
  54 * Default: `false`
  55
  56 #### `--help|-h`
  57
  58 Display this help message
  59
  60 * Accept value: no
  61 * Is value required: no
  62 * Is multiple: no
  63 * Default: `false`
  64
  65 #### `--quiet|-q`
  66
  67 Do not output any message
  68
  69 * Accept value: no
  70 * Is value required: no
  71 * Is multiple: no
  72 * Default: `false`
  73
  74 #### `--verbose|-v|-vv|-vvv`
  75
  76 Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  77
  78 * Accept value: no
  79 * Is value required: no
  80 * Is multiple: no
  81 * Default: `false`
  82
  83 #### `--version|-V`
  84
  85 Display this application version
  86
  87 * Accept value: no
  88 * Is value required: no
  89 * Is multiple: no
  90 * Default: `false`
  91
  92 #### `--ansi`
  93
  94 Force ANSI output
  95
  96 * Accept value: no
  97 * Is value required: no
  98 * Is multiple: no
  99 * Default: `false`
 100
 101 #### `--no-ansi`
 102
 103 Disable ANSI output
 104
 105 * Accept value: no
 106 * Is value required: no
 107 * Is multiple: no
 108 * Default: `false`
 109
 110 #### `--no-interaction|-n`
 111
 112 Do not ask any interactive question
 113
 114 * Accept value: no
 115 * Is value required: no
 116 * Is multiple: no
 117 * Default: `false`
 118
 119 `list`
 120 ------
 121
 122 Lists commands
 123
 124 ### Usage
 125
 126 * `list [--raw] [--format FORMAT] [--] [<namespace>]`
 127
 128 The list command lists all commands:
 129
 130   php app/console list
 131
 132 You can also display the commands for a specific namespace:
 133
 134   php app/console list test
 135
 136 You can also output the information in other formats by using the --format option:
 137
 138   php app/console list --format=xml
 139
 140 It's also possible to get raw list of commands (useful for embedding command runner):
 141
 142   php app/console list --raw
 143
 144 ### Arguments
 145
 146 #### `namespace`
 147
 148 The namespace name
 149
 150 * Is required: no
 151 * Is array: no
 152 * Default: `NULL`
 153
 154 ### Options
 155
 156 #### `--raw`
 157
 158 To output raw command list
 159
 160 * Accept value: no
 161 * Is value required: no
 162 * Is multiple: no
 163 * Default: `false`
 164
 165 #### `--format`
 166
 167 The output format (txt, xml, json, or md)
 168
 169 * Accept value: yes
 170 * Is value required: yes
 171 * Is multiple: no
 172 * Default: `'txt'`