path: root/makeenv.1

.TH MAKEENV 1 MAKEENV
.SH NAME
makeenv - Run make(1) with environment loaded from .makeenv
.SH SYNPOSIS
.B makeenv
.RI [ arguments "] ..."
.SH DESCRIPTION
The
.B makeenv
utility opens the file
.I .makeenv
if it exists in the current working directory and scans it
for options, macros, and targets to specify along with the
provided
.I arguments
when it executes
.BR make (1).
Any macro listed in
.I .makeenv
is also put in the environment.
.PP
After loading
.I .makeenv
and adding populating the environment,
.B makeenv
will inspect it's environment,
.B makeenv
itself is affected by the environment variables, which
also are
.BR make (1)
macros; this if you need a specific implementation of
.BR make (1)
for a project, it can be specified in the
.I .makeenv
file.
.PP
When executng
.BR make (1),
.B makeenv
may reorder the
.IR arguments ,
and will put any option listed in
.I .makeenv
at the beginning, any macro listed in
.I .makeenv
before the macros in the
.IR arguments ,
and any target  listed in
.I .makeenv
before the targets in the
.IR arguments .
.PP
.B makeenv
is designed to be usable in place of
.BR make (1),
that is, the user can create add the
.B alias
.I makeenv=make
in his shell, without any adverse affect.
.B makeenv
will pass on it's arguments as is to
.BR make (1)
(or whichever utility is specified in the environment
variable
.I MAKEENV_MAKE
or the environment variable
.IR MAKE )
without validation or modifications, if the
.B .makeenv
does not exist.
.SH OPTIONS
The
.BR makeenv
utility passes it's options to the
.BR make (1)
utility and do not act on any of the it self, however
in order to properly interleave options and operands
specified in the
.I .makeenv
file, it have to understand which options take an argument
and which do not. By default, the
.BR makeenv
utility only understands the options specified by POSIX,
and the argumented option
.B -W
(vendor options), as well as long options that start with
two dashes
.RB (--)
provided that the same command line argument contains an
equals sign
.RB ( = ).
The user can modify the environment
variables to modify how the
.BR makeenv
utility understands the options. See the section
.B ENVIRONMENT VARIABLES
for more information. The current version only support
options that consist of a dash
.RB ( - )
followed by any other character and options that start
with two dashes
.RB ( -- ),
followed by at least one character, but may not contain
an equals sign
.RB ( = ),
as these are treated as delimiters between long options
and their associated argument.
.BR 
.SH STDIN
Not used.
.SH INPUT FILES
None.
.SH ENVIRONMENT VARIABLES
The following environment variables affect the execution of
.BR makeenv :
.TP
.I PATH
Default.
.TP
.IR MAKEENV_MAKE ", " MAKE
The command that shall be invoked by the utility.
The environment variable
.I MAKEENV_MAKE
has precedence over
.IR MAKE;
.I MAKE
is only used if
.I MAKEENV_MAKE
is not defined. If neither is defined, the default value
.B make
is used.
.TP
.I MAKEENV_OPTS_NO_ARG
List of options that
.B makeenv
shall interpret as
.BR make (1)
options that do not have any argument.
(Default is
.BR eiknpqrSst ,
meaning the options
.BR -e ,
.BR -i ,
.BR -k ,
.BR -n ,
.BR -p ,
.BR -q ,
.BR -r ,
.BR -S ,
.BR -s ,
and
.BR -t .)
.TP
.I MAKEENV_OPTS_ARG
List of options that
.B makeenv
shall interpret as
.BR make (1)
options that have an argument.
(Default is
.BR fW ,
meaning the options
.B -f
and
.BR -W .)
.TP
.I MAKEENV_OPTS_OPT_ATTACHED_ARG
List of options that
.B makeenv
shall interpret as
.BR make (1)
options that have an argument only if
there are additional characters after
the option character in the same
command line argument. (Default is
the empty string, meaning no options.)
.TP
.I MAKEENV_OPTS_OPT_ARG
List of options that
.B makeenv
shall interpret as
.BR make (1)
options that have an argument if there
are additional characters after
the option character in the same
command line argument or if argument is
followed directly by another argument
which does not start with a dash
.RB ( - ).
(Default is
the empty string, meaning no options.)
.TP
.I MAKEENV_LONG_OPTS_NO_ARG
Space-separated list of long options that
.B makeenv
shall interpret as
.BR make (1)
options that do not have any argument
unless it is followed directly by an
equals sign
.RB ( = )
in the same command line argument.
Options that do not start with two dashes
.RB ( -- )
are silently ignored. (Default is the
empty string, meaning no options.)
.TP
.I MAKEENV_LONG_OPTS_ARG
Space-separated list of long options that
.B makeenv
shall interpret as
.BR make (1)
options that have an argument that must
either be specified in the next command
line argument or after an
equals sign
.RB ( = )
the shall directly follow the option
string in the same command line argument.
Options that do not start with two dashes
.RB ( -- )
are silently ignored. (Default is the
empty string, meaning no options.)
.TP
.I MAKEENV_LONG_OPTS_OPT_ARG
Space-separated list of long options that
.B makeenv
shall interpret as
.BR make (1)
options that have an argument if it is
the option string is is directly followed
by equals sign
.RB ( = )
in the same command line argument or if
argument is followed directly by another
argument which does not start with a dash
.RB ( - ).
Options that do not start with two dashes
.RB ( -- )
are silently ignored. (Default is the
empty string, meaning no options.)
.PP
Any macro listed in
.I .makeenv
is loaded into the environment before the utility inspects
the environement.
.SH ASYNCHRONOUS EVENTS
Default.
.SH STDOUT
Not used.
.SH STDERR
The standard error is used only for diagnostic messages.
.SH OUTPUT FILES
None.
.SH EXTENDED DESCRIPTION
None.
.SH EXIT STATUS
If the
.BR make (1)
utility is invoked, the exit status of
.B makeenv
is the exit status of the
.BR make (1);
utility otherwise, the
.B makeenv
utility exits with one of the following values:
.TP
125
An error occurred in the
.B makeenv
utility.
.TP
126
The
.BR make (1)
utility was found but could not be invoked.
.TP
127
The
.BR make (1)
utility could not be found.
.SH CONSEQUENCES OF ERRORS
Default.
.SH FUTURE DIRECTIONS
None.
.SH SEE ALSO
.BR makeenv (5),
.BR make (1)