Describe packages index syntax.

1 files changed, 34 insertions, 0 deletions

diff --git a/dev/archive/layout.mdwn b/dev/archive/layout.mdwn
index f7fa8f7..6ecadb0 100644
--- a/dev/archive/layout.mdwn
+++ b/dev/archive/layout.mdwn
@@ -136,6 +136,40 @@ be located at the following path at a mirror site:
     /pub/proteanos/pool/main/e/expat/libexpat.1_2.1.0-2_core-linux-eglibc_all.opk
 
 
+Packages Index Syntax
+=====================
+
+The packages index file syntax is that used by APT, opkg, etc.  It consists of
+paragraphs of fields, with paragraphs separated by empty lines.  Each field
+consists of the field name, a colon (`:`), and the field value.  Some fields may
+have values spanning multiple lines; each line after the first in a value must
+begin with at least one space.
+
+The fields in a paragraph are the control fields generated for binary packages
+by ob-gencontrol, plus `Installed-Size`, `Filename`, `Size`, and `MD5sum`.
+
+Example
+-------
+
+An example paragraph of a packages index follows:
+
+    Package: libexpat.1
+    Source: expat
+    Version: 2.1.0-2
+    Architecture: core-linux-eglibc
+    Platform: all
+    Maintainer: "P. J. McDermott" <pjm@nac.net>
+    Installed-Size: 530
+    Filename: ../../../../../pool/main/e/expat/libexpat.1_2.1.0-2_core-linux-eglibc_all.opk
+    Size: 176465
+    MD5sum: 7d7984ab0c910ba525410562cfdb5315
+    Description: XML parser library
+     Expat is an XML parser library written in C. It is a stream-oriented parser in
+     which an application registers handlers for things the parser might find in the
+     XML document (like start tags).
+    Homepage: http://expat.sourceforge.net/
+
+
 References
 ==========