home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / echofx12 / echofix.doc next >
Text File  |  1990-07-08  |  19KB  |  525 lines
  1.                                  EchoFix St
  2.  
  3.                      -* Areafixer for Atari ST series *-
  4.  
  5.                    Copyright Rinaldo Visscher (2:282/320.3)
  6.  
  7.                              English Users Manual
  8.  
  9.                                 for version 1.0
  10.  
  11.                    Its recommended that you read this text 
  12.                   before starting, or at least print it out 
  13.                    and lay it next to your computer before 
  14.                     using the program for the first time. 
  15.  
  16. This program is free to copy for use on every BBS. It is forbidden to sell
  17. this program for any profit. This program may 
  18. not be distributed to or through commercial PD services.  Also, any, 
  19. commercial use or reproduction of this program can only be made with 
  20. the explicit approval of the author. 
  21.  
  22. This archive ECHOFIX.ARC must contain the following files.
  23.  
  24. ECHOFIX.DOC     This document
  25. ECHOFIX.PRG     Areafixer
  26. EFIXINST.PRG    Installation program
  27. INSTALL.RSC     Resource for installation program
  28.  
  29. This document contents
  30.  
  31. 1. WHAT IS ECHOFIX
  32. 2. WHAT IS NEEDED
  33. 3. HOW DO I START
  34.  A. Enter fake number
  35.  B. Areafixer
  36.  C. Pasword file
  37.  D. Controlfile
  38. 4. HOW TO CALL ECHOFIX
  39.  A. -C option
  40.  B. -B option
  41.  C. -M option
  42. 5. WHEN I START WHAT HAPPENS
  43. 6. HOW MUST A POINT OR NODE WRITE A MESSAGE TO ECHOFIX
  44. 7. HOW TO MAKE A PASWORDFILE
  45. 8. WHAT IS THE CONTROLFILE
  46. 9. HOW TO MAKE A CONTROLFILE
  47. 10.CAN I SEND A MESSAGE WITH THE CONFIRMATION REPORT
  48. 11.HOW CAN I SEE WAT IS HAPPEND
  49. 12.ERRORLEVELS
  50. DISCLAIMER
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62. 1. What is EchoFix.
  63. -------------------
  64.  
  65. The program connect and disconnect message areas. It's easy to use and very 
  66. fast. You can make private message areas for local use etc. The program
  67. works with 3d and 4d addressing. It's programmed only for users that have
  68. The-Box as mailer. It reads your netmail if there's any message for
  69. EchoFix. How to write a message to EchoFix will be explained later.
  70.  
  71.  
  72. 2. What's needed.
  73. -----------------
  74.  
  75. a. You must have a nodenumber
  76. b. The-Box as mailer. (This program reads TB.CFG)
  77. c. The file AREAS.BBS (Also readed)
  78. d. A control file (Explained later in this manual)
  79. e. Netmail area.
  80.  
  81. 3. How do I start.
  82. -----------------
  83.  
  84. First start EFIXINST.PRG. There are some question's for you in a dialogbox.
  85.  
  86. a. Enter your fakenet.
  87. There you must enter which fakenumber or 3D number you are using. If your
  88. points using 3D number 6320 enter 6320. Why, if your point writes a
  89. message to EchoFix using 3D adres this program needs this number to convert
  90. it into a 4D message. If there is no number entered this message will be
  91. skipped. If there is a message found with 3D number 6320/<pointno> then
  92. the number will be converted to (if you are node 2:282/320.0) to 
  93. 2:282/320.<pointno>. This 4D number will be used if the programm makes a
  94. confirmation report (Later more about reporting) and write it back to
  95. the netmail.
  96.  
  97. b. Areafixer.
  98. Enter the name of the areafixer. If you enter here for example Echofix your
  99. points and nodes must write there message to Echofix. The program regonize
  100. that this message is to connect or disconnect some areas. You can enter
  101. Areafix. A message must than be written to Areafix. Any other name will
  102. be skipped. 
  103.  
  104. c. Paswordfile.
  105. This is the filename of your paswordfile. (The format explained later)
  106. You can use the full pathname or only the filename. For example
  107. ECHOFIX.PRG is in C:\THE_BOX folder and your pasword file NODES.PAS is in 
  108. the C:\FIX folder, than you must enter C:\FIX\NODES.PAS
  109. If the pasword file is in the same directory and folder as ECHOFIX.PRG
  110. then you can enter NODES.PAS thus without path.
  111.  
  112. d. Controlfile.
  113. This is the filename of the controlfile. (The format explained later)
  114. Also you can use the full pathname or filename only. See Paswordfile
  115.  
  116. Click if you have entered all on SAVE. The installation program writes a
  117. file named ECHOFIX.CFG to disk. This file MUST be found in the same
  118. directory and folder as ECHOFIX.PRG. If you click on ABORT then the program
  119. quits whithout saving de configuration.
  120.  
  121. 4. How to call ECHOFIX.PRG
  122. --------------------------
  123.  
  124. This program can be called from desktop (not recommended) and from a 
  125. commandline interpeter. There are a few parameters you can give to the
  126. program.
  127.  
  128. a. -c If you using for example .<point> in your AREAS.BBS the program
  129. surch and write your points as .<point>. For example (In AREAS.BBS)
  130. <PATH> <AREA> <BOSNODE> .<point> .<point>
  131. The program looks into this line and surches for .<point> instead of
  132. a full nodenumber. Let's look again (Assuming your ID is 2:282.320.0)
  133.  
  134. C:\INMAIL\0001 MYAREA 2:282/301.0 .2 .3 .4
  135.  
  136. If point .3 wants to disconnect from area MYAREA the program founds his
  137. number in this line and disconnect him from this area. If you not using
  138. -c than the program don't find the .3 because now he is surching for
  139. 2:282/320.3 and he is not as that listed in the AREAS.BBS. That's the same
  140. if point .5 try's to connect to this area. If the -c option is not used
  141. then the program writes his full nodenumber even if he has already 
  142. connected to this area. Use -c always if you have the .<point> format in
  143. your AREAS.BBS. Other nodes wil not be cruched. If node 2:281/202 try's
  144. to connect to area, this line is as followed after the session 
  145. C:\INMAIL\0001 MYAREA 2:282/301 .2 .3 .4 2:281/202.0
  146. The -c option don't work if an other node write a message to your
  147. areafixer and writes his full nodenumber down.
  148.  
  149. b. -b
  150. This option tells the program to read the netmail backwards. I.e. the
  151. program begins to read at the last message. If your netmail counted 100
  152. messages the program start's at message 100 to 1. The newest messages will
  153. be first readed.
  154.  
  155. c. -m[#messages]
  156. -m tells the program to read to a max. of #messages. If you gives as 
  157. parameter -m20 the program reads the first 20 messages and stops. If you
  158. using -bm20 the program reads the last 20 messages. For example if your
  159. netmail counted 100 messages and you using -bm20 the program reads 
  160. messages 100 - 81 and than it stops. If there is less than 20 messages
  161. the program stops at the last message. There is no problem with that.
  162.  
  163. If you are using all parameters one '-' is enough. (-cbm10)
  164.  
  165. 5. When I start, what happens?
  166. ------------------------------
  167.  
  168. ECHOFIX reads first TB.CFG and surches for you netmailpath, nodenumber and
  169. you logfile. If one of this three not exist the program stops. Than it
  170. reads your netmail if there is any message for ECHOFIX. If there is a 
  171. message found it reads the AREAS.BBS, the paswordfile, controlfile and
  172. ECHOFIX.CFG. If any of the above programs doesn't exist the program stops.
  173. It also stops if there is no netmail. The message shall be readed.
  174. It try's to connect or disconnect the areas that's found in the message.
  175. The original message will be DELETED and RECEIVED. The confirmation report is 
  176. PRIVATE and KILLSENT.
  177.  
  178. 6. How must a point or node writes a message to ECHOFIX.
  179. --------------------------------------------------------
  180.  
  181. If there have a message editor like LED than start as followed.
  182. Enter a message to for example EchoFix (That the the name you have given
  183. in de EFIXINST.PRG in Areafixer). The topic must contain there pasword.
  184. If point 2:282/320.3 has as pasword ATARI the the name ATARI must be 
  185. entered in the subject line.
  186.  
  187. a. How to connect a area.
  188. If he wants to connect to area MYAREA he must type
  189. myarea OR
  190. +myarea
  191.  
  192. b. How to disconnect from a area
  193. If he wants to disconnect from area MYAREA
  194. -myarea
  195.  
  196. Example how to connect and disconnect areas at the same time.
  197. -myarea
  198. +otherarea
  199. -an_area
  200. +quickbbs.st
  201. +zmodem
  202.  
  203. If this is found in one message he wil be disconnect from areas
  204. myarea and an_area
  205.  
  206. and he will be connected to areas
  207. otherarea, quickbbs.st and zmodem
  208.  
  209. This line is wrong.
  210. -myarea +otherarea
  211.  
  212. All areas must be started at a new line. This forces the program to give
  213. 'Area myarea +otherarea doens't exist'
  214.  
  215.  
  216. 7. How to make a paswordfile
  217. ----------------------------
  218. That very simple. You need two thing's : Who's is polling me and what is
  219. his pasword. If you have node 2:282/320.0 and you have the following
  220. points and nodes :
  221. 2:282/320.2     ( point )
  222. 2:282/320.3     ( point )
  223. 2:282/320.4     ( point )
  224. 2:282/301.0     ( node  )
  225. 2:281/202.0     ( node  )
  226.  
  227. the structure of your paswordfile (plain ASCII) is
  228.  
  229. 2:282/320.2 <pasword>
  230. 2:282/320.3 <pasword>
  231. 2:282/320.4 <pasword>
  232. 2:282/301.0 <pasword>
  233. 2:281/202.0 <pasword>
  234.  
  235. The program reads the paswordfile and compares the topic to the pasword
  236. that's in the pasword file. If 2:282/320.3 write a message to ECHOFIX as
  237. followed
  238.  
  239. from : Rinaldo Visscher on 2:282/320.3
  240. to   : Echofix on 2:282/320.0
  241. topic: ATARI
  242.  
  243. than the pasword file is as followed for 2:282/320.3
  244.  
  245. 2:282/320.2 <pasword>
  246. 2:282/320.3 ATARI
  247. 2:282/320.4 <pasword>
  248. 2:282/301.0 <pasword>
  249. 2:281/202.0 <pasword>
  250.   
  251. The program found his nodenumber (2:282/320.3) in the paswordfile and
  252. compares his pasword. If this is correct the program continue.
  253. If the pasword is not correct the program write down a error message
  254. in the logfile (see later). Also if a node is NOT in your paswordfile
  255. than the program stops and write down an error message. (UNLISTED)
  256. The paswordfile is will not be readed into the memory.
  257.  
  258.  
  259. 8. What does the controlfile
  260. ----------------------------
  261. Simple, the program looks into the controlfile if a node or point may 
  262. connect to an area. There can be found if a node or point may have access
  263. to some areas. In that file is also the area description found.
  264.  
  265. 9. How do I make a controlfile
  266. ------------------------------
  267. The control file is a plain ASCII file. First it must contain the areas
  268. you have with the node and point number behind it.
  269. You can copy your AREAS.BBS to for example ECHOFIX.CTL (See installation)
  270. Remove all pathnames in this file and delete all node and point number.
  271. Than you have for example :
  272.  
  273. ASSEMBLER.028   
  274. ATARI.028
  275. BASIC.028
  276. STOCKS.028
  277. CQUESTIONS.028
  278.  
  279. These are all echomail areas.
  280.  
  281. You can type now the node and point numbers that have acces to the areas.
  282. For example : (assuming you have node 2:282/320.0)
  283.  
  284. ASSEMBLER.028 .2 .3 .4  
  285. ATARI.028     .2 .4
  286. BASIC.028     .3 .4 .5
  287. STOCKS.028    2:282/301 .2 .3 .5
  288. CQUESTION.028 2:281/202 .2
  289.  
  290. You see now that are point and nodenumbers after the echomailarea.
  291. What do it tells the program ?
  292. Simple, it tells him that points .2 .3 and .4 have access to ASSEMBLER.028
  293. but point .5 doen't have access to this area. Also in area ATARI.028
  294. only points .2 and .4 have access but points .3 and .5 don't have
  295. access to this area. In area STOCKS.028 node 2:282/301 have access and
  296. points .2, .3 and .5.
  297.  
  298. How to make a area discription ?
  299. Simple place a ';' after your point or node numbers. For example:
  300.  
  301. ASSEMBLER.028 .2 .3 .4           ; This is assembler echo  
  302. ATARI.028     .2 .4              ; Hai atari echo
  303. BASIC.028     .3 .4 .5           ; Basic
  304. STOCKS.028    2:282/301 .2 .3 .5 ; International stocks
  305. CQUESTION.028 2:281/202 .2       ; C questions
  306.  
  307. Why. ?
  308. After every session the program writes a confirmationreport. It written
  309. in the net mail. If  point or node that echofix have been used poll
  310. again he gets a report than as followed.
  311. (example point .3 See in example controlfile)
  312.  
  313. You are connected to BASIC.028
  314.  
  315.  ASSEMBLER.028   ; This is assembler echo  
  316. *BASIC.028       ; Basic 
  317.  STOCKS.028      ; International stocks
  318.  
  319. You are connected to 1 echomailarea.
  320. Total available 3 area(s)
  321.  
  322. You see that the ';' is used to look where the areadiscription is.
  323.  
  324. I have many points and nodes that's polling by me. How can I manage that?
  325. -------------------------------------------------------------------------
  326.  
  327. The control file have some keywords so that you don't have to write all
  328. node and point numbers after the area. The following keywords are 
  329. avaiable. (In order of priority)
  330.  
  331. 1 -> ALLNODES
  332. 2 -> OURPOINTS
  333. 3 -> OURNET
  334. 4 -> FOREIGNNET
  335. 5 -> ONLYNET
  336. 6 -> ONLYNODE
  337. 7 -> LOCAL
  338. 8 -> NOPOINT
  339.  
  340. ALLNODES
  341. --------
  342. This tell the program that all nodes and points have acces to this area.
  343. The nodes must be listed in the pasword file. Example
  344.  
  345. ASSEMBLER.028 ALLNODES           ; This is assembler echo  
  346. ATARI.028     .2 .4              ; Hai atari echo
  347. BASIC.028     .3 .4 .5           ; Basic
  348. STOCKS.028    2:282/301 .2 .3 .5 ; International stocks
  349. CQUESTION.028 2:281/202 .2       ; C questions
  350.  
  351. All points and nodes have access to ASSEMBLER.028
  352.  
  353. OURPOINTS
  354. ---------
  355. All your points have access to this area.
  356.  
  357. OURNET
  358. ------
  359. If you have for example node 2:282/320.0 your net number is 282. Nodes
  360. with the same netnumber have access to that area. Node 2:281/201.0 don't
  361. have access to this area. Thus only nodes (not points) whithin net 282
  362. can connect them to that area.
  363.  
  364. FOREIGNNET
  365. ----------
  366. This is the opposite of OURNET. If you are in net 282 than nodes within
  367. net 282 can't have that area. 2:281/202 can have acces to this area.
  368.  
  369. ONLYNET (<zone>:<net> <zone>:<net>)
  370. -----------------------------------
  371. You can tell here which direction an area can go. If you have for example
  372. nodes in net : 281, 282, 283, 284 and 285 
  373. than you can tell which nets have access to an area. Example :
  374. ONLYNET (2:281 2:282 2:285)
  375. Only nodes which are in net 2:281, 2:282 and 2:285 have access to that area.
  376. Nodes 2:283 and 2:284 don't have access to this area. 
  377.  
  378. ONLYNODE(<node> <node>)
  379. -----------------------
  380. Here you can tell wich nodes in the same netnumber have acces to the area.
  381. If you are in net 282 and other nodes for example 2:282/100 2:282/301 and
  382. 2:282/315 than you can tell that only 2:282/100 and 2:282/301 can have
  383. acces to this area. Example
  384. ONLYNODE(100 301)
  385. Tells echofix that only 282/301 and 282/100 have access. The nodes must be
  386. in the same net as you. 2:281/301 has NO access because he is in net 281.
  387.  
  388. LOCAL
  389. -----
  390. This area is local and can not be accessed by other nodes. Only points
  391. have acces to that area.
  392.  
  393. NOPOINTS
  394. --------
  395. Points don't have acces to this area. This can be used for private use.
  396. This is the opposite of ALLPOINTS.
  397.  
  398. Example of a control file 
  399. -------------------------
  400.  
  401. DBASE.028  ALLNODES     
  402. DELTA.028  ALLNODES     
  403. FORTH.028  ALLNODES     
  404. GFA_E      ONLYNET (2:282 2:283) .2 .4
  405. ATARI.GER  ONLYNODE (301 202) .3 .4 .5
  406. HAM-PA.028 OURNET OURPOINTS    . 
  407. MSDOS.028  FOREIGNNET ONLYNODE( 301 ) OURPOINTS
  408. FIDO_ST    ONLYNET (2:281) ONLYNODE( 202 ) NOPOINTS
  409. PASCAL.028 OURNET ONLYNET(2:281)     
  410. PENPAL     ALLNODES
  411. MYAREA     LOCAL NOPOINTS        
  412. POINTAREA  LOCAL ALLPOINTS
  413. SOMEPOINT  LOCAL .2 .3 .5
  414.  
  415. Everybody have access to DBASE.028.
  416. Only nets 282 and 283 and points .2 and .4 have acces to GFA_E
  417. To FIDO_ST has only node 2:282/301 access.
  418. MYAREA is for example for private use (BBS area only)
  419. POINTAREA is only for your points.
  420. SOMEPOINT is only for points 2,3 and 5
  421.  
  422. 'OURPOINTS NOPOINTS' in the same line has no effect. The first that will
  423. be readed is ALLPOINTS as you can see in the priority order.
  424. (OURPOINTS have a priority of 2 and NOPOINTS have a priority of 8)
  425.   
  426. All keywords must be in CAPITAL.
  427.  
  428. 10. Can I sent a message with the confirmation report.
  429. -----------------------------------------------------
  430. Yes, there are 2 possebilities. One GENERAL text and one PRIVATE text.
  431. How to make a GENERAL text ?
  432. First type at the first line of the pasword file 'generaltxt'
  433. In the same line you enter the name of the text file you want to attched to
  434. the report. For example :
  435.  
  436. generaltxt "c:\mail\mytext.txt"
  437. 2:282/320.2 <pasword>
  438. 2:282/320.3 <pasword>
  439. 2:282/320.4 <pasword>
  440. 2:282/301.0 <pasword>
  441. 2:281/202.0 <pasword>
  442.  
  443. The textfile 'c:\mail\mytext.txt' will be attached to every report. Thus
  444. every node and point get this file in his report.
  445.  
  446. There is a posebilitie to make a private text for every point or node.
  447. For example :
  448.  
  449. generaltxt "c:\mail\mytext.txt"
  450. 2:282/320.2 <pasword>
  451. 2:282/320.3 <pasword> nodetxt "c:\mail\private.txt"
  452. 2:282/320.4 <pasword>
  453. 2:282/301.0 <pasword>
  454. 2:281/202.0 <pasword>
  455.  
  456. All the nodes and points gets the file 'c:\mail\mytext.txt' and only
  457. 2:282/320.3 get the textfile 'c:\mail\private.txt' in his report, all
  458. other nodes don't see 'c:\mail\private.txt'.
  459. The text file must be normal ASCII.
  460.  
  461. 11. How can I see what is happend ?
  462. -----------------------------------
  463. ECHOFIX.PRG write a logfile. It's the in the same file where the_box 
  464. write's his log. ECHOFIX uses 'ECF' where the-box use 'BOX'. You
  465. can read which node of point has make use of ECHOFIX.PRG and which
  466. areas he has connected and disconnected. It don't look to the loglevel.
  467.  
  468. 12. Errorlevels
  469. ---------------
  470. ECHOFIX exits always with a errorlevel. Here are the errorlevels.
  471.  
  472. 0 = Perfect, everything is correct
  473. 1 = Can't find ECHOFIX.CFG
  474. 2 = There is no netmailpath in your TB.CFG
  475. 3 = Pasword error. Wrong pasword.
  476. 4 = Not listed in the pasword file
  477. 5 = Can't find logfile in TB.CFG
  478. 6 = Can't find your address in TB.CFG
  479. 8 = Out of memory.
  480. 10= Can't find TB.CFG
  481.  
  482. Errorlevels 1,2,3,4,5,7 and 8 can be found in the logfile if they occure.
  483.  
  484. DISCLAIMER
  485. ----------
  486. This program is tested over and over again under several conditions.
  487. If this program makes any mistakes I don't take responsebility for it. If
  488. you have any suggestions or comments to improve ECHOFIX.PRG write
  489. a netmail message to Rinaldo Visscher at 2:282/320.3 or to
  490. 2:282/320.0 
  491. Your AREAS.BBS may not have more than 250 lines and each line may not be
  492. greater than 32 Kbytes. Also your controlfile may not
  493. have more than 250 lines and each line is not greater than 32 Kb. This files
  494. will be readed into memory. A maximum of 250 lines in the message is allowed.
  495.  
  496. -----------------------------------------------------------------------------
  497.  
  498. If you like this program very much please send me a nice picture post card
  499. of the place were you live with your name and fido address to 
  500.  
  501. Rinaldo Visscher
  502. Banneplein 68
  503. 1034 DM Amsterdam
  504. The Netherlands
  505.  
  506. A lot of thanks to the persons who have tested it :
  507.  
  508. Johan Ansems Dutchman BBS Amsterdam 2:282/320
  509. Theo Runia Quickbbs Leeuwarden      2:282/301
  510. Joop Koopman Quickbbs Haarlem       2:281/202
  511.  
  512. ------------------------------------------------------------------------------
  513.  
  514. Changes made :
  515.  
  516. Version 1.1
  517.  
  518. Echofix keep reading until end of file is reached. The program don't stop
  519. if there is a message found and the confirmationreport is written.
  520.  
  521. Version 1.2
  522.  
  523. Read also -DAYS in areas.bbs
  524.  
  525.