aegstate

aegstate(5)                   File Formats Manual                  aegstate(5)



NAME
        aegstate - aegis global state file

SYNOPSIS
        /usr/local/com/state

DESCRIPTION
        The aegis state file is used to store the pointers to project
        directories.

CONTENTS
        where = [{ ... }];
                This field is a table relating project name to project
                directory.  The structure is as follows:

                project_name = string;
                        The name of a project.

                directory = string;
                        Absolute path of the project's directory.  (Only set
                        of alias_for is not set.)

                alias_for = string;
                        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 directory is not set.)

WRITING REPORT SCRIPTS
        When attempting to access these fields from within the report
        generator, you need a code fragment similar to the following:
                auto p;
                p = project[project_name()];
        That is, the where field is represented by the project array variable,
        however, it does not mention the aliases, only the actual projects,
        similar to the “ael projects” command.  (You can, however, index the
        projects array by an alias, or even by a project name with branches on
        the end.)

        In addition to the project_name and directory fields specified above,
        the report generator insets a state field, which gives you access to
        the project state fields (see aepstate(5) for more information).

SEE ALSO
        aegis(5)
                aegis file format syntax

COPYRIGHT
        aegis version 4.25.D510
        Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
        2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
        2011, 2012 Peter Miller

        The aegis program comes with ABSOLUTELY NO WARRANTY; for details use
        the 'aegis -VERSion License' command.  This is free software and you
        are welcome to redistribute it under certain conditions; for details
        use the 'aegis -VERSion License' command.

AUTHOR
        Peter Miller   E‐Mail:   pmiller@opensource.org.au
        /\/\*             WWW:   http://miller.emu.id.au/pmiller/



Reference Manual                     Aegis                         aegstate(5)