man/rake.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

.Dd November 30, 2008
.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
Do not search parent directories for the Rakefile.
.Pp
.It Fl P
.It Fl -prereqs
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
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
Execute some Ruby code, print the result, then exit.
.Pp
.It Fl q
.It Fl -quiet
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 SEE ALSO
.Xr ruby 1
.Xr make 1
.Pp
http://rake.rubyforge.org/
.Sh REPORTING BUGS
Bugs, features requests and other issues can be logged at
<\fBhttp://onestepback.org/redmine/projects/show/rake\fR>.
.Pp
You will need an account to before you can post issues. Register at <\fBhttp://onestepback.org/redmine/account/register\fR>.
Or you can send an email to the author.
.Sh AUTHOR
.Nm Rake
is written by
.An Jim Weirich Aq jim@weirichhouse.org