make.1

   1 .TH MAKE 1L "22 August 1989" "GNU" "LOCAL USER COMMANDS"
   2 .SH NAME
   3 make \- GNU make utility to maintain groups of programs
   4 .SH SYNOPSIS
   5 .B "make "
   6 [
   7 .B \-f
   8 makefile ] [ option ] ...
   9 target ...
  10 .SH WARNING
  11 This man paage is an extract of the documentation of
  12 .I GNU make .
  13 It is updated only occasionally, because the GNU project does not use nroff.
  14 For complete, current documentation, refer to the Info file
  15 .B make
  16 or the DVI file
  17 .B make.dvi
  18 which are made from the Texinfo source file
  19 .BR make.texinfo .
  20 .SH DESCRIPTION
  21 .LP
  22 The purpose of the
  23 .I make
  24 utility is to determine automatically which
  25 pieces of a large program need to be recompiled, and issue the commands to
  26 recompile them.
  27 This manual describes the GNU implementation of
  28 .IR make ,
  29 which was written by Richard Stallman and Roland McGrath.
  30 Our examples show C programs, since they are most common, but you can use
  31 .I make
  32 with any programming language whose compiler can be run with a
  33 shell command.
  34 In fact,
  35 .I make
  36 is not limited to programs.
  37 You can use it to describe any task where some files must be
  38 updated automatically from others whenever the others change.
  39 .LP
  40 To prepare to use
  41 .IR make ,
  42 you must write a file called the
  43 .I makefile
  44 that describes the relationships among files in your program, and the
  45 states the commands for updating each file.
  46 In a program, typically the executable file is updated from object
  47 files, which are in turn made by compiling source files.
  48 .LP
  49 Once a suitable makefile exists, each time you change some source files,
  50 this simple shell command:
  51 .sp 1
  52 .RS
  53 .B make
  54 .RE
  55 .sp 1
  56 suffices to perform all necessary recompilations.
  57 The
  58 .I make
  59 program uses the makefile data base and the last-modification times
  60 of the files to decide which of the files need to be updated.
  61 For each of those files, it issues the commands recorded in the data base.
  62 .LP
  63 .I make
  64 executes commands in the
  65 .I makefile
  66 to update
  67 one or more target
  68 .IR names ,
  69 where
  70 .I name
  71 is typically a program.
  72 If no
  73 .B \-f
  74 option is present,
  75 .I make
  76 will look for the makefiles
  77 .IR GNUmakefile ,
  78 .IR makefile ,
  79 and
  80 .IR Makefile ,
  81 in that order.
  82 .LP
  83 Normally you should call your makefile either
  84 .I makefile
  85 or
  86 .IR Makefile .
  87 (We recommend
  88 .I Makefile
  89 because it appears prominently near the beginning of a directory
  90 listing, right near other important files such as
  91 .IR  README .)
  92 The first name checked,
  93 .IR GNUmakefile ,
  94 is not recommended for most makefiles.
  95 You should use this name if you have a makefile that is specific to GNU
  96 .IR make ,
  97 and will not be understood by other versions of
  98 .IR make .
  99 If
 100 .I makefile
 101 is `\-', the standard input is read.
 102 .LP
 103 .I make
 104 updates a target if it depends on prerequisite files
 105 that have been modified since the target was last modified,
 106 or if the target does not exist.
 107 .SH OPTIONS
 108 .sp 1
 109 .TP 0.5i
 110 .B \-b
 111 .TP 0.5i
 112 .B \-m
 113 These options are ignored for compatibility with other versions of
 114 .IR make .
 115 .TP 0.5i
 116 .BI "\-C " dir
 117 Change to directory
 118 .I dir
 119 before reading the makefiles or doing anything else.
 120 If multiple
 121 .B \-C
 122 options are specified, each is interpreted relative to the
 123 previous one:
 124 .BR "\-C " /
 125 .BR "\-C " etc
 126 is equivalent to
 127 .BR "\-C " /etc.
 128 This is typically used with recursive invocations of
 129 .IR make .
 130 .TP 0.5i
 131 .B \-d
 132 Print debugging information in addition to normal processing.
 133 The debugging information says which files are being considered for
 134 remaking, which file-times are being compared and with what results,
 135 which files actually need to be remade, which implicit rules are
 136 considered and which are applied---everything interesting about how
 137 .I make
 138 decides what to do.
 139 .TP 0.5i
 140 .B \-e
 141 Give variables taken from the environment precedence
 142 over variables from makefiles.
 143 .TP 0.5i
 144 .BI "\-f " file
 145 Use
 146 .I file
 147 as a makefile.
 148 .TP 0.5i
 149 .B \-i
 150 Ignore all errors in commands executed to remake files.
 151 .TP 0.5i
 152 .BI "\-I " dir
 153 Specifies a directory
 154 .I dir
 155 to search for included makefiles.
 156 If several
 157 .B \-I
 158 options are used to specify several directories, the directories are
 159 searched in the order specified.
 160 Unlike the arguments to other flags of
 161 .IR make ,
 162 directories given with
 163 .B \-I
 164 flags may come directly after the flag:
 165 .BI \-I dir
 166 is allowed, as well as
 167 .BI "\-I " dir.
 168 This syntax is allowed for compatibility with the C
 169 preprocessor's
 170 .B \-I
 171 flag.
 172 .TP 0.5i
 173 .BI "\-j " jobs
 174 Specifies the number of jobs (commands) to run simultaneously.
 175 If there is more than one
 176 .B \-j
 177 option, the last one is effective.
 178 If the
 179 .B \-j
 180 option is given without an argument,
 181 .IR make
 182 will not limit the number of jobs that can run simultaneously.
 183 .TP 0.5i
 184 .B \-k
 185 Continue as much as possible after an error.
 186 While the target that failed, and those that depend on it, cannot
 187 be remade, the other dependencies of these targets can be processed
 188 all the same.
 189 .TP 0.5i
 190 .B \-l
 191 .TP 0.5i
 192 .BI "\-l " load
 193 Specifies that no new jobs (commands) should be started if there are
 194 others jobs running and the load average is at least
 195 .I load
 196 (a floating-point number).
 197 With no argument, removes a previous load limit.
 198 .TP 0.5i
 199 .B \-n
 200 Print the commands that would be executed, but do not execute them.
 201 .TP 0.5i
 202 .BI "\-o " file
 203 Do not remake the file
 204 .I file
 205 even if it is older than its dependencies, and do not remake anything
 206 on account of changes in
 207 .IR file .
 208 Essentially the file is treated as very old and its rules are ignored.
 209 .TP 0.5i
 210 .B \-p
 211 Print the data base (rules and variable values) that results from
 212 reading the makefiles; then execute as usual or as otherwise
 213 specified.
 214 This also prints the version information given by the
 215 .B \-v
 216 switch (see below).
 217 To print the data base without trying to remake any files, use
 218 .B make
 219 .B \-p
 220 .BI \-f /dev/null.
 221 .TP 0.5i
 222 .B \-q
 223 ``Question mode''.
 224 Do not run any commands, or print anything; just return an exit status
 225 that is zero if the specified targets are already up to date, nonzero
 226 otherwise.
 227 .TP 0.5i
 228 .B \-r
 229 Eliminate use of the built-in implicit rules.
 230 Also clear out the default list of suffixes for suffix rules.
 231 .TP 0.5i
 232 .B \-s
 233 Silent operation; do not print the commands as they are executed.
 234 .TP 0.5i
 235 .B \-S
 236 Cancel the effect of the
 237 .B \-k
 238 option.
 239 This is never necessary except in a recursive
 240 .I make
 241 where
 242 .B \-k
 243 might be inherited from the top-level
 244 .I make
 245 via MAKEFLAGS or if you set
 246 .B \-k
 247 in MAKEFLAGS in your environment.
 248 .TP 0.5i
 249 .B \-t
 250 Touch files (mark them up to date without really changing them)
 251 instead of running their commands.
 252 This is used to pretend that the commands were done, in order to fool
 253 future invocations of
 254 .IR make .
 255 .TP 0.5i
 256 .B \-v
 257 Print the version of the
 258 .I make
 259 program plus a copyright, a list of authors and a notice that there
 260 is no warranty.
 261 After this information is printed, processing continues normally.
 262 To get this information without doing anything else, use
 263 .B make
 264 .B \-v
 265 .BI \-f /dev/null.
 266 .TP 0.5i
 267 .B \-w
 268 Print a message containing the working directory
 269 before and after other processing.
 270 This may be useful for tracking down errors from complicated nests of
 271 recursive
 272 .I make
 273 commands.
 274 .TP 0.5i
 275 .BI "\-W " file
 276 Pretend that the target
 277 .I file
 278 has just been modified.
 279 When used with the
 280 .B \-n
 281 flag, this shows you what would happen if you were to modify that file.
 282 Without
 283 .BR \-n ,
 284 it is almost the same as running a
 285 .I touch
 286 command on the given file before running
 287 .IR make ,
 288 except that the modification time is changed only in the imagination of
 289 .IR make .
 290 .SH "SEE ALSO"
 291 .PD 0
 292 .TP 2.0i
 293 /usr/local/doc/gnumake.dvi
 294 .I
 295 The GNU Make Manual
 296 .PD
 297 .SH BUGS
 298 See the chapter `Problems and Bugs' in
 299 .I "The GNU Make Manual" .
 300 .SH AUTHOR
 301 This manual page contributed by Dennis Morse of Stanford University.
 302 It has been reworked by Roland McGrath.