NAME¶
remake - A patched GNU make with a debuger, better tracing and error reporting
SYNOPSIS¶
remake [
-f makefile ] [ options ] ... [ targets ] ...
WARNING¶
This man page is an extract of the documentation of GNU
remake (
make + debugger). It is updated only occasionally, because the GNU
project does not use nroff. For complete, current documentation, refer to the
Info file
make.info and
mdb.info which are made from the Texinfo
source files
make.texi. and
mdb.texi The latter describes
debugger behavior.
DESCRIPTION¶
The purpose of the
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.
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.
See also the home <
http://bashdb.sf.net/remake> page for more information.
OPTIONS¶
- -b, -m
- These options are ignored for compatibility with other
versions of make.
- -B, --always-make
- Unconditionally make all targets.
- -C dir, --directory=dir
- Change to directory dir before reading the makefiles
or doing anything else. If multiple -C options are specified, each
is interpreted relative to the previous one: -C / -C etc is
equivalent to -C /etc. This is typically used with recursive
invocations of make.
- -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
make decides what to do.
- --debug[=FLAGS]
- Print debugging information in addition to normal
processing. If the FLAGS are omitted, then the behavior is the same
as if -d was specified. FLAGS may be a for all
debugging output (same as using -d), b for basic debugging,
v for more verbose basic debugging, i for showing implicit
rules, j for details on invocation of commands, and m for
debugging while remaking makefiles.
- --debugger[=FLAGS]
- Enter the debugger. If the FLAGS are omitted, then
the behavior is the same as if --debugger=full was specified.
FLAGS may be a for all debugging output (same as using
-d), 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.
fatal the debugger is only entered on encountering a fatal error.
preread the debugger is entered after command-line options are
parsed but before andy Makefiles have been read. It also sets step-tracing
mode. 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. full for basic
debugging,
- -e, --environment-overrides
- Give variables taken from the environment precedence over
variables from makefiles.
- +-f file, --file=file,
--makefile= FILE
- Use file as a makefile.
- -i, --ignore-errors
- Ignore all errors in commands executed to remake
files.
- -I dir, --include-dir=dir
- Specifies a directory dir to search for included
makefiles. If several -I options are used to specify several
directories, the directories are searched in the order specified. Unlike
the arguments to other flags of make, directories given with
-I flags may come directly after the flag: -Idir is
allowed, as well as -I dir. This syntax is allowed for
compatibility with the C preprocessor's -I flag.
- -j [jobs], --jobs[=jobs]
- Specifies the number of jobs (commands) to run
simultaneously. If there is more than one -j option, the last one
is effective. If the -j option is given without an argument,
remake will not limit the number of jobs that can run
simultaneously.
- -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.
- -l [load],
--load-average[=load]
- Specifies that no new jobs (commands) should be started if
there are others jobs running and the load average is at least load
(a floating-point number). With no argument, removes a previous load
limit.
- -L, --check-symlink-times
- Use the latest mtime between symlinks and target.
- -n, --just-print, --dry-run,
--recon
- Print the commands that would be executed, but do not
execute them.
- -o file, --old-file=file,
--assume-old= file
- Do not remake the file file even if it is older than
its dependencies, and do not remake anything on account of changes in
file. Essentially the file is treated as very old and its rules are
ignored.
- -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 -v
switch (see below). To print the data base without trying to remake any
files, use remake -p -f/dev/null.
- -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.
- -r, --no-builtin-rules
- Eliminate use of the built-in implicit rules. Also clear
out the default list of suffixes for suffix rules.
- -R, --no-builtin-variables
- Don't define any built-in variables.
- -s, --silent, --quiet
- Silent operation; do not print the commands as they are
executed.
- -S, --no-keep-going, --stop
- Cancel the effect of the -k option. This is never
necessary except in a recursive make where -k might be
inherited from the top-level make via MAKEFLAGS or if you set
-k in MAKEFLAGS in your environment.
- -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
remake.
- -v, --version
- Print the version of the make program plus a
copyright, a list of authors and a notice that there is no warranty.
- -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 make commands.
- --no-print-directory
- Turn off -w, even if it was turned on
implicitly.
- -W file, --what-if=file,
--new-file= file, --assume-new=file
- Pretend that the target file has just been modified.
When used with the -n flag, this shows you what would happen if you
were to modify that file. Without -n, it is almost the same as
running a touch command on the given file before running
make, except that the modification time is changed only in the
imagination of make.
- -x, --trace [=FLAGS]
- Sets up execution tracing. If FLAGS are omitted,
then the behavior is the same as if " --trace=full" was
specified. full normal tracing read show in addition status
on reading in makefiles full the most verbose tracing.
- --warn-undefined-variables
- Warn when an undefined variable is referenced.
EXIT STATUS¶
GNU
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
-q flag was used and
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.
SEE ALSO¶
The GNU Remake Manual and the
The GNU Remake Debugger Manual
BUGS¶
See the chapter `Problems and Bugs' in
The GNU Remake Manual.
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.