The
(n) program
is a transaction base software configuration management system.
It is used to
supervise the development and integration of changes into projects.
FUNCTIONS
The following functions are available:
-Build
The
"(n) -Build" command is used to
build a project.
See
aeb(1) for more information.
-Change_Attributes
The
"(n) -Change_Attributes" command is used to
modify the attributes of a change.
See
aeca(1) for more information.
-Change_Directory
The
"(n) -Change_Directory" command is used to
change directory.
See
aecd(1) for more information.
-Change_Owner
The
"(n) -Change_Owner" command is used to
facilitate reassignment of the developer of a change in the
"being developed" state.
See
aechown(1) for more information.
-CLone
The
"(n) -CLone" command is used to
exactly replicate a change, usually on another branch.
See
aeclone(1) for more information.
-CoPy_file
The
"(n) -CoPy_file" command is used to
copy a file into a change.
See
aecp(1) for more information.
-CoPy_file_Undo
The
"(n) -Copy_File_Undo" command is used to
remove a copy of a file from a change.
See
aecpu(1) for more information.
-DELta_NAme
The
"(n) -DELta_NAme" command is used to
add a symbolic name to a project delta.
See
aedn(1) for more information.
-Develop_Begin
The
"(n) -Develop_Begin" command is used to
begin development of a change.
See
aedb(1) for more information.
-Develop_Begin_Undo
The
"(n) -Develop_Begin_Undo" command is used to
cease development of a change.
See
aedbu(1) for more information.
-Develop_End
The
"(n) -Develop_End" command is used to
complete development of a change.
See
aede(1) for more information.
-Develop_End_Undo
The
"(n) -Develop_End_Undo" command is used to
recall a change for further development.
See
aedeu(1) for more information.
-DIFFerence
The
"(n) -DIFFerence" command is used to
find differences between development directory and baseline.
See
aed(1) for more information.
-Help
This option may be used to obtain more information about how to use the
(n) program.
-Integrate_Begin
The
"(n) -Integrate_Begin" command is used to
begin integrating a change.
See
aeib(1) for more information.
-Integrate_Begin_Undo
The
"(n) -Integrate_Begin_Undo" command is used to
cease integrating a change.
See
aeibu(1) for more information.
-Integrate_Fail
The
"(n) -Integrate_Fail" command is used to
fail a change integration.
See
aeifail(1) for more information.
-Integrate_Pass
The
"(n) -Integrate_PASS" command is used to
pass a change integration.
See
aeipass(1) for more information.
-List
The
"(n) -List" command is used to
list interesting things.
See
ael(1) for more information.
-MoVe_file
The
"(n) -MoVe_file" command is used to
change the name of a file
as part of a change.
See
aemv(1) for more information.
-MoVe_file_Undo
The
"(n) -MoVe_file_Undo" command is used to undo a
change to the name of a file
as part of a change.
See
aemvu(1) for more information.
-New_Administrator
The
"(n) -New_Administrator" command is used to
add new administrators to a project.
See
aena(1) for more information.
-New_BRanch
The
"(n) -New_BRanch" command is used to
add a new branch to a project.
See
aenbr(1) for more information.
-New_BRanch_Undo
The
"(n) -New_BRanch_Undo" command is used to
remove a new branch from a project.
See
aenbru(1) for more information.
-New_Change
The
"(n) -New_Change" command is used to
add a new change to a project.
See
aenc(1) for more information.
-New_Change_Undo
The
"(n) -New_Change_Undo" command is used to
remove a new change from a project.
See
aencu(1) for more information.
-New_Developer
The
"(n) -New_Developer" command is used to add
new developers to a project.
See
aend(1) for more information.
-New_File
The
"(n) -New_File" command is used to
add new files to a change.
See
aenf(1) for more information.
-New_File_Undo
The
"(n) -New_File_Undo" command is used to
remove new files from a change.
See
aenfu(1) for more information.
-New_Integrator
The
"(n) -New_Integrator" command is used to
add new integrators to a project.
See
aeni(1) for more information.
-New_Project
The
"(n) -New_Project" command is used to
create a new project to be watched over by (n).
See
aenpr(1) for more information.
-New_Project_Alias
The
"(n) -New_Project_Alias" command is used to
create a new project alias.
See
aenpa(1) for more information.
-New_ReLeaSe
The
"(n) -New_ReLeaSe" command is used to
create a new project from an existing project.
See
aenrls(1) for more information.
-New_ReViewer
The
"(n) -New_ReViewer" command is used to
add new reviewers to a project.
See
aenrv(1) for more information.
-New_Test
The
"(n) -New_Test" command is used to
add a new test to a change.
See
aent(1) for more information.
-New_Test_Undo
The
"(n) -New_Test_Undo" command is used to
remove new tests from a change.
See
aentu(1) for more information.
-Project_Attributes
The
"(n) -Project_Attributes" command is used to
modify the attributes of a project.
See
aepa(1) for more information.
-Remove_Administrator
The
"(n) -Remove_Administrator" command is used to
remove administrators from a project.
See
aera(1) for more information.
-Remove_Developer
The
"(n) -Remove_Developer" command is used to
remove developers from a project.
See
aerd(1) for more information.
-ReMove_file
The
"(n) -ReMove_file" command is used to
add files to be deleted to a change.
See
aerm(1) for more information.
-ReMove_file_Undo
The
"(n) -Remove_File_Undo" command is used to
remove files to be deleted from a change.
See
aermu(1) for more information.
-Remove_Integrator
The
"(n) -Remove_Integrator" command is used to
remove integrators from a project.
See
aeri(1) for more information.
-ReMove_PRoject
The
"(n) -ReMove_PRoject" command is used to
remove a project.
See
aermpr(1) for more information.
-Remove_Project_Alias
The
"(n) -Remove_Project_Alias" command is used to
remove a project alias.
See
aerpa(1) for more information.
-Remove_ReViewer
The
"(n) -Remove_ReViewer" command is used to
remove reviewers from a project.
See
aerrv(1) for more information.
-RePorT
The
"(n) -RePorT" command is used to
generate reports from (n)' database.
These reports may be written by users,
or be distributed with (n).
-Review_Fail
The
"(n) -Review_Fail" command is used to
fail a change review.
See
aerfail(1) for more information.
-Review_Begin
The
"(n) -Review_Begin" command is used to
begin to review a change.
See
aerb(1) for more information.
-Review_Begin_Undo
The
"(n) -Review_Begin_Undo" command is used to stop reviewing a change.
See
aerbu(1) for more information.
-Review_Pass
The
"(n) -Review_PASS" command is used to
pass a change review.
See
aerpass(1) for more information.
-Review_Pass_Undo
The
"(n) -Review_Pass_Undo" command is used to
rescind a change review pass.
See
aerpu(1) for more information.
-Test
The
"(n) -Test" command is used to
run tests.
See
aet(1) for more information.
-VERSion
The
"(n) -VERSion" command is used to
get copyright and version details.
See
aev(1) for more information.
All function selectors are case insensitive.
Function selectors may be abbreviated;
the abbreviation is the upper case letters.
Function selectors must appear as the first command line argument.
Notification Many aegis commands are capable of notification that they have
been run. The individual commands document those specific to them.
For documentation on the various configurable notifications, see
aepconf(5) and aepattr(5) for more information.
OPTIONS
The following options are available to all functions.
These options may appear anywhere on the command line following
the function selectors.
-LIBraryabspath
This option may be used to
specify a directory to be searched for global state files and
user state files.
(See
aegstate(5) and
aeustate(5) for more information.)
Several library options may be present on the command line,
and are search in the order given.
Appended to this explicit search path are the directories specified
by the
AEGIS_PATH environment variable (colon separated),
and finally,
/usr/local/lib/aegis is always searched.
All paths specified,
either on the command line or in the
AEGIS_PATH environment variable,
must be absolute.
-PAGer
The output of listings and help is piped through the pager command
given in the PAGER environment variable
(or more if not set).
This is the default if the command is in the foreground,
and the output is a TTY.
This option may be used to override any preference specified in the
aeuconf(5) file.
-No_PAGer
This option may be used to ensure that the output of listings and help
is not piped through a pager command.
This is the default if the command is in the background,
or if the output is not a TTY.
This option may be used to override any preference specified in the
aeuconf(5) file.
-Page_Lengthnumber
This option may be used to set the page length of listings.
The default,
in order of preference,
is obtained from the system,
from the LINES environment variable,
or set to 24 lines.
-Page_Widthnumber
This option may be used to set the page width of listings
and error messages.
The default,
in order of preference,
is obtained from the system,
from the COLS environment variable,
or set to 79 characters.
-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
-List option
this option causes column headings to be added.
The following options are available to all listings.
These options may appear anywhere on the command line following
the function selectors.
-TERse
This option may be used to cause listings to
produce the bare minimum of information.
It is usually useful for shell scripts.
-UNFormatted
This option may be used with most listings
to specify that the column formatting is not to be performed.
This is useful for shell scripts.
The following options are available to
most functions.
These options may appear anywhere on the command line following
the function selectors.
-Changenumber
This option may be used to specify a particular change within a project.
When no
-Change option is specified,
the
AEGIS_CHANGE environment variable is consulted.
If that does not exist,
the user's
$HOME/.aegisrc file is examined for a default change field (see
aeuconf(5) for more information).
If that does not exist,
when the user is only working on one change within a project,
that is the default change number.
Otherwise,
it is an error.
-Projectname
This option may be used to select the project of interest.
When no
-Project option is specified,
the
AEGIS_PROJECT environment variable is consulted.
If that does not exist,
the user's
$HOME/.aegisrc file is examined for a default project field (see
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.
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.
All options are case insensitive,
you may type them in upper case or lower case or a combination of both,
case is not important.
For example:
the arguments "-project, "-PROJ" and "-p" are
all interpreted to mean the -Project option.
The argument "-prj" will not be understood,
because consecutive optional characters were not supplied.
Options and other command line arguments may be
mixed arbitrarily on the command line,
after the function selectors.
The GNU long option names are understood.
Since all option names for
(n) are long,
this means ignoring the extra leading '-'.
The "--option=value" convention is also understood.
EXIT STATUS
The
(n) command will exit with a status of 1 on any error.
The
(n) command will only exit with a status of 0 if there are no errors.
ENVIRONMENT VARIABLES
The
(n) command understands the following environment variables:
AEGIS_PATH
A colon-separated list of library directories.
See the
-LIBrary option for a description how this environment variable is used.
AEGIS_PROJECT
Names a default project.
See the
-Project option for a description how this environment variable is used.
AEGIS_CHANGE
Specifies a default change.
See the
-Change option for a description how this environment variable is used.
AEGIS_FLAGS
This environment variable is used to hold
aeuconf(5) information,
and over-rides the settings in the users
.aegisrc file.
This is intended to be used within the tests distributed with aegis,
but can also be of use within some shell scripts.
AEGIS_THROTTLE
Specifies the number of seconds to delay execution within commands
which set time stamps.
This is intended to be used within the tests distributed with aegis,
but can also be of use within some shell scripts.
AEGIS_AUTOMOUNT_POINTS
A colon-separated list of directories which the automounter may use
to mount file systems. Use with extreme care, as this distorts Aegis'
idea of the shape of the filesystem.
This feature assumes
that paths below the automounter's mount directory are echoes of paths
without it.
E.g. When <[>CW]/home[> is the trigger, and
<[>CW]/tmp_mnt/home[> is where the on-demand NFS mount is performed, with
<[>CW]/home[> appearing to processes to be a symlink.
This is the behavior of the Sun automounter. The AMD automounter is
capable of being configured in this way, though it is not typical of the
examples in the manual. Nor is it typical of the out-of-the-box Linux
AMD configuration in many distributions.
COLS
Specifies the page width for errors and listings.
See the
-Page_Width option for a description how this environment variable is used.
EDITOR
Specifies the program use to edit files when
the
-Edit or
-Edit_BackGround options are used.
(See also the
VISUAL environment variable.)
Defaults to
vi if not set.
See the editor_%command fields in aeuconf(1) for how to
override this specifically for Aegis.
LINES
Specifies the page length for listings.
See the
-Page_Length option for a description how this environment variable is used.
PAGER
Specifies the program to use to view listings and help.
Not used if output is to a file or a pipe.
Defaults to
"more" if not set.
VISUAL
Specifies the program use to edit files when
the
-Edit option is used.
(See also the
EDITOR environment variable.)
Defaults to
vi if not set.
See the visual_%command fields in aeuconf(1) for how to
override this specifically for Aegis.
(n) version (V)
Copyright (C) (Y) Peter Miller;
All rights reserved.
The (n) program comes with ABSOLUTELY NO WARRANTY;
for details use the '(n) -VERSion License' command.
This is free software
and you are welcome to redistribute it under certain conditions;
for details use the '(n) -VERSion License' command.