function drush_get_option_help

3.x drush.inc drush_get_option_help()

Get the available options for Drush for use by help page.

Return value

An associative array containing the option definition as the key, and the description as the value, for each of the available options.

2 calls to drush_get_option_help()
core_drush_command in commands/core/core.drush.inc
Implementation of hook_drush_command().
drush_help_html in commands/core/core.drush.inc
Return an HTML page documenting all available commands and global options.

File

includes/drush.inc, line 633
The drush API implementation and helpers.

Code

function drush_get_option_help() {
  // TODO: Add a hook for this, to allow other modules to add their global options
  $options['-r <path>, --root=<path>'] = dt("Drupal root directory to use (default: current directory)");
  $options['-l <uri>, --uri=http://example.com'] = dt('URI of the drupal site to use (only needed in multisite environments)');
  $options['-v, --verbose'] = dt('Display extra information about the command.');
  $options['-d, --debug'] = dt('Display even more information, including internal messages.');
  $options['-q, --quiet'] = dt('Hide all output');
  $options['-y, --yes'] = dt("Assume 'yes' as answer to all prompts");
  $options['-n, --no'] = dt("Assume 'no' as answer to all prompts");
  $options['-s, --simulate'] = dt("Simulate all relevant actions (don't actually change the system)");
  $options['-i, --include'] = dt("A list of paths to search for drush commands");
  $options['-c, --config'] = dt("Specify a config file to use. See example.drushrc.php");
  $options['-u, --user'] = dt("Specify a user to login with. May be a name or a number.");
  $options['-b, --backend'] = dt("Hide all output and return structured data (internal use only).");
  $options['-p, --pipe'] = dt("Emit a compact representation of the command for scripting.");
  $options['--nocolor'] = dt("Suppress color highlighting on log messages.");
  $options['--show-passwords'] = dt("Show database passwords in commands that display connection information.");
  $options['-h, --help'] = dt("This help system.");
  $options['--php'] = dt("The absolute path to your PHP intepreter, if not 'php' in the path.");
  return $options;
}