'\" t
.\"	aegis - project change supervisor
.\"	Copyright (C) 1998, 1999, 2002-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
.\"	<http://www.gnu.org/licenses/>.
.\"
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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) -CLEan" 1 \*(N) "Reference Manual" ""
.SH NAME
aegis clEan \- clean files from development directory
.XX "aeclean(1)" "clean files from development directory"
.SH SYNOPSIS
.B \*(n)
.B \-CLEan
[
.IR option \&...
]
.br
.B \*(n)
.B \-CLEan
.B -Help
.br
.B \*(n)
.B -VERSion
.SH DESCRIPTION
The
.I "\*(n) -CLEan"
command is used to remove all files which are not change source files
from a development directory.  This can be used to obtain a \[lq]clean\[rq]
development directory before a final build, to ensure that a change is
ready to end development.
A new build will be required.
.PP
This command is only allowed in the \[lq]\fIbeing developed\fP\[rq] state,
and only the change's developer may issue it.  It may not be applied
to branches.
.PP
All symbolic links will be removed from the development directory,
even if \fIremove_\%symlinks_\%after_\%build = false\fP in the
project \fIconfig\fP file.  The symbolic links will be re-installed,
if \fIcreate_\%symlinks_\%before_\%build = true\fP.  This is to ensure
that the symlinks are accurate, and that unnecessary ones are removed.
.PP
All special device files, pipes and sockets will be removed.  These files
cannot be source files, and it is expected that the following build will
restore them.
.PP
All derived files created by previous builds of the change will be
removed.  It is expected that the following build will recreate them.
Any temporary files you may have created in the development directory
will also be removed.
.PP
The
.I develop_begin_command
in the project configuration file
(see
.IR aepconf (5)
for more information) will be run, if there is one.
The
.I change_file_command
will be run, if there is one.
The
.I project_file_command
will be run, if there is one.
.PP
You will be warned if any of the files are out-of-date and need to be merged.
You will be warned if any files need to be differenced.
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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).
.SS Notification
The notification commands that would be run by the \fIaecp\fP(1),
\fIaedb\fP(1), \fIaenf\fP(1), \fIaent\fP(1) and \fIaerm\fP(1) commands
are run, as appropriate.  The \fIproject_\%file_\%command\fP is also run,
if set.  See \fIaepconf\fP(5) for more information.
.SH OPTIONS
The following options are understood:
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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.
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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.
.TP 8n
.B \-TOuch
This option may be used to request that each change source file have its
last-modified time-stamp be updated to the current time.
This is the default.
Derived files and other non-source file are left alone.
.TP 8n
.B \-No_TOuch
This option may be used to request that the last-modified time-stamp of
each source file be left unmodified.
.TP 8n
.B \-MINIMum
.RS
This option may be used to request a minimum set of symbolic links,
when the \fIcreate_symlinks_to_baseline\fP functions are being used.
This is useful if you want to simulate something like \fIaeib -minimum\fP
in the development directory.  This option is not meaningful if symbolic
links are not being used.
.PP
This option also says not to remove normal files which occlude project
source files.  This is a common technique used to temporarily over-ride
project source files.  The \[lq]\fIaecp -read-only\[rq] command would have
been more appropriate.
.RE
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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) 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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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.
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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.
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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