NAME

        aerptidx - aegis report index file format

SYNOPSIS

        /usr/share/aegis/report.index
        /usr/share/aegis/report.local

DESCRIPTION

        The report index file is used to store pointers to report scripts, and descriptions of
        the reports.

        When searching for a report, the aer(1) command searches down the AEGIS_PATH looking for
        report.index files, and searching them for the report named.

CONTENTS

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

                name = string;
                        The name of a report.  The command line argument naming scheme is used,
                        to provide abbreviatable names.

                description = string;
                        A brief description of the report.  It should not be very long, one or
                        two lines at most.

                filename = string;
                        The name of the file containing the report script.  If a relative path is
                        given, it will be interpreted to be relative to the directory containing
                        the report.index file.

SEE ALSO

        aer(1)  report generator

        aegis(5)
                aegis file format syntax

COPYRIGHT

        aegis version 4.24.3.D001
        Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
        2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 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:   millerp@canb.auug.org.au
        /\/\*             WWW:   http://www.canb.auug.org.au/~millerp/