diff options
Diffstat (limited to 'doc/rake/command_line_usage.rdoc')
| -rw-r--r-- | doc/rake/command_line_usage.rdoc | 87 |
1 files changed, 77 insertions, 10 deletions
diff --git a/doc/rake/command_line_usage.rdoc b/doc/rake/command_line_usage.rdoc index c60e53f51a..688e55a9af 100644 --- a/doc/rake/command_line_usage.rdoc +++ b/doc/rake/command_line_usage.rdoc @@ -2,14 +2,26 @@ Rake is invoked from the command line using: - % rake [<em>options</em> ...] [<em>VAR</em>=<em>VALUE</em>] [<em>targets</em> ...] + % rake [options ...] [VAR=VALUE ...] [targets ...] Options are: [<tt><em>name</em>=<em>value</em></tt>] Set the environment variable <em>name</em> to <em>value</em> during the execution of the <b>rake</b> command. You can access - the value by using ENV['<em>name</em>']. + the value by using ENV['<em>name</em>']. + +[<tt>--all</tt> (-A)] + Used in combination with the -T and -D options, will force + those options to show all the tasks, even the ones without comments. + +[<tt>--backtrace</tt>{=_output_} (-n)] + Enable a full backtrace (i.e. like --trace, but without the task + tracing details). The _output_ parameter is optional, but if + specified it controls where the backtrace output is sent. If + _output_ is <tt>stdout</tt>, then backtrace output is directed to + stardard output. If _output_ is <tt>stderr</tt>, or if it is + missing, then the backtrace output is sent to standard error. [<tt>--classic-namespace</tt> (-n)] Import the Task, FileTask, and FileCreateTask into the top-level @@ -18,6 +30,11 @@ Options are: 'rake/classic_namespace'</code> in your Rakefile to get the classic behavior. +[<tt>--comments</tt>] + Used in combination with the -W options to force the output to + contain commented options only. This is the reverse of + <tt>--all</tt>. + [<tt>--describe</tt> _pattern_ (-D)] Describe the tasks (matching optional PATTERN), then exit. @@ -31,15 +48,40 @@ Options are: [<tt>--execute-print</tt> _code_ (-p)] Execute some Ruby code, print the result, and exit. -[<tt>--execute-continue</tt> _code_ (-p)] +[<tt>--execute-continue</tt> _code_ (-E)] Execute some Ruby code, then continue with normal task processing. [<tt>--help</tt> (-H)] Display some help text and exit. +[<tt>--jobs</tt> _number_ (-j)] + Specifies the number of active concurrent tasks used. The + suggested value is equal to the number of CPUs. The concurrent + tasks are used to execute the <tt>multitask</tt> prerequisites. + Also see the <tt>-m</tt> option which turns all tasks into + multitasks. + + Sample values: + (no -j) : unlimited concurrent tasks (standard rake behavior) + -j : 2 concurrent tasks (exact number may change) + -j 16 : 16 concurrent tasks + +[<tt>--job-stats</tt> _level_] + + Display job statistics at the completion of the run. By default, + this will display the requested number of active tasks (from the + -j options) and the maximum number of tasks in play at any given + time. + + If the optional _level_ is <tt>history</tt>, then a complete trace + of task history will be displayed on standard output. + [<tt>--libdir</tt> _directory_ (-I)] Add _directory_ to the list of directories searched for require. +[<tt>--multitask</tt> (-m)] + Treat all tasks as multitasks. ('make/drake' semantics) + [<tt>--nosearch</tt> (-N)] Do not search for a Rakefile in parent directories. @@ -60,6 +102,16 @@ Options are: [<tt>--rakelibdir</tt> _rakelibdir_ (-R)] Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib') +[<tt>--reduce-compat</tt>] + + Remove the DSL commands from the Object inheritance hierarchy and + do not define top level constants. This reduces the backwards + compatibility of Rake, but allows rake to be used with software + that would otherwise have conflicting definitions. + + *NOTE:* The next major version of Rake will only be able to be run + in "reduce-compat" mode. + [<tt>--require</tt> _name_ (-r)] Require _name_ before executing the Rakefile. @@ -69,6 +121,11 @@ Options are: [<tt>--silent (-s)</tt>] Like --quiet, but also suppresses the 'in directory' announcement. +[<tt>--suppress-backtrace _pattern_ </tt>] + Line matching the regular expression _pattern_ will be removed + from the backtrace output. Note that the --backtrace option is the + full backtrace without these lines suppressed. + [<tt>--system</tt> (-g)] Use the system wide (global) rakefiles. The project Rakefile is ignored. By default, the system wide rakefiles are used only if no @@ -80,16 +137,18 @@ Options are: Use the project level Rakefile, ignoring the system-wide (global) rakefiles. -[<tt>--tasks</tt> (-T)] +[<tt>--tasks</tt> <em>pattern</em> (-T)] Display a list of the major tasks and their comments. Comments - are defined using the "desc" command. + are defined using the "desc" command. If a pattern is given, then + only tasks matching the pattern are displayed. -[<tt>--trace</tt> (-t)] +[<tt>--trace</tt>{=_output_} (-t)] Turn on invoke/execute tracing. Also enable full backtrace on - errors. - -[<tt>--usage</tt> (-h)] - Display a usage message and exit. + errors. The _output_ parameter is optional, but if specified it + controls where the trace output is sent. If _output_ is + <tt>stdout</tt>, then trace output is directed to stardard output. + If _output_ is <tt>stderr</tt>, or if it is missing, then trace + output is sent to standard error. [<tt>--verbose</tt> (-v)] Echo the Sys commands to standard output. @@ -97,6 +156,14 @@ Options are: [<tt>--version</tt> (-V)] Display the program version and exit. +[<tt>--where</tt> <em>pattern</em> (-W)] + Display tasks that match <em>pattern</em> and the file and line + number where the task is defined. By default this option will + display all tasks, not just the tasks that have descriptions. + +[<tt>--no-deprecation-warnings</tt> (-W)] + Do not display the deprecation warnings. + In addition, any command line option of the form <em>VAR</em>=<em>VALUE</em> will be added to the environment hash <tt>ENV</tt> and may be tested in the Rakefile. |