* 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 08206d4552a2ee0454761bbe8cdf14f2211cfa7b..e76cbc1c78f1920cdfa9f8e7ff5172fed1543c6c 100644 (file)
--- a/citadel/techdoc/netconfigs.txt
+++ b/citadel/techdoc/netconfigs.txt
@@ -42,8 +42,26 @@ e-mail address instead of the sender's e-mail address.
  SYNTAX:       ignet_push_share|uncnsrd
  DESCRIPTION:
     Specifies that the second argument is the name of a neighboring node on an
-IGnet (Citadel/UX networking) network, to which this room should be pushed
+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.