.\" -*- nroff -*- .TH REMAKE 1 "25 February 2007" "GNU" "LOCAL USER COMMANDS" .SH NAME remake \- A patched GNU make with a debuger, better tracing and error reporting .SH SYNOPSIS .B "remake " [ .B \-f .I makefile ] [ options ] ... [ targets ] ... .SH WARNING This man page is an extract of the documentation of GNU .IR remake ( .IR make + debugger). It is updated only occasionally, because the GNU project does not use nroff. For complete, current documentation, refer to the Info file .B make.info and .B mdb.info which are made from the Texinfo source files .BR make.texi . and .BR mdb.texi The latter describes debugger behavior. .SH DESCRIPTION .LP The purpose of the .I make utility is to determine automatically which pieces of a large program need to be recompiled, and issue the commands to recompile them. See documentation on GNU make for more information. .PP However in this patched version we add a debugger which can be entered either initially (option -X or --debugger) or on an error (--debugger=error). We also add better tracing facilities (option -x) and we report postion information better. When an error is encountered more information is given automatically. .PP See also the home page for more information. .SH OPTIONS .sp 1 .TP 0.5i .BR \-b , " \-m" These options are ignored for compatibility with other versions of .IR make . .TP 0.5i .BR \-B , " \-\-always\-make" Unconditionally make all targets. .TP 0.5i \fB\-C\fR \fIdir\fR, \fB\-\-directory\fR=\fIdir\fR Change to directory .I dir before reading the makefiles or doing anything else. If multiple .B \-C options are specified, each is interpreted relative to the previous one: .BR "\-C " / .BR "\-C " etc is equivalent to .BR "\-C " /etc. This is typically used with recursive invocations of .IR make . .TP 0.5i .B \-d Print debugging information in addition to normal processing. The debugging information says which files are being considered for remaking, which file-times are being compared and with what results, which files actually need to be remade, which implicit rules are considered and which are applied---everything interesting about how .I make decides what to do. .TP 0.5i .BI \-\-debug "[=FLAGS]" Print debugging information in addition to normal processing. If the .I FLAGS are omitted, then the behavior is the same as if .B \-d was specified. .I FLAGS may be .I a for all debugging output (same as using .BR \-d ), .I b for basic debugging, .I v for more verbose basic debugging, .I i for showing implicit rules, .I j for details on invocation of commands, and .I m for debugging while remaking makefiles. .TP 0.5i .BI \-\-debugger "[=FLAGS]" Enter the debugger. If the .I FLAGS are omitted, then the behavior is the same as if .B \-\-debugger=full was specified. .I FLAGS may be .I a for all debugging output (same as using .BR \-d ), .I error the debugger is only entered on encountering an error. It may be possible to quit the debugger and continue processing. So the overall effect could be like the " \-\-keep\-going" switch. .I fatal the debugger is only entered on encountering a fatal error. .I preread the debugger is entered after command-line options are parsed but before andy Makefiles have been read. It also sets step-tracing mode. .I preaction Enters the debugger after command-line options are parsed and after Makefiles have been read, but before any action is performed. It also sets step-tracing mode. .I full for basic debugging, .TP 0.5i .BR \-e , " \-\-environment\-overrides" Give variables taken from the environment precedence over variables from makefiles. .TP 0.5i +\fB\-f\fR \fIfile\fR, \fB\-\-file\fR=\fIfile\fR, \fB\-\-makefile\fR=\fIFILE\fR Use .I file as a makefile. .TP 0.5i .BR \-i , " \-\-ignore\-errors" Ignore all errors in commands executed to remake files. .TP 0.5i \fB\-I\fR \fIdir\fR, \fB\-\-include\-dir\fR=\fIdir\fR Specifies a directory .I dir to search for included makefiles. If several .B \-I options are used to specify several directories, the directories are searched in the order specified. Unlike the arguments to other flags of .IR make , directories given with .B \-I flags may come directly after the flag: .BI \-I dir is allowed, as well as .BI "\-I " dir. This syntax is allowed for compatibility with the C preprocessor's .B \-I flag. .TP 0.5i \fB\-j\fR [\fIjobs\fR], \fB\-\-jobs\fR[=\fIjobs\fR] Specifies the number of .I jobs (commands) to run simultaneously. If there is more than one .B \-j option, the last one is effective. If the .B \-j option is given without an argument, .IR remake will not limit the number of jobs that can run simultaneously. .TP 0.5i .BR \-k , " \-\-keep\-going" Continue as much as possible after an error. While the target that failed, and those that depend on it, cannot be remade, the other dependencies of these targets can be processed all the same. .TP 0.5i \fB\-l\fR [\fIload\fR], \fB\-\-load\-average\fR[=\fIload\fR] Specifies that no new jobs (commands) should be started if there are others jobs running and the load average is at least .I load (a floating-point number). With no argument, removes a previous load limit. .TP 0.5i .BR \-L , " \-\-check\-symlink\-times" Use the latest mtime between symlinks and target. .TP 0.5i .BR \-n , " \-\-just\-print" , " \-\-dry\-run" , " \-\-recon" Print the commands that would be executed, but do not execute them. .TP 0.5i \fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR Do not remake the file .I file even if it is older than its dependencies, and do not remake anything on account of changes in .IR file . Essentially the file is treated as very old and its rules are ignored. .TP 0.5i .BR \-p , " \-\-print\-data\-base" Print the data base (rules and variable values) that results from reading the makefiles; then execute as usual or as otherwise specified. This also prints the version information given by the .B \-v switch (see below). To print the data base without trying to remake any files, use .B remake .B \-p .BI \-f /dev/null. .TP 0.5i .BR \-q , " \-\-question" ``Question mode''. Do not run any commands, or print anything; just return an exit status that is zero if the specified targets are already up to date, nonzero otherwise. .TP 0.5i .BR \-r , " \-\-no\-builtin\-rules" Eliminate use of the built\-in implicit rules. Also clear out the default list of suffixes for suffix rules. .TP 0.5i .BR \-R , " \-\-no\-builtin\-variables" Don't define any built\-in variables. .TP 0.5i .BR \-s , " \-\-silent" , " \-\-quiet" Silent operation; do not print the commands as they are executed. .TP 0.5i .BR \-S , " \-\-no\-keep\-going" , " \-\-stop" Cancel the effect of the .B \-k option. This is never necessary except in a recursive .I make where .B \-k might be inherited from the top-level .I make via MAKEFLAGS or if you set .B \-k in MAKEFLAGS in your environment. .TP 0.5i .BR \-t , " \-\-touch" Touch files (mark them up to date without really changing them) instead of running their commands. This is used to pretend that the commands were done, in order to fool future invocations of .IR remake . .TP 0.5i .BR \-v , " \-\-version" Print the version of the .I make program plus a copyright, a list of authors and a notice that there is no warranty. .TP 0.5i .BR \-w , " \-\-print\-directory" Print a message containing the working directory before and after other processing. This may be useful for tracking down errors from complicated nests of recursive .I make commands. .TP 0.5i .B \-\-no\-print\-directory Turn off .BR \-w , even if it was turned on implicitly. .TP 0.5i \fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR Pretend that the target .I file has just been modified. When used with the .B \-n flag, this shows you what would happen if you were to modify that file. Without .BR \-n , it is almost the same as running a .I touch command on the given file before running .IR make , except that the modification time is changed only in the imagination of .IR make . .TP 0.5i .BI \-x , " \-\-trace "[=FLAGS] Sets up execution tracing. If .I FLAGS are omitted, then the behavior is the same as if " \-\-trace=full" was specified. .I full normal tracing .I read show in addition status on reading in makefiles .I full the most verbose tracing. .TP 0.5i .B \-\-warn\-undefined\-variables Warn when an undefined variable is referenced. .SH "EXIT STATUS" GNU .I remake exits with a status of zero if all makefiles were successfully parsed and no targets that were built failed. A status of one will be returned if the .B \-q flag was used and .I make determines that a target needs to be rebuilt. A status of two will be returned if any errors were encountered. An exit status of 77 can be given when quitting from the debugger out of a recursive invocation. .SH "SEE ALSO" .I "The GNU Remake Manual" and the .I "The GNU Remake Debugger Manual" .SH BUGS See the chapter `Problems and Bugs' in .IR "The GNU Remake Manual" . .SH AUTHOR This manual page contributed by Dennis Morse of Stanford University. It has been reworked by Roland McGrath. Further updates contributed by Mike Frysinger and Rocky Bernstein.