doc/make.1

   1 .TH MAKE 1 "28 February 2016" "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.  Use
 147 .I n
 148 to disable all previous debugging flags.
 149 .TP 0.5i
 150 \fB\-e\fR, \fB\-\-environment\-overrides\fR
 151 Give variables taken from the environment precedence over variables
 152 from makefiles.
 153 .TP 0.5i
 154 \fB\-E\fR \fIstring\fR, \fB\-\-eval\fR \fIstring\fR
 155 Interpret \fIstring\fR using the \fBeval\fR function, before parsing any
 156 makefiles.
 157 .TP 0.5i
 158 \fB\-f\fR \fIfile\fR, \fB\-\-file\fR=\fIfile\fR, \fB\-\-makefile\fR=\fIFILE\fR
 159 Use
 160 .I file
 161 as a makefile.
 162 .TP 0.5i
 163 \fB\-i\fR, \fB\-\-ignore\-errors\fR
 164 Ignore all errors in commands executed to remake files.
 165 .TP 0.5i
 166 \fB\-I\fR \fIdir\fR, \fB\-\-include\-dir\fR=\fIdir\fR
 167 Specifies a directory
 168 .I dir
 169 to search for included makefiles.
 170 If several
 171 .B \-I
 172 options are used to specify several directories, the directories are
 173 searched in the order specified.
 174 Unlike the arguments to other flags of
 175 .BR make ,
 176 directories given with
 177 .B \-I
 178 flags may come directly after the flag:
 179 .BI \-I dir
 180 is allowed, as well as
 181 .B \-I
 182 .IR dir .
 183 This syntax is allowed for compatibility with the C
 184 preprocessor's
 185 .B \-I
 186 flag.
 187 .TP 0.5i
 188 \fB\-j\fR [\fIjobs\fR], \fB\-\-jobs\fR[=\fIjobs\fR]
 189 Specifies the number of
 190 .I jobs
 191 (commands) to run simultaneously.
 192 If there is more than one
 193 .B \-j
 194 option, the last one is effective.
 195 If the
 196 .B \-j
 197 option is given without an argument,
 198 .BR make
 199 will not limit the number of jobs that can run simultaneously.
 200 .TP 0.5i
 201 \fB\-k\fR, \fB\-\-keep\-going\fR
 202 Continue as much as possible after an error.
 203 While the target that failed, and those that depend on it, cannot
 204 be remade, the other dependencies of these targets can be processed
 205 all the same.
 206 .TP 0.5i
 207 \fB\-l\fR [\fIload\fR], \fB\-\-load\-average\fR[=\fIload\fR]
 208 Specifies that no new jobs (commands) should be started if there are
 209 others jobs running and the load average is at least
 210 .I load
 211 (a floating-point number).
 212 With no argument, removes a previous load limit.
 213 .TP 0.5i
 214 \fB\-L\fR, \fB\-\-check\-symlink\-times\fR
 215 Use the latest mtime between symlinks and target.
 216 .TP 0.5i
 217 \fB\-n\fR, \fB\-\-just\-print\fR, \fB\-\-dry\-run\fR, \fB\-\-recon\fR
 218 Print the commands that would be executed, but do not execute them (except in
 219 certain circumstances).
 220 .TP 0.5i
 221 \fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR
 222 Do not remake the file
 223 .I file
 224 even if it is older than its dependencies, and do not remake anything
 225 on account of changes in
 226 .IR file .
 227 Essentially the file is treated as very old and its rules are ignored.
 228 .TP 0.5i
 229 \fB\-O\fR[\fItype\fR], \fB\-\-output\-sync\fR[=\fItype\fR]
 230 When running multiple jobs in parallel with \fB-j\fR, ensure the output of
 231 each job is collected together rather than interspersed with output from
 232 other jobs.  If
 233 .I type
 234 is not specified or is
 235 .B target
 236 the output from the entire recipe for each target is grouped together.  If
 237 .I type
 238 is
 239 .B line
 240 the output from each command line within a recipe is grouped together.
 241 If
 242 .I type
 243 is
 244 .B recurse
 245 output from an entire recursive make is grouped together.  If
 246 .I type
 247 is
 248 .B none
 249 output synchronization is disabled.
 250 .TP 0.5i
 251 \fB\-p\fR, \fB\-\-print\-data\-base\fR
 252 Print the data base (rules and variable values) that results from
 253 reading the makefiles; then execute as usual or as otherwise
 254 specified.
 255 This also prints the version information given by the
 256 .B \-v
 257 switch (see below).
 258 To print the data base without trying to remake any files, use
 259 .IR "make \-p \-f/dev/null" .
 260 .TP 0.5i
 261 \fB\-q\fR, \fB\-\-question\fR
 262 ``Question mode''.
 263 Do not run any commands, or print anything; just return an exit status
 264 that is zero if the specified targets are already up to date, nonzero
 265 otherwise.
 266 .TP 0.5i
 267 \fB\-r\fR, \fB\-\-no\-builtin\-rules\fR
 268 Eliminate use of the built\-in implicit rules.
 269 Also clear out the default list of suffixes for suffix rules.
 270 .TP 0.5i
 271 \fB\-R\fR, \fB\-\-no\-builtin\-variables\fR
 272 Don't define any built\-in variables.
 273 .TP 0.5i
 274 \fB\-s\fR, \fB\-\-silent\fR, \fB\-\-quiet\fR
 275 Silent operation; do not print the commands as they are executed.
 276 .TP 0.5i
 277 .B \-\-no\-silent
 278 Cancel the effect of the \fB\-s\fR option.
 279 .TP 0.5i
 280 \fB\-S\fR, \fB\-\-no\-keep\-going\fR, \fB\-\-stop\fR
 281 Cancel the effect of the
 282 .B \-k
 283 option.
 284 .TP 0.5i
 285 \fB\-t\fR, \fB\-\-touch\fR
 286 Touch files (mark them up to date without really changing them)
 287 instead of running their commands.
 288 This is used to pretend that the commands were done, in order to fool
 289 future invocations of
 290 .BR make .
 291 .TP 0.5i
 292 .B \-\-trace
 293 Information about the disposition of each target is printed (why the target is
 294 being rebuilt and what commands are run to rebuild it).
 295 .TP 0.5i
 296 \fB\-v\fR, \fB\-\-version\fR
 297 Print the version of the
 298 .B make
 299 program plus a copyright, a list of authors and a notice that there
 300 is no warranty.
 301 .TP 0.5i
 302 \fB\-w\fR, \fB\-\-print\-directory\fR
 303 Print a message containing the working directory
 304 before and after other processing.
 305 This may be useful for tracking down errors from complicated nests of
 306 recursive
 307 .B make
 308 commands.
 309 .TP 0.5i
 310 .B \-\-no\-print\-directory
 311 Turn off
 312 .BR \-w ,
 313 even if it was turned on implicitly.
 314 .TP 0.5i
 315 \fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR
 316 Pretend that the target
 317 .I file
 318 has just been modified.
 319 When used with the
 320 .B \-n
 321 flag, this shows you what would happen if you were to modify that file.
 322 Without
 323 .BR \-n ,
 324 it is almost the same as running a
 325 .I touch
 326 command on the given file before running
 327 .BR make ,
 328 except that the modification time is changed only in the imagination of
 329 .BR make .
 330 .TP 0.5i
 331 .B \-\-warn\-undefined\-variables
 332 Warn when an undefined variable is referenced.
 333 .SH "EXIT STATUS"
 334 GNU
 335 .B make
 336 exits with a status of zero if all makefiles were successfully parsed
 337 and no targets that were built failed.  A status of one will be returned
 338 if the
 339 .B \-q
 340 flag was used and
 341 .B make
 342 determines that a target needs to be rebuilt.  A status of two will be
 343 returned if any errors were encountered.
 344 .SH "SEE ALSO"
 345 The full documentation for
 346 .B make
 347 is maintained as a Texinfo manual.  If the
 348 .B info
 349 and
 350 .B make
 351 programs are properly installed at your site, the command
 352 .IP
 353 .B info make
 354 .PP
 355 should give you access to the complete manual.
 356 .SH BUGS
 357 See the chapter ``Problems and Bugs'' in
 358 .IR "The GNU Make Manual" .
 359 .SH AUTHOR
 360 This manual page contributed by Dennis Morse of Stanford University.
 361 Further updates contributed by Mike Frysinger.  It has been reworked by Roland
 362 McGrath.  Maintained by Paul Smith.
 363 .SH "COPYRIGHT"
 364 Copyright \(co 1992-1993, 1996-2020 Free Software Foundation, Inc.
 365 This file is part of
 366 .IR "GNU make" .
 367 .LP
 368 GNU Make is free software; you can redistribute it and/or modify it under the
 369 terms of the GNU General Public License as published by the Free Software
 370 Foundation; either version 3 of the License, or (at your option) any later
 371 version.
 372 .LP
 373 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
 374 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 375 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 376 .LP
 377 You should have received a copy of the GNU General Public License along with
 378 this program.  If not, see
 379 .IR http://www.gnu.org/licenses/ .