'\" t
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 1996, 1998-2000, 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) -New_File" 1 \*(N) "Reference Manual"
.SH NAME
aegis new file \- add new files to be created by a change
.XX "aenf(1)" "add new files to be created by a change"
.SH SYNOPSIS
.B \*(n)
.B -New_File
.IR file-name ...
[
.IR option ...
]
.br
.B \*(n)
.B -New_File
.B -List
[
.IR option ...
]
.br
.B \*(n)
.B -New_File
.B -Help
.SH DESCRIPTION
The
.I \*(n)
.I -New_File
command is used to
add new files to a change.
The named files will be
added to the list of files in the change.
.PP
For each file named,
a new file is created in the development directory,
if it does not exist already.
If the file already exists,
it will not be altered.
.PP
If you want a new source file to be executable (shell scripts, for
example) then you simply use the normal \fIchmod\fP(1) command.  If any
of the file's executable bits are set at \fIaede\fP(1) time the file is
remembered as executable and all execute bits (minus the project's umask)
will be set by subsequent \fIaecp\fP(1) commands.
.PP
If you name a directory on the command line, the entire directory tree
will be searched for new files.  (Note: absolutely everything will be added,
including dot files and binary files, so you will need to clean out any
junk first.)
Files below this named directory which are already in the change, or in
the project, will be ignored.
The \f[I]file_name_accept\fP and \f[I]file_name_reject\fP patterns
in the project \f[I]aegis.conf\fP file will also be applied, see
\f[I]aepconf\fP(5) for more information.
.SS Directory Example
There are times when a command such as
.RS
.ft CW
.nf
$ \f[CB]aenf fubar/*\fP
.fi
aegis: project "example": change 42: "fubar/glorp" already in change
.br
aegis: project "example": change 42: found 1 fatal error, no new files added
.nf
$
.fi
.ft R
.RE
will fail as shown.  There are several ways to deal with this,
the easiest being to simply name the directory:
.RS
.ft CW
.nf
$ \f[CB]aenf fubar\fP
.fi
aegis: project "example": change 42: file "fubar/smiley" added
.br
aegis: project "example": change 42: file "fubar/frownie" added
.nf
$
.fi
.ft R
.RE
You could also use the \f[I]find\fP(1) command for arbitrarily complex
file selection, but you must first exclude files that the above command
excludes automatically:
.RS
.ft CW
.nf
$ \f[CB]aelcf > exclude\fP
$ \f[CB]aelpf >> exclude\fP
$ \f[CB]find fubar -type f | \e
    grep -v -f exclude | \e
    xargs aegis --new-file -v\fP
.fi
aegis: project "example": change 42: file "fubar/smiley" added
.br
aegis: project "example": change 42: file "fubar/frownie" added
.nf
$
.fi
.ft R
.RE
If you aren't using the exclude list,
the \f[I]find\fP(1) command will need fine tuning for your development
directory style.  If you are using the symlink-style, you will need to
add the \f[I]find -nlink 1\fP option in addition to the
\f[I]find -type f\fP option.
.RS
.ft CW
.nf
$ \f[CB]find fubar -type f -nlinks 1 | \e
    xargs aegis --new-file -v\fP
.fi
aegis: project "example": change 42: file "fubar/smiley" added
.br
aegis: project "example": change 42: file "fubar/frownie" added
.nf
$
.fi
.ft R
.RE
If you are using the full-copy development directory style,
you will have to use the exclude list method, above.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1999, 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/>.
.\"
.SS File Templates
When a new file is created in the development directory the project
\fIconfig\fP file is searched for a template for the new file.  If a
template is found, the new file will be initialized to the template,
otherwise it will be created empty.
See \fIaepconf\fP(5) for more information.
.PP
The simplest form is to use template files, such as
.RS
.ft CW
.nf
.ta 8n 16n 24n 32n
file_template =
[
	{
		pattern = [ "*.c" ];
		body = "${read_file ${source template/c abs}}";
	},
	{
		pattern = [ "test/*/.sh" ];
		body = "${read_file ${source template/test abs}}";
	},
];
.fi
.ft R
.RE
As you can see, the template files are part of the project source, so
you can add the appropriate copyright notices, and wrappers, \fIetc\fP.
The \fI$source\fP substitution locates them, if they are not part of
the current change (and they usually are not).
.PP
The template files themselves contain substitutions.  The \fI$filename\fP
substitution is available, and contains the name of the file being
created.  This can be manipulated in various ways when constructing
the appropriate file contents.  See \fIaesub\fP(5) for more information
about substitutions.
.PP
It is also possible to run a command to create the new file.
You can do this instead of specifying a body string, \fIviz:\fP
.RS
.ft CW
.nf
.ta 8n 16n 24n 32n
file_template =
[
	{
		pattern = [ "*" ];
		body_command = "perl ${source template.pl abs} $filename";
	},
];
.fi
.ft R
.RE
The command is run with a current directory set to the top of the
development directory.  It is an error if the command fails to create
the file.  You can mix-and-match the two techniques, \fIbody\fP string
and \fIbody_command\fP, if you want.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1997, 1998, 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/>.
.\"
.SS File Name Limitations
There are a number of controls available to limit the form of project
file names.  All of these controls may be found in the project
configuration
file, see
.IR aepconf (5)
for more information.
The most significant are briefly described here:
.TP 8n
maximum_filename_length = integer;
This field is used to limit the length of filenames.
All new files may not have path components longer than this.
Defaults to 255 if not set.
For maximum portability you should set this to 14.
.TP 8n
posix_filename_charset = boolean;
This field may be used to limit the characters allowed
in filenames to only those explicitly allowed by POSIX.
Defaults to
.I false
if not set, meaning whatever your operating system will tolerate,
except white space and high-bit-on characters.
For maximum portability you should set this to \fItrue\fP.
.TP 8n
dos_filename_required = boolean;
This field may be used to limit filenames so that they conform to
the DOS 8+3 filename limits and to the DOS filename character set.
Defaults to
.I false
if not set.
.TP 8n
windows_filename_required = boolean;
This field may be used to limit filenames so that they conform to the
Windows98 and WindowsNT filename limits and character set.  Defaults to
\fIfalse\fP if not set.
.TP 8n
shell_safe_filenames = boolean;
This field may be used to limit filenames so that they do not contain
shell special characters.  Defaults to
.I true
if not set.  If this field is set to
.IR false ,
you will need to use the
.I ${quote}
substitution around filenames in commands, to ensure that filenames
containing shell special characters do not have unintended side effects.
Weird characters in filenames may also confuse your dependency maintenance tool.
.TP
allow_white_space_in_filenames = boolean;
.RS
This field may be used to allow white space characters in file names.
This will allow the following characters to appear in file names:
backspace (BS, \eb, 0x08), horizontal tab (HT, \et, 0x09), new line
(NL, \en, 0x0A), vertical tab (VT, \ev, 0x0B), form feed (FF, \ef,
0x0C), and carriage return (CR, \er, 0x0D).
Defaults to false if not set.
.PP
Note that this field does not override other file name filters.
It will be necessary to explicitly set
\f[I]shell_\%safe_\%filenames = false\fP
as well.
It will be necessary to set
\f[I]dos_\%filename_\%required = false\fP
(the default) as well.
It will be necessary to set
\f[I]posix_\%filename_\%charset = false\fP
(the default) as well.
.PP
The user must take great care to use the ${quote} substitution around
all file names in commands in the project configuration.  And even
then, substitutions which expect a space separated list of file names
will have undefined results.
.RE
.TP
allow_non_ascii_filenames = boolean;
.RS
This field may be used to allow file names with non-ascii-printable
characters in them.  Usually this would mean a UTF8 or international
charset of some kind.
Defaults to false if not set.
.PP
Note that this field does not override other file name filters.
It will be necessary to explicitly set
\f[I]shell_\%safe_\%filenames = false\fP
as well.  It will be necessary to set
\f[I]dos_\%filename_\%required = false\fP
(the default) as well.
It will be necessary to set
\f[I]posix_\%filename_\%charset = false\fP
(the default) as well.
.RE
.TP 8n
filename_pattern_accept = [ string ];
This field is used to specify a list of patterns of acceptable filenames.
Defaults to "*" if not set.
.TP 8n
filename_pattern_reject = [ string ];
.br
This field is used to specify a list of patterns of unacceptable filenames.
.PP
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1998, 1999, 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/>.
.\"
\fBPlease Note:\fP Aegis also consults the underlying file system, to
determine its notion of maximum file size.  Where the file system's
maximum file size is less than \fImaximum_filename_length\fP, the
filesystem wins.  This can happen, for example, when you are using the
Linux UMSDOS file system, or when you have an NFS mounted an ancient
V7 filesystem.  Setting \fImaximum_filename_length\fP to 255 in these
cases does not alter the fact that the underlying file systems limits
are far smaller (12 and 14, respectively).
.PP
If your development directories (or your whole project) is on filesystems
with filename limitations, or a portion of the heterogeneous builds take
place in such an environment, it helps to tell Aegis what they are (using
the project \fIconfig\fP file's fields) so that you don't run into the
situation where the project builds on the more permissive environments,
but fails with mysterious errors in the more limited environments.
.PP
If your development directories are routinely on a Linux
UMSDOS filesystem, you would probably be better off setting
\fIdos_filename_required = true\fP,
and also changing the \fIdevelopment_directory_template\fP field.
Heterogeneous development with various Windows environments may
also require this.
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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) 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/>.
.\"
.SS Changing the Type of a File
If you want to change the type of a file (say, from a test to a source
file, or \fIvice versa\fP) you could do it as two changes, by first using
\fIaerm\fP(1) in one change and then using \fIaenf\fP(1) or \fIaent\fP(1)
in a second change, or you can combine both steps in the same change.
Remember to use the \fIaerm -nowhiteout\fP option or you will get a most
peculiar new file template.
.\"
.\"	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
.\"	<http://www.gnu.org/licenses/>.
.\"
.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.
.SS Notification
The \fInew_file_command\fP in the project configuration file is run,
if set.  The \fIproject_\%file_\%command\fP is also run, if set, and
if there has been an integration recently.  See \fIaepconf\fP(5) for
more information.
.\" unlike the above, z_test_corr.so starts a new section
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1996, 1999, 2002, 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
.\"	<http://www.gnu.org/licenses/>.
.\"
.SH TEST CORRELATIONS
The \[lq]\*(n) -Test -SUGgest\[rq] command may be used to have \*(n)
suggest suitable regression tests for your change, based on the source
files in your change.  This automatically focuses testing effort
to relevant tests, reducing the number of regression tests
necessary to be confident that you have not introduced a bug.
.PP
The test correlations are generated by the \[lq]\*(n)
-Integrate_Pass\[rq] command, which associates each test in the
change with each source file in the change.  Thus, each source
file accumulates a list of tests which have been associated with
it in the past.  This is not as exact as code coverage analysis,
but is a reasonable approximation in practice.
.PP
The
.IR aecp (1)
and
.IR aenf (1)
commands are used to associate files with a change.  While they
do not actively perform the association, these are the files
used by
.IR aeipass (1)
and
.IR aet (1)
to determine which source files are associated with which tests.
.SS Test Correlation Accuracy
Assuming that the testing correlations are accurate and that the
tests are evenly distributed across the function space, there
will be a less than \fI1/number\fP chance that a relevant test
has not been run by the \[lq]\*(n) -Test -SUGgest \fInumber\fP\[rq]
command.  A small amount of noise is added to the test
weighting, so that unexpected things are sometimes tested, and
the same tests are not run every time.
.PP
Test correlation accuracy can be improved by ensuring that:
.TP 2m
\(bu
Each change should be strongly focused, with no gratuitous file
inclusions.  This avoids spurious correlations.
.TP 2m
\(bu
Each item of new functionality should be added in an individual change,
rather than several together.  This strongly correlates tests with
functionality.
.TP 2m
\(bu
Each bug should be fixed in an individual change, rather than several
together.  This strongly correlates tests with functionality.
.TP 2m
\(bu
Test correlations will be lost if files are moved.  This is because
correlations are by name.
.PP
The best way for tests to correlate accurately with source files is when
a change contains a test and exactly those files relating to the
functionality under test.  Too many spurious files will weaken the
usefulness of the testing correlations.
.SH OPTIONS
The following options are understood
.TP 8n
.B -Build
.br
This option may be used to specify that the file is constructed
during a build (often only an integrate build),
so that history of it may be kept.
This is useful for generating patch files,
where a history of generated files is important.
Files created in this way may not be copied into a change,
though they may be deleted.
Avoid using files of this type,
if at all possible.
.\"
.\"	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 \-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
.\"	<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.
.TP 8n
\fB\-CONFIGured\fP
This option may be used to specify that the file is an Aegis project
configuration file.  The default project configuration file is called
\fIaegis.conf\fP, however any file name may be used.  You may also use
more than one file, splitting the content across several files, all of
which must be of this type.
.\"
.\"	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-1994, 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
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -Keep
.br
This option may be used to retain files and/or directories
usually deleted or replaced by the command.
Defaults to the user's
.I delete_file_preference
if not specified, see
.IR aeuconf (5)
for more information.
.TP 8n
.B -No_Keep
.br
This option may be used to ensure that the files and/or directories
are deleted or replaced by the command.
Defaults to the user's
.I delete_file_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/>.
.\"
.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.
.\"
.\"	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) 2000, 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 \-TEMplate
This option may be used to specify that a new file template should be
used, even if the file already exists.
.TP 8n
.B \-No_TEMplate
This option may be used to specify that a new file template should not
be used, even if the file does not exist (any empty file will be created).
.\"
.\"	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 -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
.\"	<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.
.SH RECOMMENDED ALIAS
The recommended alias for this command is
.nf
.ta 8n 16n
csh%	alias aenf '\*(n) -nf \e!* -v'
sh$	aenf(){\*(n) -nf "$@" -v}
.fi
.SH ERRORS
It is an error if
the change is not in the
.I "being developed"
state.
.br
It is an error if
the change is not assigned to the current user.
.br
It is an error if
the file is already part of the change.
.br
It is an error if
the file is already part of the baseline.
.br
It is an error if the files named on the command line are not normal
files and not directories.  (If you need symbolic links or special files,
create them at build time.)
.\"
.\"	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.
.br
.ne 1i
.SH SEE ALSO
.TP 8n
.IR aecp (1)
copy files into a change
.TP 8n
.IR aedb (1)
begin development of a change
.TP 8n
.IR aemv (1)
rename a file as part of a change
.TP 8n
.IR aenfu (1)
remove new files from a change
.TP 8n
.IR aent (1)
add new tests to a change
.TP 8n
.IR aerm (1)
add files to be deleted by a change
.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
.\"	<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