'\" t
.\" aegis - project change supervisor
.\" Copyright (C) 1991-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 1997, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.ds n) aegis
.ds N) Aegis
.if n .nr )M 8n
.if n .nr IN 8n
.if n .nr )I 8n
.if n .po 0
.hy 0
.if n .ad l
.de r)
.if !'\\*(R)'no' \{\
.PP
See also
.IR \*(n) (1)
for options common to all \*(n) commands.
.\}
..
.de eB
.RS
.nf
.ft CW
.ta 8n 16n 24n 32n
..
.de eE
.ft P
.fi
.RE
..
.TH "\*(n) -Build" 1 \*(N) "Reference Manual"
.SH NAME
aegis build \- build a change
.XX "aeb(1)" "build a change"
.SH SYNOPSIS
.B \*(n)
.B -Build
[
.IR option ...
][
.IR filename ...
]
.br
.B \*(n)
.B -Build
.B -List
[
.IR option ...
]
.br
.B \*(n)
.B -Build
.B -Help
.SH DESCRIPTION
The
.I \*(n)
.I -Build
command is used to
build a project.
The project configuration file is consulted for the
appropriate build command,
and that command is executed
(see
the \fIbuild_\% command\fP
and \fIintegration_\%build_\%command\fP
fields in
.IR aepconf (5)
for more information.)
Output of the command is automatically logged to the
.I \*(n).log
file at the root of the development directory tree.
The build command will be executed with its current directory being
the root of the development directory,
irrespective of there the
.I "\*(n) -Build"
command was executed.
.PP
If the change is in the
.I "being integrated"
state,
references to the development directory, above,
should be read as the integration directory.
Integration build commands are executed with the user and group
set to the project's owning user and group.
That is,
it is not necessary for an integrator to log in as someone else,
the project account for instance,
in order to do an integration.
.SS "No Build Required"
It is possible to configure your project so that no build is required.
To do this, set the following
.RS
build_command = "exit 0";
.RE
in the project configuration file.
.SS Process Side Effects
This command will cancel any test registrations,
because building the project logically invalidates them.
If the project
configuration
file was deleted,
any diff registration will also be canceled.
.SS Notification
The actions of the command are controlled by the \fIbuild_\% command\fP
and \fIintegration_\%build_\%command\fP fields of the project \fIconfig\fP
file. See \fIaepconf\fP(5) for more information.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 2005-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.SS File Action Adjustment
When this command runs, it first checks the change files against the
projects files. If there are inconsistencies, the file actions will be
adjusted as follows:
.TP 8n
create
If a file is being created, but another change set is integrated which
also creates the file, the file action in the change set still being
developed will be adjusted to "modify".
.TP 8n
modify
If a file is being modified, but another change set is integrated
which removes the file, the file action in the change set still being
developed will be adjusted to "create".
.TP 8n
remove
If a file is being removed, but another change set is integrated which
removes the file, the file will be dropped from the change set still
being developed.
.SH PARTIAL BUILD
If files are named on the command line,
these files are appended to the build command.
This is known as a partial build.
Partial builds are not legal in the
.I "being integrated"
state,
but can often be useful in the
.I "being developed"
state.
Partial builds are not recorded in the change status,
because builds are decoupled from aegis it is not
possible for aegis to know if any set of partial builds is equivalent
to a full build.
.PP
Warning:
no change state lock is taken for a partial build,
only a baseline read lock.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 1999, 2002, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.SS File Name Interpretation
The \*(n) program will attempt to determine the project file names
from the file names given on the command line.
All file names are stored within \*(n) projects as relative to
the root of the baseline directory tree.
The development directory and the integration directory are shadows of
this baseline directory, and so these relative names apply here, too.
Files named on the command line
are first converted to absolute paths if necessary.
They are then compared with the baseline path,
the development directory path,
and the integration directory path,
to determine a baseline-relative name.
It is an error if the file named is outside
one of these directory trees.
.PP
The \fB-BAse_RElative\fP option may be used to cause relative filenames
to be interpreted as relative to the baseline path; absolute filenames
will still be compared with the various paths in order to determine a
baseline-relative name.
.PP
The \fIrelative_filename_preference\fP in the user configuration file
may be used to modify this default behavior. See \fIaeuconf\fP(5) for
more information.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1994, 1996, 1998, 1999, 2004, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.SH SYMBOLIC LINKS
Many dependency maintenance tools, and indeed some compilers, have
little or no support for include file search paths, and thus for the
concept of the two-level directory hierarchy employed by Aegis. (It
becomes multi-level when Aegis' branching functionality is used.) To
allow these tools to be used, Aegis provides the ability to maintain a
set of symbolic links between the development directory of a change and
the baseline of a project, so it appears to these tools that all of the
project's files are present in the development directory.
.SS Project Configuration
The \fIdevelopment_\%directory_\%style\fP field of the project
configuration file controls the appearance of the development directory.
See \fIaepconf\fP(5) for more information.
.PP
By using a setting such as
.RS
.nf
.ft CW
development_directory_style =
{
source_file_symlink = true;
during_build_only = true;
};
.ft R
.fi
.RE
the user never sees the symbolic links, because they are added purely
for the benefit of the dependency maintenance tool during the execution
of the \fIaeb\fP(1) command.
.PP
By using a setting such as
.RS
.nf
.ft CW
development_directory_style =
{
source_file_symlink = true;
};
.ft R
.fi
.RE
(the other will default to false) the symbolic links will be created at
develop begin time (see \fIaedb\fP(1) for more information) and also
maintained by each \fIaeb\fP(1) invocation. Note that the symbolic
links are only maintained at these times, so project integrations during
the course of editing change sourec files may leave the symbolic links
in an inconsistent state until the next build.
.PP
When files are copied from the baseline into a change, using the
\fIaecp\fP(1) command, the symbolic link pointing into the baseline, if
any, will be removed before the file is copied.
.PP
\fBNote:\fP Using this functionality in either form has implications for
how the rules file of the dependency maintenance tool is written. Rules
must \fIremove\fP their targets before creating them (usually with an
\fIrm \-f\fP command) if you use any of the link sub-fields (both hard
links and symbolic links). This is to avoid attempting to write the
result on the symbolic link, which will point at a read-only file in the
project baseline. This is similar to the same requirement for using the
\fIlink_\%integration_\%directory\fP field of the project configuration
file.
.SS User Configuration
There is a \fIsymbolic_\%link_\%preference\fP field in the user
configuration file (see \fIaeuconf\fP(5) for more information). This
controls whether \fIaeb\fP(1) will verify the symbolic links before
the build (default) or whether it will assume they are up-to-date.
(This field is only relevant if
\fIdevelopment_\%directory_\%_style.\%source_\%file_\%symlink\fP
is true.)
.PP
For medium-to-large projects, verifying the symbolic links can take
as long as the build itself. Assuming the symbolic links are up-to-date
can be a large time-saving for these projects.
It may be advisable to review your choice of DMT in such a situation.
.PP
The \fIaedb\fP(1) command \fBdoes not\fP consult this preference.
Thus, in most situations, the symbolic links will be up-to-date when
the build is performed. The only Aegis function which may result in the
symbolic links becoming out-of-date is the integration of another change,
as this may alter the presence or absence of files in the baseline.
In this situation, the default \fIaeb\fP(1) action is to ignore the user
preference and the verify symbolic links.
.PP
There are two command line options which modify \fIaeb\fP(1) behavior
further: the \fB\-Verify-Symbolic-Links\fP option says to verify the
symbolic links; and the \fB\-Assume-Symbolic-Links\fP option says
to assume the symbolic links are up-to-date.
In each case the option over-rides the default and the user preference.
.PP
It is possible to obtain behaviour similar to Tom Lord'a Arch by using a
setting such as:
.RS
.nf
.ft CW
development_directory_style =
{
source_file_link = true;
source_file_symlink = true;
};
.ft R
.fi
.RE
.PP
It is possible to obtain behaviour similar to CVS by using a
setting such as:
.RS
.nf
.ft CW
development_directory_style =
{
source_file_copy = true;
};
.ft R
.fi
.RE
There are many more possible configurations of the
\fIdevelopment_\%directory_\%style\fP, usually with helpful build
side-effects. See \fIaepconf\fP(1) and the \fIDepenedency
Maintenance Tool\fP chapter of the User Guide for more information.
.PP
The symbolic link command line options and preferences apply equally
to hard links and file copies (the names have historical origins).
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1996, 1998, 1999, 2002, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.SH THE BASELINE LOCK
The baseline lock is used to ensure that the baseline remains in a
consistent state for the duration of commands which need to read the
contents of files in the baseline.
.PP
The commands which require the baseline to be consistent
(these include the
.IR aeb (1),
.IR aecp (1)
and
.IR aed (1)
commands)
take a baseline
.I read
lock.
This is a non-exclusive lock,
so the concurrent development of changes is not hindered.
.PP
The command which modifies the baseline,
.IR aeipass (1),
takes a baseline
.I write
lock.
This is an exclusive lock,
forcing
.IR aeipass (1)
to block until there are no active baseline read locks.
.PP
It is possible that
one of the above development commands
will block until an in-progress
.I "\*(n) -Integrate_PASS"
completes.
This is usually of short duration while the project history is updated.
The delay is essential so that these commands receive a consistent view
of the baseline.
No other integration command will cause the above development commands
to block.
.PP
When \*(n)' branch functionality is in use,
a read (non-exclusive) lock is taken on the branch baseline and also
each of the "parent" baselines.
However,
a baseline write (exclusive) lock is only taken on the branch baseline;
the "parent" baselines are only read (non-exclusive) locked.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1998, 2005-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.SH METRICS
Aegis is capable of recording metrics as part of the file attributes of
a change. This allows various properties of files to be recorded for
later trend analysis, or other uses.
.PP
The specific metrics are not dictated by Aegis. It is expected that
the integration build will create a metrics file for each of the source
files the change. These metrics files must be in the format specified
by \fIaemetrics\fP(5).
.PP
The name of the metrics file defaults to \[lq]\fIfilename\fP\fB,S\fP\[rq],
however it may be varied, by setting the \fImetrics_\%filename_\%pattern\fP
field of the project \fIconfig\fP file. See \fIaepconf\fP(5) for more
information.
.PP
If such a metrics file exists, for each source file in a change, it will
be read and remembered at integrate pass time. If it does not exist,
Aegis assumes there are no relevant metrics for that file, and proceeds
silently; it is not an error.
.SH OPTIONS
The following options are understood:
.TP 8n
\fIname\fP\fB=\fP\fIvalue\fP
Command line arguments of this form are assumed to be variable assignments
for the build tool. They are passed through unchanged. They imply a
partial build.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1998, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B \-BAse_RElative
This option may be used to cause relative filenames to be considered
relative to the base of the source tree.
See \fIaeuconf\fP(5) for the corresponding user preference.
.TP 8n
.B \-CUrrent_RElative
This option may be used to cause relative filenames to be considered
relative to the current directory. This is usually the default.
See \fIaeuconf\fP(5) for the corresponding user preference.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2003, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
\fB-Change\fP \fInumber\fP
This option may be used to specify a particular change within a project.
See \fIaegis\fP(1) for a complete description of this option.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -Help
.br
This option may be used to obtain more information about how to use the
.I \*(n)
program.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -List
.br
This option may be used to obtain a list of suitable subjects for this
command.
The list may be more general than expected.
.TP 8n
\fB\-MINImum\fP
This option may be used to request a source-only
\fIdevelopment_\%directory_\%style\fP. This is useful if you
want to simulate something like \fIaeib \-minimum\fP in the
development directory. This option is only meaningful if
\fIdevelopment_\%directory_\%style\fP is being used. If the change
is in the \fIbeing integrated\fP state, and the developer specified
\fB\-MINImum\fP when issuing the \fI\*(n) \-Integrate_Begin\fP command,
then this option is set by default.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1992, 1993, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -Not_Logging
.br
This option may be used to disable the automatic logging of
output and errors to a file.
This is often useful when several \*(n) commands are combined
in a shell script.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
\fB-Project\fP \fIname\fP
This option may be used to select the project of interest.
When no
.B -Project
option is specified,
the
.I AEGIS_PROJECT
environment variable is consulted.
If that does not exist,
the user's
.I $HOME/.aegisrc
file is examined for a default project field (see
.IR aeuconf (5)
for more information).
If that does not exist,
when the user is only working on changes within a single project,
the project name defaults to that project.
Otherwise,
it is an error.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -TERse
.br
This option may be used to cause listings to
produce the bare minimum of information.
It is usually useful for shell scripts.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -Verbose
This option may be used to cause \*(n) to produce more output.
By default \*(n) only produces output on errors.
When used with the
.B -List
option
this option causes column headings to be added.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 2004-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
\fB\-Verify_Symbolic_Links\fP
This option may be used to request that the symbolic links, or hard
links, or file copies, in the work area be updated to reflect the
current state of the baseline.
This is controlled by the \fIdevelopment_\%directory_\%style\fP field of
the project configuration file.
Only files which are not involved in the change are updated.
See also the \[lq]symbolic_links_preference\[rq] field of \fIaeuconf\fP(5).
This option is the default, if meaningful for your configuration.
The name is an historical accident, hard links and file copies are included.
.TP 8n
\fB\-Assume_Symbolic_Links\fP
This option may be used to request that no update of baseline mirror
files take place.
This options is useful when you \fIdefinitely know\fP the files'
up-to-date-ness isn't important right now; incorrect use of this option
may have unanticipated build side-effects.
See also the \[lq]symbolic_links_preference\[rq] field of \fIaeuconf\fP(5).
This option is the default, if not meaningful for your configuration.
The name is an historical accident, hard links and file copies are included.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1998, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B \-Wait
This option may be used to require \*(N) commands to wait for access
locks, if they cannot be obtained immediately.
Defaults to the user's
.I lock_wait_preference
if not specified, see
.IR aeuconf (5)
for more information.
.TP 8n
.B \-No_Wait
This option may be used to require \*(N) commands to emit a fatal error
if access locks cannot be obtained immediately.
Defaults to the user's
.I lock_wait_preference
if not specified, see
.IR aeuconf (5)
for more information.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.r)
.PP
All options may be abbreviated;
the abbreviation is documented as the upper case letters,
all lower case letters and underscores (_) are optional.
You must use consecutive sequences of optional letters.
.PP
All options are case insensitive,
you may type them in upper case or lower case or a combination of both,
case is not important.
.PP
For example:
the arguments "-project, "-PROJ" and "-p" are
all interpreted to mean the \fB-Project\fP option.
The argument "-prj" will not be understood,
because consecutive optional characters were not supplied.
.PP
Options and other command line arguments may be
mixed arbitrarily on the command line,
after the function selectors.
.br
.ne 4
.PP
The GNU long option names are understood.
Since all option names for
.I \*(n)
are long,
this means ignoring the extra leading '-'.
The "\fB--\fIoption\fB=\fIvalue\fR" convention is also understood.
.SH RECOMMENDED ALIAS
The recommended alias for this command is
.nf
.ta 8n 16n
csh% alias aeb '\*(n) -b \e!* -v'
sh$ aeb(){\*(n) -b "$@" -v}
.fi
.SH ERRORS
It is an error if
the change is not assigned to the current user.
.br
It is an error if
the change is not in one of the
.I "being developed"
or
.I "being integrated"
states.
.br
It is an error if
a partial build is requested and the change is in the
.I "being integrated"
state.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 1995, 1997, 2004, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.SH EXIT STATUS
The
.I \*(n)
command will exit with a status of 1 on any error.
The
.I \*(n)
command will only exit with a status of 0 if there are no errors.
.SH ENVIRONMENT VARIABLES
See \fIaegis\fP(1) for a list of environment variables which may affect
this command.
See \fIaepconf\fP(5) for the project configuration file's
\fIproject_\%specific\fP field for how to set environment variables for
all commands executed by Aegis.
.br
.ne 1i
.SH SEE ALSO
.TP 8n
.IR aedb (1)
begin development of a change
.TP 8n
.IR aecp (1)
file copy also takes a baseline read lock (non-exclusive)
.TP 8n
.IR aeib (1)
begin integration of a change
.TP 8n
.IR aeipass (1)
integrate pass takes a baseline write lock (exclusive)
.TP 8n
.IR aet (1)
run tests
.TP 8n
.IR aemetrics (5)
metrics values file format
.TP 8n
.IR aepconf (5)
project configuration file format
.TP 8n
.IR aeuconf (5)
user configuration file format
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1995, 1997, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.br
.ne 2i
.SH COPYRIGHT
.ds v) 4.24.3
.ds V) 4.24.3.D001
.ds o) 0
.ds p) 4.25
.ds u) 4.24
.ds Y) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
\*(n) version \*(V)
.br
.if t .ds C) \(co
.if n .ds C) (C)
Copyright \*(C) \*(Y) Peter Miller
.PP
The \*(n) program comes with ABSOLUTELY NO WARRANTY;
for details use the '\fI\*(n) -VERSion License\fP' command.
This is free software
and you are welcome to redistribute it under certain conditions;
for details use the '\fI\*(n) -VERSion License\fP' command.
.br
.ne 1i
.SH AUTHOR
.TS
tab(;);
l r l.
Peter Miller;E-Mail:;millerp@canb.auug.org.au
\f(CW/\e/\e*\fR;WWW:;http://www.canb.auug.org.au/~millerp/
.TE