* hack.doc: updated to reflect Cit86Net compatibility fields removed from the

[citadel.git] / citadel / techdoc / hack.txt

diff --git a/citadel/techdoc/hack.txt b/citadel/techdoc/hack.txt
index cad393b1fcb00b4283b76dd021acd2d112794389..649efa5260a625093ba7319d2a926ddf23886429 100644 (file)
--- a/citadel/techdoc/hack.txt
+++ b/citadel/techdoc/hack.txt
@@ -1,5 +1,5 @@
  hack.txt for Citadel/UX
- written by Art Cancro (ajc@uncnsrd.mt-kisco.ny.us)
+ (some of this stuff is *very* out of date.)
    
    Much of this document is borrowed from the original hack.doc from
 Citadel-CP/M and Citadel-86, because many of the concepts are the same.  Hats
@@ -78,16 +78,17 @@ all software should be written to IGNORE fields not currently defined.
 BYTE   Mnemonic        Comments
 
 A      Author          Name of originator of message.
-B      Phone number    The dialup number of the system this message
-                       originated on.  This is optional, and is only
-                       defined for helping implement C86Net gateways.
 D      Destination     Contains name of the system this message should
                        be sent to, for mail routing (private mail only).
-G      Gateway domain  This field is provided solely for the implementation
-                        of C86Net gateways, and holds the C86Net domain of
-                        the system this message originated on.  Unless you're
-                        implementing such a gateway, there's no need to even
-                        bother with this field.
+E      Extended ID     A persistent alphanumeric Message ID used for
+                       network replication.  When a message arrives that
+                       contains an Extended ID, any existing messages which
+                       contain the same Extended ID and are *older* than this
+                       message should be deleted.  If there exist any messages
+                       with the same Extended ID that are *newer*, then this
+                       message should be dropped.
+F      rFc822 address  For Internet mail, this is the delivery address of the
+                       message author.
 H      HumanNodeName   Human-readable name of system message originated on.
 I      Original ID     A 32-bit integer containing the message ID on the
                        system the message *originated* on.
@@ -105,17 +106,17 @@ S       Special field   Only meaningful for messages being spooled over a
                         network.  Usually means that the message isn't really
                         a message, but rather some other network function:
                         -> "S" followed by "FILE" (followed by a null, of
-                        course) means that the message text is actually an
-                        IGnet/Open file transfer.
+                           course) means that the message text is actually an
+                           IGnet/Open file transfer.
+                       -> "S" followed by "CANCEL" means that this message
+                          should be deleted from the local message base once
+                          it has been replicated to all network systems.
 T      Date/Time       A 32-bit integer containing the date and time of
                         the message in standard UNIX format (the number
                         of seconds since January 1, 1970 GMT).
 U       Subject         Optional.  Developers may choose whether they wish to
                         generate or display subject fields.  Citadel/UX does
                         not generate them, but it does print them when found.
-Z      Zap (supersede) Indicates a message which this message supersedes.
-                       The format is "user@node" and if the specified message
-                       is found, it should be deleted.
   
                        EXAMPLE