.ig
 Copyright (C) 1993,1994 by the author(s).
 
 This software is published in the hope that it will be useful, but
 WITHOUT ANY WARRANTY for any part of this software to work correctly
 or as described in the manuals. See the ShapeTools Public License
 for details.

 Permission is granted to use, copy, modify, or distribute any part of
 this software but only under the conditions described in the ShapeTools 
 Public License. A copy of this license is supposed to have been given
 to you along with ShapeTools in a file named LICENSE. Among other
 things, this copyright notice and the Public License must be
 preserved on all copies.


Author: Andreas Lampen (Andreas.Lampen@cs.tu-berlin.de)

$Header: af_archive.5[7.0] Fri Jun 25 14:33:24 1993 andy@cs.tu-berlin.de frozen $
..
.TH af_archive 5 "" \n(dy.\n(mo.\n(yr
.SH NAME
af_archive -- format of archive files in the \fIAttribute Filesystem\fR
.SH SYNOPSIS
\fB#include <atfs.h>
.br
#include <afsys.h>
.SH DESCRIPTION
AtFS archive files are used to store the data and attributes of
non-busy ASOs.
Beside these, some attributes (including all user defined attributes)
of busy ASOs are stored in AtFS archive files.
.PP
AtFS maintains two archive files for each line of development,
one to hold the standard- and the user defined attributes and
the other to hold the data and change notes.
These files are stored either in a subdirectory named \fCAtFS\fR
or in a explicitly named directory somewhere in your file system.
The two archive files are named
.br
	\fCAttr/<filename>\fR		(attributes) and
.br
	\fCData/<filename>\fR		(data).
.PP
This manual contains a short, exemplary description of the archive structure.
All data in AtFS-archives are stored as ASCII-strings.
The archives contain keywords and keyletters. These are set in
\fBboldface\fR in the following description.
Strings of the form \fI<field>\fR describe
the purpose of the appropriate field in the archive.
.PP
Here's the structure (the attributes file first):
.sp
.ce
The Header, ...
.nf
.sp
\fB^BARHD\fR   <archive_format_version>   <no_of_revisions>   <size_of_data>
.sp
.ce
\&... the name ..
.sp
\fB^BI\fR   <hostname>   <path>   <name>   <type>   <variant(unused)>
.sp
.ce
\&... and the owner ..
.sp
\fB^BO\fR   <owner's_name>   <owner's_host>   <owner's_domain>
.sp
.ce
\&... followed by some attributes for the busy version ...
.sp
\fB^BP\fR   <gen_>   <rev_of_physical_predecessor>
.br
\fB^BL\fR   <locker's_name>   <locker's_host>   <locker's_domain>   <date_of_last_lock_change>
.sp
.ce 2
\&... and the revision list, that contains all standard 
attributes for non-busy versions. ... 
.sp
\fB^BR\fR   <generation>   <revision>   <state>   <mode>   <variant(unused)>
.br
	\fB^BA\fR   <author's_name>   <_host>   <_domain>   <locker's_name>   <_host>   <_domain>
.br
	\fB^BT\fR   <date_of_last_modification>   <_last_access>   <_last_status_change>   ...
.in +3.3i
\&...   <_saving>   <_locking>
.in -3.3i
	\fB^BM\fR   <kind_of_representation>   <size_of_file>   <size_of_delta>   ...
.br
			...   <gen_>   <rev_of_phys._successor>   <gen_>   <rev_of_phys._predecessor>
.br
\fB^BR ...\fR
.br
\fB^BR ...\fR
.sp
.ce 2
\&... Now follows the list of lists of user defined attributes
("-2 -2" indicates the busy version; "\fC@\fR" stands for a null byte). ...
.sp
\fB^BUSEG\fR
\fB^BU -2 -2\fR
\fCmachine=vax@data=fs@@\fR
\fB^BU\fR   <gen>   <rev>
\fCname=value@@\fR
\fB^BU ...\fR
.sp 0.5i
The structure of the datafile:
.sp
Data are represented either by deltas or by complete data-chunks...
.sp
\fB^BDATA\fR   <archive_format_version>
.sp
\fB^BN\fR   <gen>   <rev>   <size_of_note>
\fC--- empty log message ---\fR
.sp
\fB^BD\fR   <gen>   <rev>   <kind_of_representation>   <size_of_data>
\fCA typical delta looks like:\fR
\fC@67723@@@@44@67756@^A14@some text@6635@ and so on.\fR
\fCDeltas are indicated by a "1" at the "kind_of_representation" field.
.sp
\fB^BN\fR   <gen>   <rev>   <size_of_note>
\fCThis is a log message\fR
.sp
\fB^BD\fR   <gen>   <rev>   <kind_of_representation>   <size_of_data>
\fCA "0" at the "kind_of_representation" field indicates that this
version is stored completely.\fR
.sp
\fB^BN ...\fR
.sp
\fB^BD ...\fR
.fi
.SH AUTHOR
Andreas Lampen, Tech. Univ. Berlin (andy@cs.tu-berlin.de)