'\" t
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1994, 1996, 1998, 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
.\" .
.\"
.\"
.\" 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
..
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1996, 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
.\" .
.\"
.\" etc/libdir.so. Generated from libdir.so.in by configure.
.\"
.ds B) /usr/bin
.ds L) /usr/share/aegis
.ds D) /usr/share/aegis
.ds datarootdir /usr/share/aegis
.ds S) /var/lib/aegis
.TH "\*(n) -New_PRoject" 1 \*(N) "Reference Manual"
.SH NAME
aegis new project \- create a new project
.XX "aenpr(1)" "create a new project"
.SH SYNOPSIS
.B \*(n)
.B -New_PRoject
.I project-name
[
.IR option ...
]
.br
.B \*(n)
.B -New_PRoject
.B -List
[
.IR option ...
]
.br
.B \*(n)
.B -New_PRoject
.B -Help
.SH DESCRIPTION
The
.I \*(n)
.I -New_PRoject
command is used to
create a new project.
The project is created as an empty directory structure
with no staff except the administrator, no changes,
and branches to implement the version specified.
.PP
Please note: unless you specify a version (see the \fB\-version\fP option,
below) this command will default to creating branches to support version
1.0. If you discovered this too late, all is not lost: you can use the
\fIaenbru\fP(1) command to get rid of the branches you didn't want.
.SS Directory
The project directory,
under which the project baseline and history and
state and change data are kept,
will be created at this time.
If the
.B -DIRectory
option is not given,
the project directory will be created in the
directory specified by the default_\%project_\%directory field of
.IR aeuconf (5),
or if not set
in current user's home directory;
in either case with the same name as the project.
.SS Staff
The project is created with the current user
and group as the owning user and group.
The current user is an administrator for the project.
The project has no developers, reviewers, integrators or
other administrators.
The project's umask is derived from the current user's umask,
but guaranteeing that group members will have access
and that only the project owner will have write access.
.SS Pointer
The project pointer will be added to the first element of
the search path,
or
.I \*(S)
if no path is set.
If this is inappropriate, use the
.B -LIBrary
option to explicitly set the desired location.
See the
.B -LIBrary
option for more information.
.SS Version
You may specify the project version in two ways:
.TP 3n
1.
The version number may be implicit in the project name,
in which case the version numbers will be stripped off.
For example, \[lq]aenpr example.1.2\[rq]
will create a project called \[lq]example\[rq]
with branch number 1 created, and sub-branch 2 of branch 1 created.
.TP 3n
2.
The version number may be stated explicitly,
in which case it will be subdivided for branch numbers.
For example, \[lq]aenpr example -version 1.2\[rq]
will create a project called \[lq]example\[rq]
with branch number 1 created, and sub-branch 2 of branch 1 created.
.PP
In each case,
these branches may be named wherever a project name may be given,
such as \[lq]-p example.1\[rq] and \[lq]-p example-1.2\[rq].
The actual punctuation character is unimportant.
.PP
You may have any depth of version numbers you like.
Both methods of specifying version numbers may be used,
and they will be combined.
If you want no version numbers at all,
use \fB\-version\fP with a single dash as the argument,
as in \[lq]\f(CW\-version \-\fP\[rq]
.PP
If no version number is given,
either explicitly or implicitly,
version 1.0 is used.
.SS Project Directory Location
.\"
.\" 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
.\" .
.\"
\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.
.SH OPTIONS
The following options are understood:
.\"
.\" 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-DIRectory\fP \fIpath\fP
.RS 8n
This option may be used to specify which directory is to be used.
It is an error if the current user does not have appropriate permissions
to create the directory path given.
This must be an absolute path.
.PP
Caution:
If you are using an automounter
do not use `pwd` to make an absolute path,
it usually gives the wrong answer.
.RE
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1993, 1995, 1997, 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 -Edit
.br
.RS
Edit the attributes with a text editor, this is usually more convenient
than supplying a text file. The \fIVISUAL\fP and then \fPEDITOR\fP
environment variables are consulted for the name of the editor to use;
defaults to \fIvi\fP(1) if neither is set.
See the \fIvisual_\%command\fP and \fIeditor_\%command\fP fields in
\fIaeuconf\fP(1) for how to override this specifically for Aegis.
.PP
Warning: Aegis tries to be well behaved when
faced with errors, so the temporary file is left in your home directory
where you can edit it further and re-use it with a \fB\-file\fP option.
.PP
The \fB\-edit\fP option may not be used in the background, or when the
standard input is not a terminal.
.RE
.TP 8n
.B -Edit_BackGround
.br
Edit the attributes with a dumb text editor, this is most often desired
when edit commands are being piped into the editor via the standard input.
Only the \fPEDITOR\fP environment variable is consulted for the name of
the editor to use; it is a fatal error if it is not set.
See the \fIeditor_\%command\fP field in \fIaeuconf\fP(1) for how to
override this specifically for Aegis.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1995, 2001, 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-File\fP \fIfilename\fP
.br
Take the attributes from the specified file.
The filename `-' is understood to mean the standard input.
.\"
.\" 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 -Keep
This option may be used to re-attach a project detached using \fIaermpr
\&\-keep\fP and possibly moved by the system administrator.
.\"
.\" 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
\fB-LIBrary\fP \fIabspath\fP
.br
This option may be used to
specify a directory to be searched for global state files and
user state files.
(See
.IR aegstate (5)
and
.IR 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
.I AEGIS_PATH
environment variable (colon separated),
and finally,
.I /usr/local/lib/aegis
is always searched.
All paths specified,
either on the command line or in the
.I AEGIS_PATH
environment variable,
must be absolute.
.\"
.\" 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.
.\" These options are now obsolete
.\" .so o_major.so
.\" .so o_minor.so
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -TERse
.br
This option may be used to cause listings to
produce the bare minimum of information.
It is usually useful for shell scripts.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -Verbose
This option may be used to cause \*(n) to produce more output.
By default \*(n) only produces output on errors.
When used with the
.B -List
option
this option causes column headings to be added.
.TP 8n
\fB-VERSion\fP \fInumber\fP
This option may be used to specify the version number
for the project.
Version numbers are implemented as branches.
Use a single dash (\[lq]\f(CW\-\fP\[rq]) as the argument
if you want no version branches created.
.\"
.\" 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 aenpr '\*(n) -npr \e!* -v'
sh$ aenpr(){\*(n) -npr "$@" -v}
.fi
.SH ERRORS
It is an error if
the project name already exists.
.br
It is an error if
the project directory already exists.
.br
It is an error if
the current user does not have sufficient permissions to create
the directory specified with the
.B -DIRectory
option.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 1995, 1997, 2004, 2006-2008 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.SH EXIT STATUS
The
.I \*(n)
command will exit with a status of 1 on any error.
The
.I \*(n)
command will only exit with a status of 0 if there are no errors.
.SH ENVIRONMENT VARIABLES
See \fIaegis\fP(1) for a list of environment variables which may affect
this command.
See \fIaepconf\fP(5) for the project configuration file's
\fIproject_\%specific\fP field for how to set environment variables for
all commands executed by Aegis.
.br
.ne 1i
.SH SEE ALSO
.TP 8n
.IR aena (1)
add a new administrator to a project
.TP 8n
.IR aenbru (1)
Remove a new branch. This can often be useful if \fIaenpr\fP(1) created
some default branches for you, and now you want to get rid of them.
.TP 8n
.IR aenc (1)
add a new change to a project
.TP 8n
.IR aend (1)
add a new developer to a project
.TP 8n
.IR aenrls (1)
create a new project from an existing project
.TP 8n
.IR aenrv (1)
add a new reviewer to a project
.TP 8n
.IR aermpr (1)
remove project
.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