function notify_drush_help_alter

8.0.x notify.drush.inc notify_drush_help_alter(&$command)
6.x notify.drush.inc notify_drush_help_alter(&$command)
7.x notify.drush.inc notify_drush_help_alter(&$command)
master notify.drush.inc notify_drush_help_alter(&$command)

Implements hook_drush_help_alter().

File

commands/core/notify.drush.inc, line 15
Add system notifications as a new drush option.

Code

function notify_drush_help_alter(&$command) {
  if ($command['command'] == 'global-options') {
    // Do not include these in options in standard help.
    if ($command['#brief'] === FALSE) {
      $command['options']['notify'] = array(
        'description' => 'Use system notifications to signal command completion. If set to a number, commands that finish in fewer seconds will not trigger a notification.',
        'example-value' => 60,
      );
      $command['options']['notify-audio'] = array(
        'description' => 'Trigger an audio alert to signal command completion. If set to a number, commands that finish in fewer seconds will not trigger a notification.',
        'example-value' => 60,
      );
      $command['sub-options']['notify']['notify-cmd'] = 'Specify the shell command to trigger the notification.';
      $command['sub-options']['notify']['notify-cmd-audio'] = 'Specify the shell command to trigger the audio notification.';
    }
  }
}