.\" .\" aegis - project change supervisor .\" Copyright (C) 2001-2006 Peter Miller; .\" All rights reserved. .\" .\" 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 2 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, write to the Free Software .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. .\" .\" MANIFEST: input for archive/aegis.html .\" .de an-p-footer .. .ad l .hy 0 .so version.so .br .br .br Aegis Documents

Aegis \*(v)
Documentation

There is a variety of documentation available.
User Guide
The Aegis User Guide contains information about how Aegis works, and the model of software development that Aegis embodies. It contains a worked example, to lead new users through some example changes. It contains information about configuring the various aspects of using Aegis.
Reference Manual
The Aegis Reference Manual contains all of the installation instructions, all of the man pages, and a permuted index.
HOWTO
The Aegis HOWTO contains “how to” perform a number of tasks in Aegis.
Aegis, A Project Change Supervisor
This is the original conference paper about Aegis. It gives a brief outline of the process and the benefits.
Aegis Is Only For Software, Isn't It?
This paper talks about how to use Aegis for managing DNS and for managing web pages.
Recursive Make Considered Harmful
This paper talks about the build process for large projects, and some of the pitfalls when using Make.
There is also a German translation available, courtesy of CM Magazin.
CVS Transition Guide
The CVS Transition Guide contains information of use to CVS users who are converting their project to use Aegis, or who are thinking of doing do.
Testing? What Testing?
This paper talks about software attributes for supporting functional testing.
Aegis Documentation for Developers
Contains the documentation of internal Aegis API. Please note: this is work in progress.

All of the documents are in Adobe Acrobat (pdf) format. You can obtain free pdf readers, such as

.\" .\" aegis - project change supervisor .\" Copyright (C) 2001-2005 Peter Miller; .\" All rights reserved. .\" .\" 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 2 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, write to the Free Software .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. .\" .\" MANIFEST: input for archive/aegis.html .\" .de an-p-footer .. .ad l .hy 0 .so version.so .br .br .br Aegis Documents

Aegis \*(v)
Documentation

There is a variety of documentation available in PDF format. The PDF documents may be printed and bound to produce very useful reference material.

DocBook Versions

The documentation is produced using GNU Groff, producing only PDF output, without links. Ralph Smith has produced versions of the documentation using DocBook, generating HTML versions, and PDF versions with links.


User Guide

The Aegis User Guide contains information about how Aegis works, and the model of software development that Aegis embodies. It contains a worked example, to lead new users through some example changes. It contains information about configuring the various aspects of using Aegis. (See also Ralf's HTML version.)


Reference Manual

The Aegis Reference Manual contains all of the installation instructions, all of the man pages, and a permuted index. (See also Ralf's HTML version.)


How To

The Aegis How To contains “how to” perform a number of tasks in Aegis. (See also Ralf's HTML version.)


Aegis, A Project Change Supervisor

This is the original conference paper about Aegis. It gives a brief outline of the process and the benefits.


Aegis Is Only For Software, Isn't It?

This paper talks about how to use Aegis for managing DNS and for managing web pages.


Recursive Make Considered Harmful

This paper talks about the build process for large projects, and some of the pitfalls when using Make.

There is also a German translation available, courtesy of CM Magazin.


CVS Transition Guide

The CVS Transition Guide contains information of use to CVS users who are converting their project to use Aegis, or who are thinking of doing do.


Testing? What Testing?

This paper talks about software attributes for supporting functional testing.


Aegis Documentation for Developers

Contains the documentation of internal Aegis API. This documentation is generated from the source code using Doxgen.


Download a PDF Viewer

All of the documents are in Adobe Acrobat (pdf) format. You can obtain free pdf readers, such as
  • Adobe's Acroread can view and print Adobe PDF files across a broad range of hardware.
  • GhostView is a program to view and navigate through PostScript and PDF documents on an X display by providing a user interface for the ghostscript interpreter. It is based on ghostview.
  • Xpdf is a viewer for Portable Document Format (PDF) files. Xpdf runs under the X Window System on UNIX, VMS, and OS/2. The non-X components of the package (pdftops, pdftotext, etc) also run on Win32 systems and should run on pretty much any system with a decent C++ compiler.
.so footer.so