make.1

   1 .TH MAKE 1 "03 March 2012" "GNU" "User Commands"
   2 .SH NAME
   3 make \- GNU make utility to maintain groups of programs
   4 .SH SYNOPSIS
   5 .B make
   6 [\fIOPTION\fR]... [\fITARGET\fR]...
   7 .SH DESCRIPTION
   8 .LP
   9 The
  10 .I make
  11 utility will determine automatically which pieces of a large program need to
  12 be recompiled, and issue the commands to recompile them.  The manual describes
  13 the GNU implementation of
  14 .BR make ,
  15 which was written by Richard Stallman and Roland McGrath, and is currently
  16 maintained by Paul Smith.  Our examples show C programs, since they are very
  17 common, but you can use
  18 .B make
  19 with any programming language whose compiler can be run with a shell command.
  20 In fact,
  21 .B make
  22 is not limited to programs.  You can use it to describe any task where some
  23 files must be updated automatically from others whenever the others change.
  24 .LP
  25 To prepare to use
  26 .BR make ,
  27 you must write a file called the
  28 .I makefile
  29 that describes the relationships among files in your program, and the states
  30 the commands for updating each file.  In a program, typically the executable
  31 file is updated from object files, which are in turn made by compiling source
  32 files.
  33 .LP
  34 Once a suitable makefile exists, each time you change some source files,
  35 this simple shell command:
  36 .sp 1
  37 .RS
  38 .B make
  39 .RE
  40 .sp 1
  41 suffices to perform all necessary recompilations.
  42 The
  43 .B make
  44 program uses the makefile description and the last-modification times of the
  45 files to decide which of the files need to be updated.  For each of those
  46 files, it issues the commands recorded in the makefile.
  47 .LP
  48 .B make
  49 executes commands in the
  50 .I makefile
  51 to update one or more target
  52 .IR names ,
  53 where
  54 .I name
  55 is typically a program.
  56 If no
  57 .B \-f
  58 option is present,
  59 .B make
  60 will look for the makefiles
  61 .IR GNUmakefile ,
  62 .IR makefile ,
  63 and
  64 .IR Makefile ,
  65 in that order.
  66 .LP
  67 Normally you should call your makefile either
  68 .I makefile
  69 or
  70 .IR Makefile .
  71 (We recommend
  72 .I Makefile
  73 because it appears prominently near the beginning of a directory
  74 listing, right near other important files such as
  75 .IR  README .)
  76 The first name checked,
  77 .IR GNUmakefile ,
  78 is not recommended for most makefiles.  You should use this name if you have a
  79 makefile that is specific to GNU
  80 .BR make ,
  81 and will not be understood by other versions of
  82 .BR make .
  83 If
  84 .I makefile
  85 is '\-', the standard input is read.
  86 .LP
  87 .B make
  88 updates a target if it depends on prerequisite files
  89 that have been modified since the target was last modified,
  90 or if the target does not exist.
  91 .SH OPTIONS
  92 .sp 1
  93 .TP 0.5i
  94 \fB\-b\fR, \fB\-m\fR
  95 These options are ignored for compatibility with other versions of
  96 .BR make .
  97 .TP 0.5i
  98 \fB\-B\fR, \fB\-\-always\-make\fR
  99 Unconditionally make all targets.
 100 .TP 0.5i
 101 \fB\-C\fR \fIdir\fR, \fB\-\-directory\fR=\fIdir\fR
 102 Change to directory
 103 .I dir
 104 before reading the makefiles or doing anything else.
 105 If multiple
 106 .B \-C
 107 options are specified, each is interpreted relative to the
 108 previous one:
 109 .BR "\-C " /
 110 .BR "\-C " etc
 111 is equivalent to
 112 .BR "\-C " /etc.
 113 This is typically used with recursive invocations of
 114 .BR make .
 115 .TP 0.5i
 116 .B \-d
 117 Print debugging information in addition to normal processing.
 118 The debugging information says which files are being considered for
 119 remaking, which file-times are being compared and with what results,
 120 which files actually need to be remade, which implicit rules are
 121 considered and which are applied---everything interesting about how
 122 .B make
 123 decides what to do.
 124 .TP 0.5i
 125 .BI \-\-debug "[=FLAGS]"
 126 Print debugging information in addition to normal processing.
 127 If the
 128 .I FLAGS
 129 are omitted, then the behavior is the same as if
 130 .B \-d
 131 was specified.
 132 .I FLAGS
 133 may be
 134 .I a
 135 for all debugging output (same as using
 136 .BR \-d ),
 137 .I b
 138 for basic debugging,
 139 .I v
 140 for more verbose basic debugging,
 141 .I i
 142 for showing implicit rules,
 143 .I j
 144 for details on invocation of commands, and
 145 .I m
 146 for debugging while remaking makefiles.
 147 .TP 0.5i
 148 \fB\-e\fR, \fB\-\-environment\-overrides\fR
 149 Give variables taken from the environment precedence
 150 over variables from makefiles.
 151 .TP 0.5i
 152 \fB\-f\fR \fIfile\fR, \fB\-\-file\fR=\fIfile\fR, \fB\-\-makefile\fR=\fIFILE\fR
 153 Use
 154 .I file
 155 as a makefile.
 156 .TP 0.5i
 157 \fB\-i\fR, \fB\-\-ignore\-errors\fR
 158 Ignore all errors in commands executed to remake files.
 159 .TP 0.5i
 160 \fB\-I\fR \fIdir\fR, \fB\-\-include\-dir\fR=\fIdir\fR
 161 Specifies a directory
 162 .I dir
 163 to search for included makefiles.
 164 If several
 165 .B \-I
 166 options are used to specify several directories, the directories are
 167 searched in the order specified.
 168 Unlike the arguments to other flags of
 169 .BR make ,
 170 directories given with
 171 .B \-I
 172 flags may come directly after the flag:
 173 .BI \-I dir
 174 is allowed, as well as
 175 .B \-I
 176 .IR dir .
 177 This syntax is allowed for compatibility with the C
 178 preprocessor's
 179 .B \-I
 180 flag.
 181 .TP 0.5i
 182 \fB\-j\fR [\fIjobs\fR], \fB\-\-jobs\fR[=\fIjobs\fR]
 183 Specifies the number of
 184 .I jobs
 185 (commands) to run simultaneously.
 186 If there is more than one
 187 .B \-j
 188 option, the last one is effective.
 189 If the
 190 .B \-j
 191 option is given without an argument,
 192 .BR make
 193 will not limit the number of jobs that can run simultaneously.
 194 .TP 0.5i
 195 \fB\-k\fR, \fB\-\-keep\-going\fR
 196 Continue as much as possible after an error.
 197 While the target that failed, and those that depend on it, cannot
 198 be remade, the other dependencies of these targets can be processed
 199 all the same.
 200 .TP 0.5i
 201 \fB\-l\fR [\fIload\fR], \fB\-\-load\-average\fR[=\fIload\fR]
 202 Specifies that no new jobs (commands) should be started if there are
 203 others jobs running and the load average is at least
 204 .I load
 205 (a floating-point number).
 206 With no argument, removes a previous load limit.
 207 .TP 0.5i
 208 \fB\-L\fR, \fB\-\-check\-symlink\-times\fR
 209 Use the latest mtime between symlinks and target.
 210 .TP 0.5i
 211 \fB\-n\fR, \fB\-\-just\-print\fR, \fB\-\-dry\-run\fR, \fB\-\-recon\fR
 212 Print the commands that would be executed, but do not execute them (except in
 213 certain circumstances).
 214 .TP 0.5i
 215 \fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR
 216 Do not remake the file
 217 .I file
 218 even if it is older than its dependencies, and do not remake anything
 219 on account of changes in
 220 .IR file .
 221 Essentially the file is treated as very old and its rules are ignored.
 222 .TP 0.5i
 223 \fB\-p\fR, \fB\-\-print\-data\-base\fR
 224 Print the data base (rules and variable values) that results from
 225 reading the makefiles; then execute as usual or as otherwise
 226 specified.
 227 This also prints the version information given by the
 228 .B \-v
 229 switch (see below).
 230 To print the data base without trying to remake any files, use
 231 .IR "make \-p \-f/dev/null" .
 232 .TP 0.5i
 233 \fB\-q\fR, \fB\-\-question\fR
 234 ``Question mode''.
 235 Do not run any commands, or print anything; just return an exit status
 236 that is zero if the specified targets are already up to date, nonzero
 237 otherwise.
 238 .TP 0.5i
 239 \fB\-r\fR, \fB\-\-no\-builtin\-rules\fR
 240 Eliminate use of the built\-in implicit rules.
 241 Also clear out the default list of suffixes for suffix rules.
 242 .TP 0.5i
 243 \fB\-R\fR, \fB\-\-no\-builtin\-variables\fR
 244 Don't define any built\-in variables.
 245 .TP 0.5i
 246 \fB\-s\fR, \fB\-\-silent\fR, \fB\-\-quiet\fR
 247 Silent operation; do not print the commands as they are executed.
 248 .TP 0.5i
 249 \fB\-S\fR, \fB\-\-no\-keep\-going\fR, \fB\-\-stop\fR
 250 Cancel the effect of the
 251 .B \-k
 252 option.
 253 This is never necessary except in a recursive
 254 .B make
 255 where
 256 .B \-k
 257 might be inherited from the top-level
 258 .B make
 259 via MAKEFLAGS or if you set
 260 .B \-k
 261 in MAKEFLAGS in your environment.
 262 .TP 0.5i
 263 \fB\-t\fR, \fB\-\-touch\fR
 264 Touch files (mark them up to date without really changing them)
 265 instead of running their commands.
 266 This is used to pretend that the commands were done, in order to fool
 267 future invocations of
 268 .BR make .
 269 .TP 0.5i
 270 .B \-\-trace
 271 Print information about the commands invoked by
 272 .BR make.
 273 .TP 0.5i
 274 \fB\-v\fR, \fB\-\-version\fR
 275 Print the version of the
 276 .B make
 277 program plus a copyright, a list of authors and a notice that there
 278 is no warranty.
 279 .TP 0.5i
 280 \fB\-w\fR, \fB\-\-print\-directory\fR
 281 Print a message containing the working directory
 282 before and after other processing.
 283 This may be useful for tracking down errors from complicated nests of
 284 recursive
 285 .B make
 286 commands.
 287 .TP 0.5i
 288 .B \-\-no\-print\-directory
 289 Turn off
 290 .BR \-w ,
 291 even if it was turned on implicitly.
 292 .TP 0.5i
 293 \fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR
 294 Pretend that the target
 295 .I file
 296 has just been modified.
 297 When used with the
 298 .B \-n
 299 flag, this shows you what would happen if you were to modify that file.
 300 Without
 301 .BR \-n ,
 302 it is almost the same as running a
 303 .I touch
 304 command on the given file before running
 305 .BR make ,
 306 except that the modification time is changed only in the imagination of
 307 .BR make .
 308 .TP 0.5i
 309 .B \-\-warn\-undefined\-variables
 310 Warn when an undefined variable is referenced.
 311 .SH "EXIT STATUS"
 312 GNU
 313 .B make
 314 exits with a status of zero if all makefiles were successfully parsed
 315 and no targets that were built failed.  A status of one will be returned
 316 if the
 317 .B \-q
 318 flag was used and
 319 .B make
 320 determines that a target needs to be rebuilt.  A status of two will be
 321 returned if any errors were encountered.
 322 .SH "SEE ALSO"
 323 The full documentation for
 324 .B make
 325 is maintained as a Texinfo manual.  If the
 326 .B info
 327 and
 328 .B make
 329 programs are properly installed at your site, the command
 330 .IP
 331 .B info make
 332 .PP
 333 should give you access to the complete manual.
 334 .SH BUGS
 335 See the chapter ``Problems and Bugs'' in
 336 .IR "The GNU Make Manual" .
 337 .SH AUTHOR
 338 This manual page contributed by Dennis Morse of Stanford University.
 339 Further updates contributed by Mike Frysinger.  It has been reworked by Roland
 340 McGrath.  Maintained by Paul Smith.
 341 .SH "COPYRIGHT"
 342 Copyright \(co 1992-1993, 1996-2012 Free Software Foundation, Inc.
 343 This file is part of
 344 .IR "GNU make" .
 345 .LP
 346 GNU Make is free software; you can redistribute it and/or modify it under the
 347 terms of the GNU General Public License as published by the Free Software
 348 Foundation; either version 3 of the License, or (at your option) any later
 349 version.
 350 .LP
 351 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
 352 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 353 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 354 .LP
 355 You should have received a copy of the GNU General Public License along with
 356 this program.  If not, see
 357 .IR http://www.gnu.org/licenses/ .