* Variable names, comments, documentation, etc... removed the acronym 'BBS'

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

diff --git a/citadel/techdoc/netconfigs.txt b/citadel/techdoc/netconfigs.txt
index 9d66b620388113f8feb6de5bb132b3468299c191..55434fb050bb0f208e8245793c1ab53ad667d722 100644 (file)
--- a/citadel/techdoc/netconfigs.txt
+++ b/citadel/techdoc/netconfigs.txt
@@ -2,7 +2,7 @@
            Description of the files in the "netconfigs" directory
 
  These files contain a set of network configurations for a room.  They are
-stored in the directory $BBSDIR/netconfigs and are named according to each
+stored in the directory $CTDLDIR/netconfigs and are named according to each
 room's internal ID number.  When a room is deleted, its network configuration
 file is deleted as well.
   
@@ -40,25 +40,34 @@ e-mail address instead of the sender's e-mail address.
  
  INSTRUCTION:  ignet_push_share
  SYNTAX:       ignet_push_share|uncnsrd
+          (or) ignet_push_share|uncnsrd|Foo Bar Baz
  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.
  
+    If the third argument is present, it is the name of the corresponding
+room on the remote node.  This allows a room to be shared even when the room
+name is different on each node.  Such a configuration *must* be configured
+mutually: each node must know the name of the room on the other.
+ 
   
  INSTRUCTION:  subpending
- SYNTAX:       subpending|friko@mumjiboolean.com|listrecp|A234Z|1234567890
+ 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 "listrecp"
-or "digestrecp" to specify a normal subscription or a digest subscription.
+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
+ 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.
+requests.  The same rules apply with regard to the token and the web page.