* Replaced all "Citadel/UX" references with "Citadel"

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

diff --git a/citadel/techdoc/netconfigs.txt b/citadel/techdoc/netconfigs.txt
index ba7c19866f6e92f18df0838e67d90bea69fdcd74..e76cbc1c78f1920cdfa9f8e7ff5172fed1543c6c 100644 (file)
--- a/citadel/techdoc/netconfigs.txt
+++ b/citadel/techdoc/netconfigs.txt
@@ -1,3 +1,4 @@
+ 
            Description of the files in the "netconfigs" directory
 
  These files contain a set of network configurations for a room.  They are
@@ -20,6 +21,47 @@ we have performed outbound network processing on.  Any batch job which sends
 out messages should do stuff.
  
  
- INSTRUCTION:  foo
- SYNTAX:       lastsent|0000000
+ INSTRUCTION:  listrecp
+ SYNTAX:       listrecp|friko@mumjiboolean.com
+ DESCRIPTION:
+    Defines a recipient to whom all messages in this room should be sent.  This
+is used for "list serve" applications.
+ 
+ 
+ INSTRUCTION:  digestrecp
+ SYNTAX:       digestrecp|friko@mumjiboolean.com
+ DESCRIPTION:
+    Defines a recipient to whom all messages in this room should be sent.  This
+is used for "list serve" applications.  The difference between listrecps and
+digestrecps is that the latter will have messages embedded inside a message
+sent by the listserver.  The message will appear to be sent by the room's
+e-mail address instead of the sender's e-mail address.
+ 
+ 
+ INSTRUCTION:  ignet_push_share
+ SYNTAX:       ignet_push_share|uncnsrd
  DESCRIPTION:
+    Specifies that the second argument is the name of a neighboring node on an
+IGnet (Citadel networking) network, to which this room should be pushed
+(spooled).  Conceptually, this node will have a corresponding record pushing
+data in the other direction.
+ 
+  
+ INSTRUCTION:  subpending
+ SYNTAX:       subpending|friko@mumjiboolean.com|listrecp|A234Z|1234567890|http://foo.com/lists
+    "Subscription pending" for the specified address.  This means that
+someone has requested to subscribe an e-mail address (in this case,
+friko@mumjiboolean.com) to the list.  The third parameter is either "list"
+or "digest" to specify a normal subscription or a digest subscription.
+The fourth parameter is an authentication token which is generated by the server
+and e-mailed to the specified address.  When the user comes back and supplies
+this token, the subscription is complete.  The fifth parameter is a simple
+timestamp, so that we may purge old records which were never confirmed.
+ 
+ The sixth field is the URL of the web page used to enter the subscription
+request, minus any parameters.
+ 
+ INSTRUCTION:  unsubpending
+ SYNTAX:       unsubpending|friko@mumjiboolean.com|A234Z|1234567890|http://foo.com/lists
+    Similar to the 'subpending' command, except this one is for unsubscribe
+requests.  The same rules apply with regard to the token and the web page.