home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / echobeta.zip / SBBSECHO.DOC < prev    next >
Text File  |  1995-04-24  |  12KB  |  361 lines
  1. SBBSecho · Version 1.00 ßeta · Documentation  Copyright 1995 Digital Dynamics
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. SBBSecho is a full-blown FidoNet echomail program for Synchronet version 2.
  5.  
  6. It is intended to replace FTSC-1 (*.MSG) compatible echomail programs (GEcho,
  7. Squish, FastEcho, Alexi/Mail, etc.) and SBBSFIDO with a single program
  8. incorporating the standard features of echomail programs without the .MSG
  9. phase.
  10.  
  11. You will not need to use SBBSFIDO or any other echomail program after you
  12. have installed SBBSecho.
  13.  
  14. Attach or FLO Mailer?
  15. ~~~~~~~~~~~~~~~~~~~~~
  16. If you are using FrontDoor, InterMail, D'bridge, SEAdog, Dutchie, or any other
  17. ArcMail *.MSG attach-style mailer, you are using what we will refer to as an
  18. "Attach Mailer".
  19.  
  20. If you are using BinkleyTerm, Portal of Power, or any other FLO/CLO/HLO/DLO
  21. style mailer, you are using what we will refer to as a "FLO Mailer".
  22.  
  23. Both types are supported by SBBSecho.
  24.  
  25. SBBSECHO.EXE
  26. ~~~~~~~~~~~~
  27. Before running SBBSecho, make sure your SBBSNODE environment variable is set.
  28. Example:
  29.  
  30.     SET SBBSNODE=C:\SBBS\NODE1
  31.  
  32. The command line for executing SBBSECHO is very similar to SBBSFIDO, although
  33. some command line switches have been eliminated.
  34.  
  35. We suggest you use the following command lines:
  36.  
  37. For importing:
  38.  
  39.     C:\SBBS\EXEC\SBBSECHO /LES!
  40.  
  41. For exporting (Attach Mailer):
  42.  
  43.     C:\SBBS\EXEC\SBBSECHO /LIN
  44.  
  45. For exporting (FLO Mailer):
  46.  
  47.     C:\SBBS\EXEC\SBBSECHO /LINF
  48.  
  49. Remove all references to SBBSFIDO from your batch files (if you have any).
  50. See the included MAILER.BAT for example.
  51.  
  52. Syntax
  53. ~~~~~~
  54. usage: sbbsecho [cfg_file] [/switches] [sub_code]
  55.  
  56. where: cfg_file is the filename of config file (default is ctrl\sbbsecho.cfg)
  57.        sub_code is the internal code for a sub-board (default is ALL subs)
  58.  
  59. valid switches:
  60.  
  61. p: do not import packets                 x: do not delete packets after import
  62. n: do not import netmail                 d: do not delete netmail after import
  63. i: do not import echomail                e: do not export echomail
  64. m: ignore echomail ptrs (export all)     u: update echomail ptrs (export none)
  65. j: ignore recieved bit on netmail        t: do not update echomail ptrs
  66. l: create log file (data\sbbsecho.log)   r: create report of import totals
  67. h: export all echomail (hub rescan)      b: import locally created netmail too
  68. a: export ASCII characters only          f: create packets for outbound netmail
  69. y: import netmail for unknown users to sysop
  70. o: import all netmail regardless of destination address
  71. s: import private echomail override (strip private status)
  72. =: change existing tear lines to ===
  73. !: notify users of received echomail
  74.  
  75. SBBSECHO.CFG
  76. ~~~~~~~~~~~~
  77. SBBSecho expects to find the file SBBSECHO.CFG in your Synchronet CTRL
  78. directory. Copy the example SBBSECHO.CFG file included into your CTRL
  79. directory. If you are a registered owner of SBBSecho, add the following line:
  80. REGNUM xxxxxxxx
  81. to your SBBSECHO.CFG file (where xxxxxxxx is your SBBSecho registration number)
  82.  
  83. Lines beginning with a semicolon (;) are considered comments, and are ignored.
  84.  
  85. The following configuration keywords are allowed:
  86.  
  87. REGNUM xxxxxxxx
  88.  
  89.     Registration number
  90.  
  91. FLO_MAILER
  92.  
  93.     This is required if using a FLO mailer.  The /F SBBSECHO command line
  94.     switch should also be used.
  95.  
  96. FUZZY_ZONE
  97.  
  98.     This tells SBBSecho to ignore the zone on in-bound NetMail and change
  99.     the originating zone to the destination zone if the destination
  100.     net and node numbers match one of your addresses. This should only be
  101.     used if you are in multiple networks using different zones and are
  102.     receiving NetMail without the INTL kludge line.
  103.  
  104. LOGFILE x:\xxx\xxx
  105.  
  106.     Specify log path and filename.    Default: DATA\SBBSECHO.LOG.
  107.     The /L SBBSECHO command line switch should also be used.
  108.  
  109. NOSWAP
  110.  
  111.     Don't swap-out for archivers
  112.  
  113. STORE_SEENBY
  114.  
  115.     Store SEEN-BY lines in SMB message base
  116.  
  117. STORE_PATH
  118.  
  119.     Store PATH lines in SMB message base
  120.  
  121. STORE_KLUDGE
  122.  
  123.     Store unknown kludge lines in SMB message base
  124.  
  125. AREAFILE x:\xxx\xxx
  126.  
  127.     Path and filename of alternate AREAS.BBS.  Default: DATA\AREAS.BBS
  128.  
  129. INBOUND  x:\xxx\xxx
  130.  
  131.     Alternate inbound FidoNet file directory.
  132.     Default: SCFG->Networks->FidoNet->Inbound
  133.  
  134. SECURE_INBOUND    x:\xxx\xxx
  135.  
  136.     Additional inbound FidoNet file directory (optional).
  137.  
  138. OUTBOUND x:\xxx\xxx
  139.  
  140.     Outbound FidoNet packet directory (required).
  141.  
  142. ARCSIZE xxx
  143.  
  144.     Maximum bundle size (in K).  Default: 250k
  145.  
  146. PKTSIZE xxx
  147.  
  148.     Maximum packet size (in K).  Default: 250k
  149.  
  150. PACKER ext len hdr
  151.   PACK pack %F %S
  152.   UNPACK unpack %F %S
  153. END
  154.  
  155.     Packer/archiver definition
  156.     "ext" is the file extension for this archiver
  157.     (i.e. ZIP, ARC, ARJ, LZH, etc.)
  158.     "len" is the byte length of the file signature
  159.     "hdr" is the hexadecimal file signature
  160.     "pack" is the archive creation command line where %f indicates the
  161.     destination filename and %s indicates the source filename(s)
  162.     "unpack" is the archive extraction command line where %f indicates the
  163.     archive filename and %s indicates the directory to extract to
  164.     "end" marks the end of EACH packer definition
  165.  
  166. USEPACKER
  167.     ext uplinks
  168.     ext uplinks
  169. END
  170.  
  171.     Specify which packer to use for which uplinks
  172.     "ext" is a valid packer extension (i.e. ZIP, ARC, ARJ, LZH, etc)
  173.     "uplinks" is a list of addresses which instructs SBBSecho to use this
  174.     packer type when sending bundles to these addresses
  175.     "end" marks the end of usepacker information
  176.  
  177. HOLD uplinks or ALL
  178.  
  179.     Hold status on bundles/packets for uplinks
  180.     "ALL", if used, specified default status for all uplinks
  181.     Attach mailers may override this
  182.  
  183. CRASH uplinks or ALL
  184.  
  185.     Crash status on bundles/packets for uplinks
  186.     "ALL", if used, specified default status for all uplinks
  187.     Attach mailers may override this
  188.  
  189. DIRECT uplinks or ALL
  190.  
  191.     Direct status on bundles/packets for uplinks
  192.     "ALL", if used, specified default status for all uplinks
  193.     Attach mailers may override this
  194.  
  195. PASSIVE uplinks or ALL
  196.  
  197.     Temporarily disable uplinks
  198.     "ALL", if used, disables all uplinks
  199.  
  200. PKTPWD address password
  201.  
  202.     Instructs SBBSecho to use a packet password for the address listed.
  203.     This is not to be confused with session level passwords or areafix
  204.     passwords.
  205.  
  206. AREAFIX
  207.    addr password flags
  208.    addr password flags
  209. END
  210.  
  211.     Areafix information
  212.     Enable areafix for address "addr" using "password" for the password
  213.     and give this address this list of "flags" for defining access to echo
  214.     lists.
  215.     "end" marks the end of Areafix information
  216.  
  217. ECHOLIST [FORWARD addr password]
  218.     x:\xxx\xxx flags
  219.     x:\xxx\xxx flags
  220. END
  221.  
  222.     Additional echo lists available for AreaFix
  223.     FORWARD addr (without brackets) is an optional address of where to
  224.     forward unknown area requests (most likely your hub's address) and
  225.     password is the Areafix password you use on your hub.
  226.     "x:\xxx\xxx" is the path an additional echolist
  227.     (e.g. C:\BACKBONE\FIDONET.NA)
  228.     "flags" is a list of required flags a node must have (defined under
  229.     AREAFIX) to be able to add areas from this list
  230.     "end" marks the end of echolist definitions
  231.  
  232.  
  233. AREAS.BBS
  234. ~~~~~~~~~
  235. SBBSecho expects to find the file AREAS.BBS in your Synchronet DATA directory
  236. unless you have overridden the default name and/or location with the AREAFILE
  237. keyword in your SBBSECHO.CFG file. The format of this file is very similar to
  238. the standard AREAS.BBS (which many echomail programs use, or can at least
  239. export their native area file to this format - i.e. GEcho's GSETUP).
  240.  
  241. SCFG can also export your sub-boards to AREAS.BBS, but you're probably better
  242. off modifying the AREAS.BBS file you're already using (if you are) or
  243. converting your current echomail program's area file to AREAS.BBS. This is
  244. because SCFG assumes the sub-board short name will be the same as the area's
  245. tag (as shown in your echo list), but this may not always be the case - unless
  246. you imported an AREAS.BBS file into SCFG to begin with).
  247.  
  248. Lines beginning with a semicolon (;) are considered comments, and are ignored.
  249.  
  250. Each line is in the following format:
  251.  
  252. CODE    TAG    UPLINKS
  253.  
  254. Where:
  255.     CODE is ther internal code of the sub-board or any other text will
  256.         be considered "Passthru" (not imported to your BBS)
  257.  
  258.     TAG is the FidoNet tag as shown in your echo list (i.e. FIDONET.NA).
  259.         If this is '*', then it will be considered a "badecho" area
  260.         and will receive all "unknown" area messages.
  261.  
  262.     UPLINKS is a list of FidoNet addresses which you wish to export mail
  263.         to. At the very least, your hub's address should be listed
  264.         here. Your address should NOT be listed here.
  265.  
  266. Example:
  267.  
  268. SBBS        SYNCHRONET    1:3615/50
  269. SYNCDATA    SYNCDATA    1:3615/50
  270. SYNC_SYS    SYNC_SYSOPS    1:3615/50
  271.  
  272. The amount of spacing between each element in the line is not important. Each
  273. line can be up to 255 characters in length.
  274.  
  275. So if your OLD AREAS.BBS file is in .MSG format (for example):
  276.  
  277. C:\FD\ECHO\SBBS     SYNCHRONET    1:3615/50
  278.  
  279. It must be changed to match the example given above!
  280.  
  281.  
  282. AREAFIX Commands
  283. ~~~~~~~~~~~~~~~~
  284. The following text is from the file AREAMGR.HLP which should be placed into
  285. your \SBBS\EXEC directory.  It lists the area manager commands available to
  286. the nodes listed under 'AREAFIX' in your SBBSecho configuration file:
  287.  
  288. Address all requests to 'SBBSecho' or 'AreaFix' (without quotes).
  289. Your Area Manager password goes on the subject line.
  290.  
  291. In the body of the message to Area Manager:
  292.  
  293. [+]<areaname>         Connect an area
  294. -<areaname>           Disconnect an area
  295. %HELP                 Request this message
  296. %LIST                 Request a list of areas available to you
  297. %QUERY                Request a list of areas to which you are connected
  298. %UNLINKED             Request a list of areas to which you are not connected
  299. %COMPRESSION <type>   Change the compression type (ARC/ARJ/LZH/PAK/SQZ/ZIP/ZOO)
  300. %PASSWORD <password>  Change your AreaMgr password
  301. %RESCAN           * Request a rescan of new added areas
  302. %ACTIVE               Reconnect all temporary disconnected areas
  303. %PASSIVE              Temporary disconnect all connected areas
  304. %FROM <address>       * Remote maintenance, must be the first command  {+}
  305. %+ALL              * Connect all available areas
  306. %-ALL              * Disconnect all areas
  307. [---]                 Everything below the tear line is ignored
  308.  
  309. * These commands are not yet available.
  310.  
  311.  
  312. UNREGISTERED
  313. ~~~~~~~~~~~~
  314. The unregistered copy of SBBSecho has periodic beeps, tones, and delays.
  315. It is not crippled in any other way. Entering your valid registration number
  316. into SBBSECHO.CFG will eliminate these annoyances.
  317.  
  318. Complete the SBBSECHO.FRM file and send to Digital Dynamics or call voice
  319. at 714-529-6328 to place your order.
  320.  
  321. If you are a registered owner of SBBSecho and DO NOT already have your
  322. SBBSecho registration number, please contact Digital Dynamics voice to obtain
  323. your registration number. You must have your Synchronet registration number and
  324. control code on hand when you call.
  325.  
  326.  
  327. BETA NOTES
  328. ~~~~~~~~~~
  329. The file AREAMGR.HLP is included in this beta, place it into your Synchronet
  330. EXEC directory.
  331.  
  332. If upgrading from an earlier beta (before 04/18/95), please make the changes
  333. to the PACK and UNPACK lines in your SBBSECHO.CFG (as shown in the included
  334. SBBSECHO.CFG file).
  335.  
  336. New SECURE_INBOUND and FUZZY_ZONE configuration key words.
  337.  
  338. Packet passwords (PKTPWD) should be working now. They worked in the 4/23
  339. release ONLY if there was an AREAFIX or CRASH/HOLD/DIRECT line for that
  340. address before the PKTPWD in the SBBSECHO.CFG file.
  341.  
  342. Paths and Seen-bys are now created with addresses (AKAs) that match the
  343. packet destination address instead of the main system address.
  344.  
  345. This program (and documentation) are in the early beta stages, so don't judge
  346. this product too hastily. The AREAFIX portion of SBBSecho is still under
  347. construction, but simply listing available areas, and turning on and off areas 
  348. in your AREAS.BBS should work fine in this beta. The additional "echo list"s
  349. may not be currently available when adding areas.
  350.  
  351. Multiple flavors of SBBSECHO.EXE are included in this archive:
  352.  
  353. 16-bit DOS:    Your normal 16-bit real-mode DOS executable
  354.  
  355. 32-bit DOS4G:    32-bit protected mode executable using the DOS4G DOS extender
  356.         Requires DOS4GW.EXE in search path
  357.  
  358. 32-bit OS/2:    32-bit pretected mode executable for OS/2 v2.x and later
  359.  
  360. /* End of SBBSECHO.DOC */
  361.