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