'\" t
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1994, 1996-1999, 2001, 2002, 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
.\" .
.\"
.\"
.\" 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) -CoPy_file" 1 \*(N) "Reference Manual"
.SH NAME
aegis copy file \- copy a file into a change
.XX "aecp(1)" "copy a file into a change"
.SH SYNOPSIS
.B \*(n)
.B -CoPy_file
[
.IR option ...
]
.IR filename ...
.br
.B \*(n)
.B -CoPy_file
.B -INDependent
[
.IR option ...
]
.IR filename ...
.br
.B \*(n)
.B -CoPy_file
.B -List
[
.IR option ...
]
.br
.B \*(n)
.B -CoPy_file
.B -Help
.SH DESCRIPTION
The
.I \*(n)
.I -CoPy_file
command is used to
copy a file into a change.
The named files will be copied from the baseline into
the development directory,
and added to the list of files in the change.
The version of files copied from the baseline is remembered.
.PP
This command may be used to copy tests into a change,
not just source files.
Tests are treated just like any other source file,
and are subject to the same process.
.PP
Warning:
If there are files in the development directory of the same name
they will be overwritten by this command.
.PP
You may also name directories.
All of the source files in the directories named,
and all directories below them,
will be copied from the baseline into the development directory,
and added to the list of files in the change.
.PP
When copying files explicitly,
it is an error if the file is already part of the change.
When you name a directory,
all of the source files in the project below that directory are copied,
except any which are already in the change.
It is an error if none of the files implicitly named
by the directory can be used.
.PP
If you want to change a copied source file to be executable (shell
scripts, for example) then you simply use the normal \fIchmod\fP(1)
command; the reverse to make it not executable. 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.
.\"
.\" 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.
.SS Process Side Effects
This command will cancel any build or test registrations,
because adding another file logically invalidates them.
If the project
configuration
file was added,
any diff registration will also be canceled.
.PP
When the change files are listed
(\fI\*(n) -List Change_Files -TERse\fP)
the copied files will appear in the listing.
When the project files are listed with an explicit change number
(\fI\*(n) -List Project_Files -TERse -Change\fP \f(CWN\fP)
none of the change's files,
including the copied files,
will appear in the terse listing.
These two features are very helpful when calling \*(n) from within
a DMT to generate the list of source files.
.\"
.\" 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) 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
.\" .
.\"
.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.
.SS Notification
The \fIcopy_file_command\fP in the project \fIconfig\fP 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.
.\"
.\" 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 OPTIONS
The following options are understood:
.\"
.\" 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) 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
.\" .
.\"
.TP 8n
\fB-BRanch\fP \fInumber\fP
This option may be used to specify a
different branch for the origin file,
rather than the baseline.
(See also \fB\-TRunk\fP option.\)
Please Note: the \fB-BRanch\fP option does not take a project name,
just the branch number suffix.
.TP 8n
\fB\-GrandParent\fP
This option may be used to specify the grandparent branch (one up from
the current branch) for the origin file, rather than the baseline.
(The \-grandparent option is the same as the \[lq]\-branch ..\[rq] option.)
.\"
.\" 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) 2001, 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
.\" .
.\"
.TP 8n
\fB-DELta\fP \fInumber\fP
.br
This option may be used to specify a particular
delta in the project's history to copy the file from,
rather than the most current version.
If the delta has been given a name
(see
.IR aedn (1)
for how)
you may use a delta name instead of a delta number.
It is an error if the delta specified does not exist.
Delta numbers start from 1 and increase;
delta 0 is a special case meaning \[lq]when the branch started\[rq].
.TP 8n
\fB-DELta_Date\fP \fIstring\fP
.br
This option may be used to specify a particular date and time in the
project's history to copy the file from, rather than the most current
version. It is an error if the string specified cannot be interpreted
as a valid date and time. Quote the string if you need to use spaces.
.TP 8n
\fB-DELta_From_Change\fP \f[I]number\fP
.br
This option may be used to specify a particular project delta from its
change number.
.\"
.\" 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.
.TP 8n
.B -INDependent
This option is used to specify that the copy is to be run independent
of any particular change.
The files will be copied relative to the current directory.
.\"
.\" 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
.\" .
.\"
.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
.\" .
.\"
.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
.\" .
.\"
.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
\fB-Output\fP \fIfilename\fP
.br
This option may be used to specify an output file
of a file being copied from the baseline.
Only one baseline file may be named when this option is used.
The file name "-" is understood to mean the standard output.
This option does not add the file to the set of change files.
.I "No locks"
are taken when this option is used,
not even the baseline read lock.
.\"
.\" 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 -OverWriting
This option may be used to force overwriting of files.
The default action is to give an error if an existing file would
be overwritten.
.\"
.\" 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.
.TP 8n
.B \-Read_Only
This option may be used to specify that the file is to be used to
insulate the change from the baseline. The user does not intend to edit
the file. These files must be uncopied before development may end.
.TP 8n
.B \-REScind
This option may be used to rescind (roll back) a completed change.
The change to rescind (roll back) is specified in the usual way, with
one of the --delta options.
.\"
.\" 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) 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
.\" .
.\"
.TP 8n
.B -TRunk
.br
This option may be used to specify
the project trunk for the origin file,
rather than the baseline.
(See also \fB\-BRanch\fP option,
the -trunk option is the same as the \[lq]\-branch \-\[rq] option.)
.\"
.\" 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) 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 aecp '\*(n) -cp \e!* -v'
sh$ aecp(){\*(n) -cp "$@" -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 in the change and the
.B -OverWrite
option is not specified.
.\"
.\" 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 EXAMPLES
Here are some simple examples.
Remember that most commands are relative to the current directory, even
though these examples assume you are at the base of the development
directory tree.
.SS Copy Whole Project
To copy the whole project into your change, use the command
.RS
aecp .
.RE
The trailing dot is part of the command, it means "the currect directory
and everything below it". This works for any directory in your project source
tree, if you want to be more seledctive.
.SS Prroduce Earlier Project Version
You you wish to exactly reproduces the sources for an earlier version
of your project, you need to know the edelta number (use \fIael
proj-history\fP to find it). Then use this command:
.RS
aecp -delta \fIn\fP .
.RE
where \fIn\fP is the delta number from the project history.
Again, the trailing dot is part of the command.
By using the \fI$version\fP substitution (see \fIaesub\fP(5) for more
information) you can embed this delta number into your program before
distributing it.
.PP
It is also possible to give a previous change number, instead,
using this command:
.RS
aecp -delta-from-change \fIn\fP .
.RE
where \fIn\fP is the change number of interest.
Again, the trailing dot is part of the command.
.SS Rescind a Change
When you need to rescind (back out) a completed change, it will probably
have been some time ago, so you need to know the delta number or change
number.
Use this command:
.RS
aecp -delta \fIn\fP -rescind .
.RE
where \fIn\fP is the delta number of interest.
All of the other \-delta variantrs also work, so if you know the change
number, you can be more selective about which files to copy:
.RS
aecp -delta-from-change \fIn\fP `aegis -l cf -ter -c \fIn\fP`
.RE
where \fIn\fP is the change number of interest.
This only copies the files which were in the offending change.
.br
.ne 1i
.SH SEE ALSO
.TP 8n
.IR aeb (1)
build also takes a baseline read lock (non-exclusive)
.TP 8n
.IR aecpu (1)
reverse action of aecp
.TP 8n
.IR aedb (1)
begin development of a change
.TP 8n
.IR aedn (1)
assign a name to a delta
.TP 8n
.IR aeipass (1)
integrate pass takes a baseline write lock (exclusive)
.TP 8n
.IR aemv (1)
rename a file as part of a change
.TP 8n
.IR aenf (1)
add a new file to a change
.TP 8n
.IR aerm (1)
add files to be deleted to a change
.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