'\" t
.\"     aegis - project change supervisor
.\"     Copyright (C) 1991-1993, 1995, 1999, 2005-2008, 2012 Peter Miller
.\"
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 3 of the License, or
.\"     (at your option) any later version.
.\"
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program. If not, see
.\"     <http://www.gnu.org/licenses/>.
.\"
.so lib/en/man1/z_name.so
.so etc/libdir.so
.TH aegstate 5 \*(N) "Reference Manual"
.SH NAME
aegstate \- aegis global state file
.XX "aegstate(5)" "global state file format"
.SH SYNOPSIS
\f(CW\*(S)/state\fP
.SH DESCRIPTION
The \*(n) state file
is used to store
the pointers to project directories.
.SH CONTENTS
.TP 8n
where = [{ ... }];
.br
This field is a table relating project name to project directory.
The structure is as follows:
.RS
.TP 8n
project_name = string;
.br
The name of a project.
.TP 8n
directory = string;
.br
Absolute path of the project's directory.
(Only set of \fIalias_for\fP is not set.)
.TP 8n
alias_for = string;
.br
This is the name of another project, possibly including branch numbers.
It allows you to have shorter or more meaningful project names.
(Only set if \fIdirectory\fP is not set.)
.RE
.SH WRITING REPORT SCRIPTS
When attempting to access these fields from within the report generator,
you need a code fragment similar to the following:
.RS
.nf
.ft CW
auto p;
p = project[project_name()];
.ft R
.fi
.RE
That is, the \f[CW]where\fP field is represented by the \f[CW]project\fP
array variable, however, it does not mention the aliases, only the actual
projects, similar to the \[lq]\fIael projects\fP\[rq] command.  (You can,
however, index the \f[CW]projects\fP array by an alias, or even by a
project name with branches on the end.)
.PP
In addition to the \fIproject_name\fP and \fIdirectory\fP fields specified
above, the report generator insets a \fIstate\fP field, which gives
you access to the project state fields (see \fIaepstate\fP(5)
for more information).
.SH SEE ALSO
.TP 8n
.IR aegis (5)
\*(n) file format syntax
.so lib/en/man1/z_cr.so
.\" vim: set ts=8 sw=4 et :