lib/capistrano/cli/help.txt in capistrano-2.4.3 vs lib/capistrano/cli/help.txt in capistrano-2.5.0
- old
+ new
@@ -8,10 +8,13 @@
cap [ option ] ... action ...
The following options are understood:
+ <%= color '-d, --debug', :bold %>
+ Causes Capistrano to pause and prompt before executing any remote command, giving the user the option to either execute the command, skip the command, or abort execution entirely. This makes it a great way to troubleshoot tasks, or test custom tasks, by executing commands one at a time and checking the server to make sure they worked as expected before moving on to the next command. (Compare this to the --dry-run command.)
+
<%= color '-e, --explain TASK', :bold %>
Displays the extended description of the given task. Not all tasks will have an extended description, but for those that do, this can provide a wealth of additional usage information, such as describing environment variables or settings that can affect the execution of the task.
<%= color '-F, --default-config', :bold %>
By default, cap will search for a config file named `Capfile' or `capfile' in the current directory, or in any parent directory, and will automatically load it. However, if you specify the -f flag (see below), cap will use that file instead of the default config. If you want to use both the default config, and files loaded via -f, you can specify -F to force cap to search for and load the default config, even if additional files were specified via -f.
@@ -23,9 +26,12 @@
Displays this document and exits.
<%= color '-h, --help', :bold %>
Shows a brief summary of these options and exits.
+ <%= color '-n, --dry-run', :bold %>
+ Causes Capistrano to simply display each remote command, without executing it. In this sense it is similar to --debug, but without the prompt. Note that commands executed locally are still run--only remote commands are skipped.
+
<%= color '-p, --password', :bold %>
Normally, cap will prompt for the password on-demand, the first time it is needed. This can make it hard to walk away from Capistrano, since you might not know if it will prompt for a password down the road. In such cases, you can use the -p option to force cap to prompt for the password immediately.
<%= color '-q, --quiet', :bold %>
Display only critical error messages. All other output is suppressed.