'\" t
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1994, 1999, 2001, 2003-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) -List" 1 \*(N) "Reference Manual"
.SH NAME
aegis list \- list (possibly) interesting things
.XX "ael(1)" "list interesting things"
.SH SYNOPSIS
.B \*(n)
.B -List
[
.IR option ...
]
.I list-name
.br
.B \*(n)
.B -List
.B -List
[
.IR option ...
]
.br
.B \*(n)
.B -List
.B -Help
.SH DESCRIPTION
The
.I \*(n)
.I -List
command is used to
list information.
There are a number of possible
.IR list-name s,
as follows (abbreviations as for command line options):
.TP 8n
Administrators
.br
List the administrators of a project.
.TP 8n
Branch_Details
.br
List full information about all the changes in the branch in large
format. This listing will recurse down the full branch tree.
.TP 8n
Change_Details
.br
List full information about a change
in large format.
.TP 8n
Change_Files
.br
List all files in a change.
The verbose version includes details such as the action being taken,
the edit number of the file, and whether it's being moved.
The terse version only lists the files names (and omits removed files),
this is useful for shell scripts and interfacing with build tools.
.TP 8n
Change_File_History
.br
This listing shows the history of each file in the change. It includes
each delta number (so that you may reproduce it) and brief description,
of each change which affected each file.
.TP 8n
Change_File_INventory
.br
This listing shows the filenames and their corresponding UUIDs.
When a file is renamed, its UUID remains constant.
(If the UUID column has the filename in it, this is a backwards
compatibility value, for accessing the file history.)
.\" with a nod to GNU Arch
.TP 8n
Change_History
.br
List the history of a change.
.TP 8n
Change_INventory
.br
List the changes of a project with their UUIDs.
.TP 8n
Changes
.br
List the changes of a project.
The verbose version includes details such as the state of the change and
it's brief description. The terse version lists only the change numbers,
which is good for shell scripts.
.TP 8n
Default_Change
.br
List the default change for the specified user (defaults to the current
user if no user specified).
.TP 8n
Default_Project
.br
List the default project for the specified user (defaults to the current
user if no user specified).
.TP 8n
Developers
.br
List the developers of a project.
.TP 8n
INComplete
.br
List the changes between the \fIawaiting review\fP and \fIbeing
integrated\fP states, inclusive. Defaults to all users if no user
name specified.
.TP 8n
Integrators
.br
List the integrators of a project.
.TP 8n
List_List
.br
List all lists available.
.TP 8n
Locks
.br
List all currently active locks.
.TP 8n
Outstanding_Changes
.br
List all changes owned by the specified user that are not yet completed
(default to all users if no user specified).
.TP 8n
All_Outstanding_Changes
.br
List all changes not yet completed, for all projects.
.TP 8n
Project_Details
.br
List full information about all the changes in the project in large
format. This listing will recurse down the full branch tree below the
project.
.TP 8n
Project_Files
.br
List all files in the baseline of a project.
The verbose version includes details such as the action being taken,
the edit number of the file.
The terse version only lists the files names (and omits removed files),
this is useful for shell scripts and interfacing with build tools.
If a change number is given, files included in the change are omitted from
the list (giving the change's perspective on what the project files are).
.TP 8n
Project_File_INventory
.br
This listing shows the filenames and their corresponding UUIDs.
When a file is renamed, its UUID remains constant.
(If the UUID column has the filename in it, this is a backwards
compatibility value, for accessing the file history.)
.TP 8n
Project_History
.br
List the integration history of a project.
.TP 8n
Projects
.br
List all projects.
.TP 8n
Project_Aliases
.br
List all project aliases.
If you use the \fB\-Project\fP command line option, the list will
only include aliases of the specified project, or the project of the
specified alias.
.TP 8n
Reviewers
.br
List the reviewers of a project.
.TP 8n
State_File_Name
.br
Prints the absolute path of the project's or change's state file.
Useful for cookbooks and makefiles.
.TP 8n
Users_Changes
.br
List of changes owned by the specified user (defaults to current user
if no user specified).
.TP 8n
Version
.br
List version of a project or change.
This includes the major and minor version number,
and the previous version number if available.
The list of copyright years is also printed.
.PP
Most of these lists are available from other \*(n) functions.
Many \*(n) functions provide more specific lists.
.SH OPTIONS
The following options are understood:
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2003, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
\fB-Change\fP \fInumber\fP
This option may be used to specify a particular change within a project.
See \fIaegis\fP(1) for a complete description of this option.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.TP 8n
.B -Help
.br
This option may be used to obtain more information about how to use the
.I \*(n)
program.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see
.\" .
.\"
.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) 1991-1993, 1995, 1996, 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
.B -PAGer
The output of listings and help is piped through the pager command
given in the \f(CWPAGER\fP environment variable
(or \fImore\fP 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
.IR aeuconf (5)
file.
.TP 8n
.B -No_PAGer
.br
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
.IR aeuconf (5)
file.
.TP 8n
\fB-Page_Length\fP \fInumber\fP
.br
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 \fILINES\fP environment variable,
or set to 24 lines.
.TP 8n
\fB-Page_Width\fP \fInumber\fP
.br
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 \fICOLS\fP environment variable,
or set to 79 characters.
.\"
.\" 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.
.\"
.\" 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) 1993, 2006-2008 Peter Miller
.\" Copyright (C) 2007, 2008 Walter Franzini
.\"
.\" 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 -UNFormatted
.br
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.
.TP 8n
.B -Page-Header
This option requests that page headings be present in listings and reports.
This is the default.
.TP 8n
.B -No-Page-Header
This option requests that page headings be omitted from listings and reports.
.\"
.\" 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) 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 ael '\*(n) -l \e!* -v'
sh$ ael(){\*(n) -l "$@" -v}
.fi
.SH ERRORS
It is an error if
the list name given is unknown.
.\"
.\" 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 aedb (1)
begin development of a change (listing option)
.TP 8n
.IR aeib (1)
begin integration of a change (listing option)
.TP 8n
.IR aelcf (1)
list change files
.TP 8n
.IR aelpf (1)
list project files
.TP 8n
.IR aer (1)
report generator
.TP 8n
.IR aerpass (1)
pass review of a change (listing option)
.TP 8n
.IR aeuconf (5)
user configuration file format
.TP 8n
.IR aels (1)
annotated directory listing
.\"
.\" 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