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

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