function drush_global_options_command

8.0.x help.drush.inc drush_global_options_command($brief = FALSE)
6.x help.drush.inc drush_global_options_command($brief = FALSE)
7.x help.drush.inc drush_global_options_command($brief = FALSE)
4.x help.drush.inc drush_global_options_command($brief = FALSE)
5.x help.drush.inc drush_global_options_command($brief = FALSE)
master help.drush.inc drush_global_options_command($brief = FALSE)

Build a fake command for the purposes of showing examples and options.

2 calls to drush_global_options_command()
drush_core_global_options in commands/core/core.drush.inc
drush_core_help in commands/core/help.drush.inc
Command callback for help command. This is the default command, when none other has been specified.

File

commands/core/help.drush.inc, line 319

Code

function drush_global_options_command($brief = FALSE) {
  $global_options_help = array(
    'description' => 'Execute a drush command. Run `drush help [command]` to view command-specific help.  Run `drush topic` to read even more documentation.',
    'sections' => array(
      'options' => 'Global options (see `drush topic core-global-options` for the full list)',
    ),
    'options' => drush_get_global_options($brief),
    'examples' => array(
      'drush dl cck zen' => 'Download CCK module and Zen theme.',
      'drush --uri=http://example.com status' => 'Show status command for the example.com multi-site.',
    ),
    '#brief' => TRUE,
  );
  $global_options_help += drush_command_defaults('global-options', 'global_options', __FILE__);
  drush_command_invoke_all_ref('drush_help_alter', $global_options_help);
  ksort($global_options_help['options']);

  return $global_options_help;
}