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

   1 My Symfony application
   2 ======================
   3
   4 * alias1
   5 * alias2
   6 * help
   7 * list
   8
   9 **descriptor:**
  10
  11 * descriptor:command1
  12 * descriptor:command2
  13
  14 help
  15 ----
  16
  17 * Description: Displays help for a command
  18 * Usage:
  19
  20   * `help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]`
  21
  22 The <info>help</info> command displays help for a given command:
  23
  24   <info>php app/console help list</info>
  25
  26 You can also output the help in other formats by using the <comment>--format</comment> option:
  27
  28   <info>php app/console help --format=xml list</info>
  29
  30 To display the list of available commands, please use the <info>list</info> command.
  31
  32 ### Arguments:
  33
  34 **command_name:**
  35
  36 * Name: command_name
  37 * Is required: no
  38 * Is array: no
  39 * Description: The command name
  40 * Default: `'help'`
  41
  42 ### Options:
  43
  44 **xml:**
  45
  46 * Name: `--xml`
  47 * Shortcut: <none>
  48 * Accept value: no
  49 * Is value required: no
  50 * Is multiple: no
  51 * Description: To output help as XML
  52 * Default: `false`
  53
  54 **format:**
  55
  56 * Name: `--format`
  57 * Shortcut: <none>
  58 * Accept value: yes
  59 * Is value required: yes
  60 * Is multiple: no
  61 * Description: The output format (txt, xml, json, or md)
  62 * Default: `'txt'`
  63
  64 **raw:**
  65
  66 * Name: `--raw`
  67 * Shortcut: <none>
  68 * Accept value: no
  69 * Is value required: no
  70 * Is multiple: no
  71 * Description: To output raw command help
  72 * Default: `false`
  73
  74 **help:**
  75
  76 * Name: `--help`
  77 * Shortcut: `-h`
  78 * Accept value: no
  79 * Is value required: no
  80 * Is multiple: no
  81 * Description: Display this help message
  82 * Default: `false`
  83
  84 **quiet:**
  85
  86 * Name: `--quiet`
  87 * Shortcut: `-q`
  88 * Accept value: no
  89 * Is value required: no
  90 * Is multiple: no
  91 * Description: Do not output any message
  92 * Default: `false`
  93
  94 **verbose:**
  95
  96 * Name: `--verbose`
  97 * Shortcut: `-v|-vv|-vvv`
  98 * Accept value: no
  99 * Is value required: no
 100 * Is multiple: no
 101 * Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 102 * Default: `false`
 103
 104 **version:**
 105
 106 * Name: `--version`
 107 * Shortcut: `-V`
 108 * Accept value: no
 109 * Is value required: no
 110 * Is multiple: no
 111 * Description: Display this application version
 112 * Default: `false`
 113
 114 **ansi:**
 115
 116 * Name: `--ansi`
 117 * Shortcut: <none>
 118 * Accept value: no
 119 * Is value required: no
 120 * Is multiple: no
 121 * Description: Force ANSI output
 122 * Default: `false`
 123
 124 **no-ansi:**
 125
 126 * Name: `--no-ansi`
 127 * Shortcut: <none>
 128 * Accept value: no
 129 * Is value required: no
 130 * Is multiple: no
 131 * Description: Disable ANSI output
 132 * Default: `false`
 133
 134 **no-interaction:**
 135
 136 * Name: `--no-interaction`
 137 * Shortcut: `-n`
 138 * Accept value: no
 139 * Is value required: no
 140 * Is multiple: no
 141 * Description: Do not ask any interactive question
 142 * Default: `false`
 143
 144 list
 145 ----
 146
 147 * Description: Lists commands
 148 * Usage:
 149
 150   * `list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]`
 151
 152 The <info>list</info> command lists all commands:
 153
 154   <info>php app/console list</info>
 155
 156 You can also display the commands for a specific namespace:
 157
 158   <info>php app/console list test</info>
 159
 160 You can also output the information in other formats by using the <comment>--format</comment> option:
 161
 162   <info>php app/console list --format=xml</info>
 163
 164 It's also possible to get raw list of commands (useful for embedding command runner):
 165
 166   <info>php app/console list --raw</info>
 167
 168 ### Arguments:
 169
 170 **namespace:**
 171
 172 * Name: namespace
 173 * Is required: no
 174 * Is array: no
 175 * Description: The namespace name
 176 * Default: `NULL`
 177
 178 ### Options:
 179
 180 **xml:**
 181
 182 * Name: `--xml`
 183 * Shortcut: <none>
 184 * Accept value: no
 185 * Is value required: no
 186 * Is multiple: no
 187 * Description: To output list as XML
 188 * Default: `false`
 189
 190 **raw:**
 191
 192 * Name: `--raw`
 193 * Shortcut: <none>
 194 * Accept value: no
 195 * Is value required: no
 196 * Is multiple: no
 197 * Description: To output raw command list
 198 * Default: `false`
 199
 200 **format:**
 201
 202 * Name: `--format`
 203 * Shortcut: <none>
 204 * Accept value: yes
 205 * Is value required: yes
 206 * Is multiple: no
 207 * Description: The output format (txt, xml, json, or md)
 208 * Default: `'txt'`
 209
 210 descriptor:command1
 211 -------------------
 212
 213 * Description: command 1 description
 214 * Usage:
 215
 216   * `descriptor:command1`
 217   * `alias1`
 218   * `alias2`
 219
 220 command 1 help
 221
 222 ### Options:
 223
 224 **help:**
 225
 226 * Name: `--help`
 227 * Shortcut: `-h`
 228 * Accept value: no
 229 * Is value required: no
 230 * Is multiple: no
 231 * Description: Display this help message
 232 * Default: `false`
 233
 234 **quiet:**
 235
 236 * Name: `--quiet`
 237 * Shortcut: `-q`
 238 * Accept value: no
 239 * Is value required: no
 240 * Is multiple: no
 241 * Description: Do not output any message
 242 * Default: `false`
 243
 244 **verbose:**
 245
 246 * Name: `--verbose`
 247 * Shortcut: `-v|-vv|-vvv`
 248 * Accept value: no
 249 * Is value required: no
 250 * Is multiple: no
 251 * Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 252 * Default: `false`
 253
 254 **version:**
 255
 256 * Name: `--version`
 257 * Shortcut: `-V`
 258 * Accept value: no
 259 * Is value required: no
 260 * Is multiple: no
 261 * Description: Display this application version
 262 * Default: `false`
 263
 264 **ansi:**
 265
 266 * Name: `--ansi`
 267 * Shortcut: <none>
 268 * Accept value: no
 269 * Is value required: no
 270 * Is multiple: no
 271 * Description: Force ANSI output
 272 * Default: `false`
 273
 274 **no-ansi:**
 275
 276 * Name: `--no-ansi`
 277 * Shortcut: <none>
 278 * Accept value: no
 279 * Is value required: no
 280 * Is multiple: no
 281 * Description: Disable ANSI output
 282 * Default: `false`
 283
 284 **no-interaction:**
 285
 286 * Name: `--no-interaction`
 287 * Shortcut: `-n`
 288 * Accept value: no
 289 * Is value required: no
 290 * Is multiple: no
 291 * Description: Do not ask any interactive question
 292 * Default: `false`
 293
 294 descriptor:command2
 295 -------------------
 296
 297 * Description: command 2 description
 298 * Usage:
 299
 300   * `descriptor:command2 [-o|--option_name] [--] <argument_name>`
 301   * `descriptor:command2 -o|--option_name <argument_name>`
 302   * `descriptor:command2 <argument_name>`
 303
 304 command 2 help
 305
 306 ### Arguments:
 307
 308 **argument_name:**
 309
 310 * Name: argument_name
 311 * Is required: yes
 312 * Is array: no
 313 * Description: <none>
 314 * Default: `NULL`
 315
 316 ### Options:
 317
 318 **option_name:**
 319
 320 * Name: `--option_name`
 321 * Shortcut: `-o`
 322 * Accept value: no
 323 * Is value required: no
 324 * Is multiple: no
 325 * Description: <none>
 326 * Default: `false`
 327
 328 **help:**
 329
 330 * Name: `--help`
 331 * Shortcut: `-h`
 332 * Accept value: no
 333 * Is value required: no
 334 * Is multiple: no
 335 * Description: Display this help message
 336 * Default: `false`
 337
 338 **quiet:**
 339
 340 * Name: `--quiet`
 341 * Shortcut: `-q`
 342 * Accept value: no
 343 * Is value required: no
 344 * Is multiple: no
 345 * Description: Do not output any message
 346 * Default: `false`
 347
 348 **verbose:**
 349
 350 * Name: `--verbose`
 351 * Shortcut: `-v|-vv|-vvv`
 352 * Accept value: no
 353 * Is value required: no
 354 * Is multiple: no
 355 * Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 356 * Default: `false`
 357
 358 **version:**
 359
 360 * Name: `--version`
 361 * Shortcut: `-V`
 362 * Accept value: no
 363 * Is value required: no
 364 * Is multiple: no
 365 * Description: Display this application version
 366 * Default: `false`
 367
 368 **ansi:**
 369
 370 * Name: `--ansi`
 371 * Shortcut: <none>
 372 * Accept value: no
 373 * Is value required: no
 374 * Is multiple: no
 375 * Description: Force ANSI output
 376 * Default: `false`
 377
 378 **no-ansi:**
 379
 380 * Name: `--no-ansi`
 381 * Shortcut: <none>
 382 * Accept value: no
 383 * Is value required: no
 384 * Is multiple: no
 385 * Description: Disable ANSI output
 386 * Default: `false`
 387
 388 **no-interaction:**
 389
 390 * Name: `--no-interaction`
 391 * Shortcut: `-n`
 392 * Accept value: no
 393 * Is value required: no
 394 * Is multiple: no
 395 * Description: Do not ask any interactive question
 396 * Default: `false`