summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2014-12-01 01:49:58 (GMT)
committerhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2014-12-01 01:49:58 (GMT)
commitd4cd7b0b1cc533ffa0cfa1e836ccda674ac85557 (patch)
tree69952771a84f0e038287394c36dfef73a7f9ea7f /man
parenta80343fa24c94550feea6988694cf17b69a1a45a (diff)
* man/rake.1: Update latest man content by @aledovsky
[fix GH-771][ci skip] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@48658 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'man')
-rw-r--r--man/rake.1327
1 files changed, 135 insertions, 192 deletions
diff --git a/man/rake.1 b/man/rake.1
index d899154..b63ed49 100644
--- a/man/rake.1
+++ b/man/rake.1
@@ -1,198 +1,141 @@
-.Dd November 7, 2012
-.Dt RAKE(1) "" "Ruby Programmers Reference Guide"
-.Os UNIX
-.Sh NAME
-.Nm rake
-.Nd Ruby Make
-.Sh SYNOPSIS
-.Nm
-.Op Fl -f Ar Rakefile
-.Op Fl -version
-.Op Fl CGNPgnqstv
-.Op Fl D Op Ar PATTERN
-.Op Fl E Ar CODE
-.Op Fl I Ar LIBDIR
-.Op Fl R Ar RAKELIBDIR
-.Op Fl T Op Ar PATTERN
-.Op Fl e Ar CODE
-.Op Fl p Ar CODE
-.Op Fl r Ar MODULE
-.Op Fl -rules
-.Op Ar variable Ns = Ns Ar value
-.Ar target ...
-.Sh DESCRIPTION
-.Nm Rake
-is a simple
-.Xr ruby 1
-build program with capabilities similar to the regular
-.Xr make 1
-command.
-.Pp
-.Nm Rake
-has the following features:
-.Bl -bullet
-.It
-Rakefiles (Rake's version of Makefiles) are completely defined in standard Ruby syntax.
-No XML files to edit. No quirky Makefile syntax to worry about (is that a tab or a space?).
-.It
-Users can specify tasks with prerequisites.
-.It
-Rake supports rule patterns to synthesize implicit tasks.
-.It
-Flexible FileLists that act like arrays but know about manipulating file names and paths.
-.It
-A library of prepackaged tasks to make building rakefiles easier.
-.El
-.Pp
-.Sh OPTIONS
-.Bl -tag -width "--execute-continue" -compact
-.Pp
-.It Fl -version
-Display the program version.
-.Pp
-.It Fl C
-.It Fl -classic-namespace
-Put Task and FileTask in the top level namespace
-.Pp
-.It Fl D Op Ar PATTERN
-.It Fl -describe Op Ar PATTERN
-Describe the tasks (matching optional
-.Ar PATTERN Ns
-), then exit.
-.Pp
-.It Fl E Ar CODE
-.It Fl -execute-continue Ar CODE
-Execute some Ruby code, then continue with normal task processing.
-.Pp
-.It Fl G
-.It Fl -no-system
-.It Fl -nosystem
-Use standard project Rakefile search paths, ignore system wide rakefiles.
-.Pp
-.It Fl I Ar LIBDIR
-.It Fl -libdir Ar LIBDIR
-Include
-.Ar LIBDIR
-in the search path for required modules.
-.Pp
-.It Fl N
-.It Fl -no-search
-.It Fl -nosearch
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH RAKE 1 "August 27, 2014" "rake 10.3.2" "Rake User Commands"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+rake \- a make-like build utility for Ruby
+.SH SYNOPSIS
+\fBrake\fR [\fI\-f rakefile\fR] {\fIOPTIONS\fR} \fITARGETS...\fR
+.br
+.SH DESCRIPTION
+.B rake
+is a make-like build utility for Ruby. Tasks and dependencies are specified in
+standard Ruby syntax.
+.SH OPTIONS
+.TP
+\fB\-m\fR, \fB\-\-multitask\fR
+Treat all tasks as multitasks.
+.TP
+\fB\-B\fR, \fB\-\-build\-all\fR
+Build all prerequisites, including those which are up\-to\-date.
+
+.TP
+\fB\-j\fR, \fB\-\-jobs\fR [\fINUMBER\fR]
+Specifies the maximum number of tasks to execute in parallel (default is number of CPU cores + 4).
+
+.SS Modules
+.TP
+\fB\-I\fR, \fB\-\-libdir\fR \fILIBDIR\fR
+Include \fILIBDIR\fR in the search path for required modules.
+.TP
+\fB\-r\fR, \fB\-\-require\fR \fIMODULE\fR
+Require \fIMODULE\fR before executing rakefile.
+
+.SS Rakefile location
+.TP
+\fB\-f\fR, \fB\-\-rakefile\fR [\fIFILENAME\fR]
+Use \fIFILENAME\fR as the rakefile to search for.
+.TP
+\fB\-N\fR, \fB\-\-no\-search\fR, \fB\-\-nosearch\fR
Do not search parent directories for the Rakefile.
-.Pp
-.It Fl P
-.It Fl -prereqs
+.TP
+\fB\-G\fR, \fB\-\-no\-system\fR, \fB\-\-nosystem\fR
+Use standard project Rakefile search paths, ignore system wide rakefiles.
+.TP
+\fB\-R\fR, \fB\-\-rakelibdir\fR \fIRAKELIBDIR\fR
+Auto\-import any .rake files in \fIRAKELIBDIR\fR (default is 'rakelib')
+.HP
+\fB\-\-rakelib\fR
+.TP
+\fB\-g\fR, \fB\-\-system\fR
+Using system wide (global) rakefiles (usually '\fI~/.rake/*.rake\fR').
+
+.SS Debugging
+.TP
+\fB\-\-backtrace\fR=\fI\,[OUT]\/\fR
+Enable full backtrace. \fIOUT\fR can be stderr (default) or stdout.
+.TP
+\fB\-t\fR, \fB\-\-trace\fR=\fI\,[OUT]\/\fR
+Turn on invoke/execute tracing, enable full backtrace. \fIOUT\fR can be stderr (default) or stdout.
+.TP
+\fB\-\-suppress\-backtrace\fR \fIPATTERN\fR
+Suppress backtrace lines matching regexp \fIPATTERN\fR. Ignored if \fI\-\-trace\fR is on.
+.TP
+\fB\-\-rules\fR
+Trace the rules resolution.
+
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Do a dry run without executing actions.
+.TP
+\fB\-T\fR, \fB\-\-tasks\fR [\fIPATTERN\fR]
+Display the tasks (matching optional \fIPATTERN\fR) with descriptions, then exit.
+.TP
+\fB\-D\fR, \fB\-\-describe\fR [\fIPATTERN\fR]
+Describe the tasks (matching optional \fIPATTERN\fR), then exit.
+.TP
+\fB\-W\fR, \fB\-\-where\fR [\fIPATTERN\fR]
+Describe the tasks (matching optional \fIPATTERN\fR), then exit.
+.TP
+\fB\-P\fR, \fB\-\-prereqs\fR
Display the tasks and dependencies, then exit.
-.Pp
-.It Fl R Ar RAKELIBDIR
-.It Fl -rakelib Ar RAKELIBDIR
-.It Fl -rakelibdir Ar RAKELIBDIR
-Auto-import any .rake files in
-.Ar RAKELIBDIR .
-(default is
-.Pa rakelib
-)
-.Pp
-.It Fl T Op Ar PATTERN
-.It Fl -tasks Op Ar PATTERN
-Display the tasks (matching optional
-.Ar PATTERN Ns
-) with descriptions, then exit.
-.Pp
-.It Fl e Ar CODE
-.It Fl -execute Ar CODE
+
+.TP
+\fB\-e\fR, \fB\-\-execute\fR \fICODE\fR
Execute some Ruby code and exit.
-.Pp
-.It Fl f Ar FILE
-.It Fl -rakefile Ar FILE
-Use FILE as the rakefile.
-.Pp
-.It Fl h
-.It Fl -help
-Prints a summary of options.
-.Pp
-.It Fl g
-.It Fl -system
-Using system wide (global) rakefiles (usually
-.Pa ~/.rake/*.rake
-).
-.Pp
-.It Fl n
-.It Fl -dry-run
-Do a dry run without executing actions.
-.Pp
-.It Fl p Ar CODE
-.It Fl -execute-print Ar CODE
+.TP
+\fB\-p\fR, \fB\-\-execute\-print\fR \fICODE\fR
Execute some Ruby code, print the result, then exit.
-.Pp
-.It Fl q
-.It Fl -quiet
+.TP
+\fB\-E\fR, \fB\-\-execute\-continue\fR \fICODE\fR
+Execute some Ruby code, then continue with normal task processing.
+
+.SS Information
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Log message to standard output.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
Do not log messages to standard output.
-.Pp
-.It Fl r Ar MODULE
-.It Fl -require Ar MODULE
-Require MODULE before executing rakefile.
-.Pp
-.It Fl s
-.It Fl -silent
-Like
-.Fl -quiet ,
-but also suppresses the 'in directory' announcement.
-.Pp
-.It Fl t
-.It Fl -trace
-Turn on invoke/execute tracing, enable full backtrace.
-.Pp
-.It Fl v
-.It Fl -verbose
-Log message to standard output (default).
-.Pp
-.It Fl -rules
-Trace the rules resolution.
-.Pp
-.El
-.Pp
-.Sh ENVIRONMENT
-.Bl -tag -width "RAKE_SYSTEM" -compact
-.It Ev RAKE_SYSTEM
-The directory path containing the system wide rakefiles.
-.Pp
-.It Ev RAKE_COLUMNS
-Override the number of columns used for output, such as
-.Fl Fl tasks
-.Pp
-.It Ev RAKEOPT
-Used to provide default command line arguments to Rake.
-.Pp
-.It Ev TAGS
-Generate an Emacs TAGS file
-.Pp
-.It Ev TEST
-The list of test files will be overridden to include only the filename specified on the command line.
-.Pp
-This provides an easy way to run just one test.
-.Pp
-.It Ev TESTOPTS
-.It Ev TESTOPT
-.It Ev TEST_OPTS
-.It Ev TEST_OPT
-The given options are passed to the test process after a
-.Fl Fl
-.Pp
-This allows Test::Unit options to be passed to the test suite.
-.Pp
-.It Ev USERPROFILE
-.It Ev HOME
-.It Ev HOMEDRIVE
-.It Ev HOMEPATH
-The standard directory containing system wide rake files on Win 32 systems.
+.TP
+\fB\-s\fR, \fB\-\-silent\fR
+Like \fB\-\-quiet\fR, but also suppresses the 'in directory' announcement.
+.TP
+\fB\-X\fR, \fB\-\-no\-deprecation\-warnings\fR
+Disable the deprecation warnings.
+.TP
+\fB\-\-comments\fR
+Show commented tasks only
+.TP
+\fB\-A\fR, \fB\-\-all\fR
+Show all tasks, even uncommented ones (in combination with \fB\-T\fR or \fB\-D\fR)
+.TP
+\fB\-\-job\-stats\fR [\fILEVEL\fR]
+Display job statistics. \fILEVEL=history\fR displays a complete job list
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Display the program version.
+.TP
+\fB\-h\fR, \fB\-H\fR, \fB\-\-help\fR
+Display a help message.
-.Sh SEE ALSO
-.Xr ruby 1
-.Xr make 1
-.Pp
-.Pa https://github.com/ruby/rake
-.Sh AUTHOR
-.Nm Rake
-is written by
-.An Jim Weirich Aq jim@weirichhouse.org
+.SH SEE ALSO
+The complete documentation for \fBrake\fR has been installed at \fI/usr/share/doc/rake-doc/html/index.html\fR. It is also available online at \fIhttp://docs.seattlerb.org/rake\fR.
+.SH AUTHOR
+.B rake
+was written by Jim Weirich <jim@weirichhouse.org>
+.PP
+This manual was created by Caitlin Matos <caitlin.matos@zoho.com> for the Debian project (but may be used by others). It was inspired by the manual by Jani Monoses <jani@iv.ro> for the Ubuntu project.