home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / ENTERPRS / C128 / BBS / VTNT46-3.SFX / docs4-6.asc next >
Text File  |  1992-12-22  |  38KB  |  1,023 lines
  1.  
  2.  
  3. VORTEXNET v4.6 (c) 1991,92  by Stephen Kunc
  4. -------------------------------------------
  5.  
  6.  
  7.  
  8.  
  9. ::Note:: For registered owners of VortexNet 4.5, two update
  10. programs are contained on the VortexNet 4.6 disk that must be run
  11. when upgrading from 4.5 to 4.6 if a complete new SETUP is not
  12. desired. Otherwise, SETUP can be run, and all the files from 4.5
  13. except for DXX may be copied over. Also, on any upgrade from 4.5 to
  14. 4.6, a new 'Forced Questionnaire' should be immediately created
  15. with VortexNet 4.6 to keep with an updated file format.
  16.  
  17.  
  18. -------------
  19.  
  20.  
  21. The VortexNet BBS program requires a number of data files to be
  22. created before it can be run. The userlog and the nodelist (REL
  23. files), a binary saved data file, and a number of SEQuential files.
  24. The SETUP program provided on the disk must be used to create
  25. these. If the disk provided is not one that can be run from your
  26. default drive, copy SETUP <prg> and DXX <prg> onto your drive 8.
  27.  
  28. Type: run"setup"
  29.  
  30. The setup program creates the data disk and necessary files, you
  31. should only need to run it once. The program displays what its
  32. requirements are, in terms of blank disks and which drive numbers
  33. must be used. It's important to create VortexNet onto a blank disk,
  34. not onto the SETUP/DXX disk.
  35.  
  36. At the time of this documentation writing, the only hardware
  37. configuration that the VortexNet setup supports is two message
  38. drives (any combination of 1571 & 1581), and one other drive of any
  39. type. The two message drives must be device 9 and 10, and contain
  40. blank disks. The third drive must be the default drive 8, and a
  41. formatted disk must be ready for when the setup program requests
  42. it.
  43.  
  44. After the SETUP procedure is completed, the CONFIG program should
  45. be run, although it can be done later. To run CONFIG from basic
  46. before loading the BBS, type run"config". When prompted to "Load
  47. data?" answer "y" and at the "drive#" prompt, select the drive
  48. number of the disk which contains the recently setup program.
  49.  
  50.  
  51.  
  52. CONFIG -
  53.  
  54. The CONFIG program, used to modify the BBS, can be run from the
  55. BBS, or by typing run"config".
  56.  
  57.  
  58. PAGE 1
  59.  
  60.  
  61. 1: Zone Number
  62. 2: Net Number
  63. 3: Node Number
  64.  
  65. Options 1-3 are initially set to 0 by the setup program. They refer
  66. to a fidonet address. They should be changed after a fidonet node
  67. number is secured. What they must be set to in order to first
  68. obtain the node number varies from location to location. Find out
  69. from your local hub.
  70.  
  71.  
  72. 4: 1200 baud pause delay
  73. 5: 300 baud pause delay
  74.  
  75. Options 4-5 default to 19 and 71, respectively. They refer to the
  76. number of steps as a time delay, the BBS program performs between
  77. sending a character at that baud rate. There is no time delay for
  78. 2400 baud.
  79.  
  80.  
  81. 6: Quote chance 1 in...
  82.  
  83. The default is 6. It can be set to anything from 1 to 255. It
  84. refers to the chance, in that number, of a quote appearing at the
  85. main menu. If it is set to 1, a quote will appear each time a user
  86. returns to any main menu. If it is set to 100, there will be a 1%
  87. chance of a quote appearing.
  88.  
  89.  
  90. 7: The year
  91.  
  92. The last two digits of the current year. Current setup initializes
  93. to 91.
  94.  
  95.  
  96. 8: Zonemail hour effective
  97.  
  98. Set this to 1 if Zone Mail hour is being used. A 0 ignores Zone
  99. Mail hour and allows human callers to log on during the times set.
  100.  
  101.  
  102. 9: Show sysop in last ten callers
  103.  
  104. If this is set to no, user #1 won't ever appear on the recent
  105. callers list.
  106.  
  107.  
  108. A - B: Zonemail Start and End time
  109. These times define the start and end of Zone Mail hours. They must
  110. start and end on the hour, and cannot be on the half hour. The
  111. times set do not matter if Zonemail hour is disabled through option
  112. '8' above.
  113.  
  114.  
  115. C - D: Msg stacks
  116.  
  117. VortexNet 4.6 makes use of the message stacks unavailable in v4.5.
  118. Message stack C refers to drive 1 (device 9) and message stack D
  119. refers to drive 2 (device 10). The range is 0 to 699, and
  120. corresponds to how many messages should be stored on each drive.
  121. With an average echomail size volume, a 1581 can handle all 699
  122. messages, and a 1571 between 300 and 400. Depending on the average
  123. message size (which depends on which echomail areas you receive)
  124. these stacks may need to be adjusted. Running the RESET program
  125. will provide advice on message stack numbering.
  126.  
  127.  
  128. Message queue location: Shows the message number of the next
  129. message to be written.
  130.  
  131. Echomail scan location: Shows the location of the echomail scan.
  132.  
  133.  
  134. N)ext page: Moves to Page 2 of the CONFIG program.
  135.  
  136.  
  137. Q)uit without saving - Exits program. If CONFIG was run from the
  138. BBS, this returns to the BBS, otherwise exits.
  139.  
  140.  
  141. S)ave modifications - Updates the data file and then returns to
  142. either the BBS or exits the program. The BBS disk which contains
  143. the correct DXX file must be in drive 8 when this is used.
  144.  
  145.  
  146. PAGE 2 -
  147.  
  148.  
  149. A: Maximum number of messages/call at security level 4
  150.  
  151. Security level 4 is the minimum level required to enter public
  152. messages (excluding feedback). A maximum number of messages per
  153. call for a security level 4 user can be set. The initial setting is
  154. 0, which has to be changed if security level 4 users are allowed to
  155. enter messages. The range is 0 to 255. Setting the value to 255
  156. effectively makes a security level 4 user equivalent to any higher
  157. level in this area.
  158.  
  159.  
  160. B: Security level required to bypass last 10 callers
  161.  
  162. This option defines the security level needed to be able to log
  163. onto the BBS even if the user is one of the last 10 callers. If
  164. it's set to 5, then any security level 4 or below user will not be
  165. able to log on if she/he is on the last 10 callers list. A 0 nulls
  166. this option.
  167.  
  168.  
  169. C: New user questionnaire & feedback base
  170.  
  171. This sets the message base number that the new user questionnaire
  172. responses and feedback gets posted in. If it's set to 0 it will be
  173. sent private to user number 1. Any other number will post in that
  174. base. Caution must be taken not to set this to a base that doesn't
  175. exist, or the feedback/questionnaire will not get seen. Also, when
  176. deleting a message base that ranks chronologically between base
  177. number 1 and the feedback base, the number will have to be changed
  178. to reflect the deletion of a base, since the intended feedback base
  179. will move down one.
  180.  
  181.  
  182. D: Forced questionnaire base
  183.  
  184. This defines the message base number that forced questionnaire
  185. answers get posted in. The same cautions apply as to option 'C'
  186. above. If a 0 is put here, the message is private to user number 1.
  187.  
  188.  
  189. E: New user security level
  190.  
  191. This is the level of validation a new user calling the BBS
  192. automatically receives after completing the questionnaire. Setup
  193. default is level 1.
  194.  
  195.  
  196. F: Access level to Forward/Move messages
  197.  
  198. The access level required to F)orward or M)ove messages from public
  199. bases.
  200.  
  201.  
  202. G: Access level to kill messages
  203.  
  204. The access level required to Kill public messages.
  205.  
  206.  
  207. H: Access to build message base
  208.  
  209. The access level required for users to create message bases.
  210.  
  211.  
  212. I,J,K: Access to Transfer Drives
  213.  
  214. These define the access levels required to Catalog each of the
  215. three File Transfer drives.
  216.  
  217. M: Access required for Citadel
  218.  
  219. The access level required to play Citadel. 0 = Citadel is not
  220. active.
  221.  
  222.  
  223. O: Citadel optimizer execution
  224.  
  225. Sets the Citadel optimizer to either manual or automatic mode. In
  226. automatic mode, the optimizer runs every midnight, provided no user
  227. is online.
  228.  
  229.  
  230. R: Access required for outside module
  231.  
  232. The access level required to access the outside module (o).
  233.  
  234.  
  235.  
  236. PAGE 3 - Drive Definitions/Screen
  237.  
  238. All of these drives may be set to the same device (ie:8) if
  239. desired.
  240.  
  241.  
  242. 1: Main: Userlog/Nodelist/DXX/BDS/Outbound Mail drive
  243.  
  244. This drive device is the one designated as the "main" drive, it
  245. stores the LOG and NODES files (REL files), the BDS file (message
  246. base file), all the outbound mail, and the DXX file (the memory).
  247. This drive should be the most secure, that these files will not be
  248. lost under many circumstances.
  249.  
  250.  
  251. 2: Main: SEQ files/PR2-4
  252.  
  253. This drive stores all the SEQuential files (except BDS) used by
  254. VortexNet (ie:Voting and Trivia files) as well as the actual
  255. VortexNet program. (BBS, PR2, PR3, PR4).
  256.  
  257.  
  258. 3: Main: File Transfers
  259.  
  260. This is the drive assigned to File Transfers, and stores the drive
  261. catalogs (dir X).
  262.  
  263.  
  264. 4: Main: Inbound Mail
  265.  
  266. This is the drive assigned to receive all inbound net and echomail.
  267. All netmail and echomail is processed and saved on the message
  268. drives after receipt and if there were no errors, the mail bundle
  269. is deleted.
  270.  
  271. 5: Citadel drive
  272.  
  273. This is the drive assigned to the online game Citadel, and all
  274. Citadel related files.
  275.  
  276.  
  277. 6: Editors/Outside/Nodemod
  278.  
  279. This drive is assigned to all the editor programs (ie:CONFIG) if
  280. they are kept online, as well as any outside modules (VortexChess)
  281. and NODEMOD. Also, all "progX" files will be loaded from this
  282. drive.
  283.  
  284.  
  285. 7: This selects the background screen colour for VortexNet (1-16)
  286.  
  287. 8: This selects the character colour in VortexNet (1-16)
  288.  
  289.  
  290.  
  291. P)revious Page returns to PAGE 2 of CONFIG
  292.  
  293.  
  294.  
  295. Loading the BBS
  296. ---------------
  297.  
  298.  
  299. To run the BBS, reset the computer, ensuring that the modem is
  300. online. On an Aprotek C24, the ready and the 2400 baud lights
  301. should be on.
  302.  
  303. Make sure the message disks are in the correct drives (at the time
  304. of this writing: 9 and 10) and the data/program disk is in the main
  305. drive. Type : run"bbs" (with Unit extension if other than drive 8).
  306.  
  307.  
  308.  
  309. After loading, the program will prompt with the following:
  310.  
  311.  
  312. Load Data ?    device#?
  313. Time?
  314. Bulletin?
  315. Autosave?
  316. Month?
  317. Date?
  318. Fidonet?
  319.  
  320.  
  321. The data must be loaded (answer y) if the computer was rebooted, or
  322. another program was loaded before the BBS. The only events where
  323. the data would not be loaded (answer n) would be if the computer
  324. was warm reset, and then the data modified through memory editing,
  325. and then the program rerun. When the data is loaded, the program
  326. prompts for the drive device number on which the data is stored.
  327. This corresponds to the Main Drive number in CONFIG. Usually 8.
  328.  
  329. Enter the time without spaces or punctuation. 11:56 would be
  330. entered as 115600 for 11th hour, 56th minute, 00 seconds. It must
  331. always be 6 digits long. After entering the time the screen will
  332. clear and change to the preselected VortexNet colours.
  333.  
  334. The Bulletin prompt refers to whether or not the program will
  335. display the file "f.bu" upon log on by a user. The f.bu file would
  336. be displayed just before the main menu prompt, but only once per
  337. call. 0 sets it off, 1 sets it on.
  338.  
  339. The Autosave prompt tells the program if the data file should be
  340. saved after every logoff. If it is off, the data file never gets
  341. updated on the disk, so it must be saved manually with the BSAVE
  342. command specified later. If it is on, the BBS automatically updates
  343. the data file after every logoff, after every dial-out and after
  344. every receipt of netmail or echomail. 0 sets it off, 1 sets it on.
  345. Under normal circumstances and BBS operation, the Autosave option
  346. is always set to 1 (on).
  347.  
  348. The month and date prompts request the current numerical month and
  349. date. October 15th would be 10 for Month, 15 for Date.
  350.  
  351. The Fidonet prompt refers to whether or not the fidonet mailer and
  352. tosser are active. If a node number has not already been granted,
  353. it should be off. If for some reason the sending out of mail
  354. bundles and echo area scanning needs to be halted, turn this option
  355. off. It will not impede incoming mail packets, so in that respect,
  356. Fidonet is always on, but only prevents outgoing mail from being
  357. sent currently at that time. 0 turns it off, 1 turns it on.
  358.  
  359.  
  360.  
  361. The BBS
  362. -------
  363.  
  364. After the BBS has been loaded, the waiting for caller screen will
  365. appear. This consists of a status line at the top of the screen
  366. indicating the last caller, and their 'last words.' The time will
  367. be on the screen, as well as 2 columns of numbers, in 10 rows. The
  368. first time the BBS is loaded, these will all be set to 0. As well
  369. as a partial directory which includes the outbound net/echomail
  370. packets still not sent, the bundles received which were for some
  371. reason marked as bad and file-attaches received which were not
  372. recognized as echomail. There is also a one line menu reminding how
  373. to log on locally, access the CONFIG, EDITOR and NODEMOD programs.
  374.  
  375. The first column of numbers are the user numbers of the last 10
  376. callers, going from top to bottom, oldest to most recent. The
  377. number to the right of each user number corresponds to the number
  378. of messages that user entered during that call. In addition, a
  379. "<yell>" will appear to the right of the second column if that user
  380. yelled for the sysop while online.
  381.  
  382. There are 6 options that can be performed locally from the waiting
  383. for caller screen. <ENTER> logs on locally, and <P> can be used to
  384. force the BBS to perform a fidonet poll on another node. <1> runs
  385. the CONFIG program. <2> runs the EDITOR program. <3> runs the
  386. NODEMOD program. <0> forces the BBS to attempt to dial out all the
  387. nodes it has mail for (all the packets listed on the partial
  388. directory).
  389.  
  390. There is also another option which appears on that menu if the
  391. online game CITADEL is active. That option is <4> to run the
  392. Citadel Optimizer. Details further down.
  393.  
  394. Numbers 5 to 9 also respond from the waiting for caller screen.
  395. Pressing 5 will attempt to run"prog5" from the outside
  396. modules/editors drive. Likewise, pressing 9 will run"prog9". Sysops
  397. may use these to run VortexNet compatible software.
  398.  
  399. After setting up the BBS and running the program, the first thing
  400. the new sysop should do is log on locally as a new user. At the
  401. identity prompt, type in the name by which the sysop should be
  402. recognized by the BBS. A quick search will reveal that the userlog
  403. is empty, and the program will ask if the person is new there. Type
  404. 'y' and follow the prompts.
  405.  
  406. At the main menu, the new sysop will have to increase his/her
  407. access level. First: break into chat with yourself... (press the F7
  408. function key)
  409.  
  410. A small menu appears. Normally the sysop has to know what he/she is
  411. going to do after invoking the F7 menu, because the user online is
  412. suspended from doing anything. If nothing is desired, hit the F7
  413. key again.
  414.  
  415. The F3 key logs the user off, without updating the userlog. The F5
  416. key sends a message requesting a chat with the user after he/she is
  417. finished (this is done while the user is in the message areas).
  418. Although the sysop can swoop into chat with users while they're in
  419. the message areas, it is sometimes preferable to send them a
  420. message requesting a page when they're finished.
  421.  
  422. The F1 key swoops into chat with the user online. Use that option
  423. to chat with yourself and raise your access level.
  424.  
  425. Once in chat, the function keys have new meanings:
  426.  
  427. The ESC key ejects the user from chat. The F3 key allows the sysop
  428. to change the user name of the user online. The F1 key allows the
  429. sysop to change the access level of the user online.
  430.  
  431. If you are a new sysop, press the F1 key. It will ask for "Sec?".
  432. Enter "10" for the highest security level. Another prompt will
  433. appear, type "0". This is used to either increase (typing a
  434. positive number) or decrease (negative number) the amount of user
  435. credits the user online has. It is not (at the time of this
  436. writing) supported on the BBS, but the online game Citadel uses
  437. these credits, and outside modules can be written to make use of
  438. them. A new sysop, who has just increased his/her security level to
  439. 10, should then eject themselves from chat and log off, using the
  440. "g" option from the menu. This is to ensure that the changes to the
  441. account are saved immediately.
  442.  
  443. The sysop may then re-log on to verify that his/her user account
  444. has been updated and proceed.
  445.  
  446.  
  447.  
  448. The Main Menu  (using the default names)
  449. -------------
  450.  
  451. The main menu can be edited to look how the sysop desires by using
  452. the (2) EDITOR program.
  453.  
  454.  
  455. B)asement - switches modules... trivia, voting etc...
  456.  
  457. D)isplay Status - redisplays the log on information.
  458.  
  459. E)-mail - Private electronic mail.
  460.  
  461. F)eedback - Allows for message entry by unvalidated users. The
  462. feedback gets addressed and the subject written automatically
  463. according to what is in the data files (1 & 2). It gets posted in
  464. the message base specified by the SETUP program. A user who has a
  465. security level higher than 3 invariably gets his feedback messages
  466. sent private to the sysop. The SETUP feedback base is only used for
  467. unvalidated users.
  468.  
  469. G)oodbye - logs off
  470.  
  471. L)ook for mail - Reads private mail. If there is private mail
  472. waiting, the BBS will notify the user upon logon.
  473.  
  474. M)essage Bases - enters message area.
  475.  
  476. R)ecent callers - displays list of the last 10 callers.
  477.  
  478. T)oggle linefeeds - turns linefeeds on/off.
  479.  
  480. W)ake the sysop - yells for the sysop. (to answer a chat request
  481. press return while the BBS is yelling)
  482.  
  483.  
  484. Message Base Menu
  485. -----------------
  486.  
  487. A)gain - rescan's current message base for new messages and prompts
  488. with the read option
  489.  
  490. E)nter - enter message into current base
  491.  
  492. F)orward read - read messages in a forward direction from any point
  493.  
  494. J)ump - jump to another base
  495.  
  496. M)ain menu
  497.  
  498. T)itles - scan new messages by headers and query a read for each
  499.  
  500. N)next - move to next base
  501.  
  502. P)prev - move to previous base
  503.  
  504.  
  505. Note: The default at this prompt is to move to the next base.
  506.  
  507.  
  508.  
  509. The Basement Menu
  510. -----------------
  511.  
  512. B)uild a base -
  513.  
  514. This option allows for the creation of new message bases by users
  515. or by the sysop. Although message bases can be created by the sysop
  516. from the EDITOR program, this option (access needed specified in
  517. CONFIG) lets users with that access to create their own message
  518. bases.
  519.  
  520. C)atalog transfer drives - listing of files for download
  521. D)isplay status
  522. E)ditor Menu - go to BBS general editor menu
  523. F)ile transfer - uploading and downloading files
  524. G)oodbye
  525. K)ill your friends - gallows option
  526. L)ist ascii file - view a file on the download list on the screen
  527. P)assword change
  528. Q)uest for truth
  529. S)creen width change - toggle 40/80 columns
  530. T)rivia
  531. U)serlog
  532. V)oting
  533. W)ake the sysop
  534. X) cross back to main -- return to main module
  535. ?) displays menu
  536.  
  537.  
  538.  
  539. BBS Editor Menu
  540. ---------------
  541. F)orce Questionnaire - create new forced questionnaire
  542.  
  543. I)nitialize Gallows - select new user to be entered in gallows
  544.  
  545. L)ist Levels - displays list of titles, in order
  546.  
  547. M)ain menu - return to main basement menu
  548.  
  549. N)ew trivia - create new trivia questions
  550.  
  551. Q)uestmaker - create new quest for truth
  552.  
  553. R)esend InitS - Resends the defined modem initialization string.
  554. Should only be done locally.
  555.  
  556. S)ystem Stats - view system stats and system log
  557.  
  558. T)ime/Date - Change BBS time or date. Returns at prompts leave
  559. unchanged.
  560.  
  561. V)oting maker - create new online voting
  562.  
  563.  
  564.  
  565.  
  566. Editing Files
  567. -------------
  568.  
  569. All the data files as well as the download directories are edited
  570. with the EDITOR (accessed by typing either run"editor" from basic,
  571. or pressing <2> at the BBS waiting prompt). The files that are not
  572. listed on the EDITOR menu are edited directly online in the BBS
  573. Basement menu.
  574.  
  575.  
  576. FILE DESCRIPTIONS:
  577. ------------------
  578.  
  579. "LOG" & "NODES"
  580. ---------------
  581.  
  582. LOG and NODES are relative files. They can be edited with a sector
  583. editor if necessary, but it should never be needed. The LOG file is
  584. the userlog information, which can be modified from the BBS
  585. basement, and the NODES file is the nodelist, which can be changed
  586. through the nodelist editor program NODEMOD.
  587.  
  588.  
  589.  
  590. "BBS","PR2","PR3" & "PR4"
  591. -------------------------
  592.  
  593. All of these are program files. The PR* files are modules, and BBS
  594. is the executable.
  595.  
  596. "DXX","SETUP","RESET","NODEMOD","EDITOR" & "CONFIG"
  597. ---------------------------------------------------
  598.  
  599. DXX is the data file which stores message links and various other
  600. information (voting results, message pointers, etc). It is the data
  601. file which is modified with the CONFIG program.
  602.  
  603. The DXX file can be saved from immediate mode if necessary, with
  604. the following BASIC line:
  605.  
  606. bsave"dxx",u8,b1,p4000 to p16000
  607.  
  608.  
  609. The CONFIG program is accessed from basic by typing run"config" or
  610. directly from the BBS waiting screen by pressing <1>.
  611.  
  612. RESET is accessed by typing run"reset" from basic. It will load the
  613. most recent version of DXX. RESET optimizes the message disk if any
  614. messages have been memory deleted because of a problem on the disk.
  615. RESET will clear up sectors that have been marked as being used,
  616. when in reality they're not. It need never be used if you have not
  617. manually gone into memory and erased messages or there haven't been
  618. any message problems.
  619.  
  620. RESET should also be used if a disk error is encountered while
  621. reading a message. If for whatever reason a message gets saved
  622. improperly and reading it yields a file data error, running RESET
  623. on that drive will correct the problem.
  624.  
  625. NODEMOD is the nodelist modification program included with the BBS.
  626. It is accessed by typing run"nodemod" from basic, or by pressing
  627. <3> from the BBS waiting screen. At the present time, VortexNet
  628. does not process the IBM nodelist or nodediff and nodes must be
  629. changed manually with this program.
  630.  
  631. SETUP (run"setup" from basic) is the program which must be run
  632. initially to create the files needed by the BBS.
  633.  
  634.  
  635.  
  636. DATA1 & DATA2
  637. -------------
  638.  
  639. These are the data files containing BBS strings which are
  640. modifiable by the sysop. They are modified using the EDITOR program
  641. and the breakdown is as follows:
  642.  
  643.  
  644. Data File 1:
  645.  
  646. 1) message sent to user when sysop request a chat
  647. 2) opening line indicating to press ESCape to bypass mailer
  648. 3) string sent indicating that fidonet mailer was bypassed
  649. 4) First line of welcome line to BBS
  650. 5) Second line of welcome line to BBS
  651. 6) Message sent when user fails to get correct password after four
  652. attempts
  653. 7) Message sent when sysop kicks user off
  654. 8) line preceding prompt at main menu
  655. 9) -unused- must be present though
  656. 10) Message when W)ake is pressed more than once and sysop hasn't
  657. answered
  658. 11) First line of yell
  659. 12) Second line of yell
  660. 13) Message indicating yell wasn't answered
  661. 14) Message when sysop answers yell
  662. 15) Message when sysop breaks into chat while user not yelling
  663.  
  664.  
  665.  
  666. Data File 2:
  667.  
  668. 1) Message when sysop disengages from chat
  669. 2) String sent when user presses 'g' and then changes mind
  670. 3) Default last caller message when return is pressed at prompt
  671. 4) Automatic name F)eedback is addressed to
  672. 5) Automatic subject of F)eedback
  673. 6) Message when unvalidated user presses inaccessible option
  674. 7) String at beginning of ORIGIN line in echomail (usually the name
  675. of the BBS) - (caution must be taken not to make this string too
  676. long... see ECHOMAIL configuration section of this document)
  677. 8) Message sent to new user requesting F)eedback be left or
  678. deletion will occur on logoff (if new user access is 1)
  679. 9) 'Last Caller' name when BBS is rebooted
  680. 10) 'Last Caller' message when BBS is rebooted
  681. 11) Header before statistics are displayed
  682. 12) Name of first file directory
  683. 13) Name of second file directory
  684. 14) Name of third file directory
  685. 15) modem init string  (default: ath1v0e0m0s0=1)
  686.  
  687.  
  688.  
  689. "MU","F.MBME","F.BMU","QUOT","SEC","KEST"
  690. "F.OP","F.FI","F.BU"
  691. --------------------------------------------
  692.  
  693. All of these files are essentially data files used by the BBS. They
  694. are all modifiable through the EDITOR program.
  695.  
  696.  
  697.  
  698. "DIR 1","DIR 2" & "DIR 3"
  699. -------------------------
  700.  
  701. These are the 3 file directories. They are stored as sequential
  702. files, at the time of this writing. There are four pieces of
  703. information for each 'program' listed in the directory: The name,
  704. The Uploader, a number, and a file description. The number, which
  705. is the only piece of data that should not be preceded by a
  706. quotation mark, corresponds to the number of xmodem blocks the file
  707. length is. If the number is 4, then the display will read that the
  708. file is 512 bytes long. To figure out what number to put there on
  709. a program that isn't uploaded (when a program is uploaded, then
  710. this is all done by the BBS), multiply the number of disk blocks
  711. that the program uses by 2.
  712.  
  713. There is also a 'junk character' at the beginning of each DIR file.
  714. It should be left alone, and has to be there if the directory is
  715. empty.
  716.  
  717. These download directories are all modifiable through the EDITOR
  718. program.
  719.  
  720.  
  721.  
  722. "BDS","QUE","TRUTH","VOT","GAL" & "TRI"
  723. ---------------------------------------
  724.  
  725. The above, except for BDS, are files used by the BBS relevant to
  726. the various options available from the basement menu (voting,
  727. trivia etc...) They need not be edited by any means other than from
  728. the BBS editor menu, found off the basement menu.
  729.  
  730. QUE is the current set of questions for the forced questionnaire.
  731. TRUTH is the quest for truth questions and options. VOT is the
  732. voting questions. GAL is the saved user comments relevant to the
  733. gallows. TRI is the trivia questions and answers. BDS is the file
  734. used to store message base name/level and code information, and is
  735. modifiable through the EDITOR by selecting the MESSAGE BASE EDITOR
  736. option.
  737.  
  738. All of the above files and options with the exception of QUE also
  739. employ some part of memory (ultimately stored in DXX) for results.
  740. They are all self-supporting and need only be modified directly
  741. online or in the EDITOR.
  742.  
  743. -----
  744.  
  745.  
  746. The use of CONFIG, EDITOR, NODEMOD, SETUP and RESET are all
  747. hopefully self-explanatory and menu driven.
  748.  
  749.  
  750. Short-notes which may cause potential problems:
  751.  
  752.  
  753. CONFIG: described in detail above
  754.  
  755.  
  756. EDITOR: scroll highlight bar down to file desired to be edited.
  757. Highlight "- Exit Editor -" to finish. If you used run"editor" to
  758. access this program, you will be returned to basic. If you ran it
  759. from the BBS, the BBS will automatically be reloaded skipping over
  760. the prompts.
  761.  
  762. This program also includes the MESSAGE BASE EDITOR, USERLOG EDITOR
  763. and the method for editing the download directories. Care must be
  764. taken to update the DXX file when message bases are modified,
  765. especially if the editor is not being run directly from the BBS but
  766. in immediate mode instead.
  767.  
  768. Editing files: F1 - aborts file edit F3 - saves edited file F5 -
  769. insert blank line on cursor F7 - delete line on cursor
  770.  
  771. Editing download directories:
  772.  
  773. Selecting any of the d/dirX files to edit displays a list of the
  774. files in that download directory. Highlight an entry to edit. As
  775. above, F1 aborts this modification, F3 saves the update. F5 in this
  776. instance allows you to add a file to the download directory, and
  777. queries with prompts. F7 allows you to delete a file from the
  778. directory. (note F7 doesn't delete the file from the disk, just
  779. removes the entry from the download directory)
  780.  
  781. Hint: Take a note of how each file is set up initially, in case a
  782. mistake is made. In particular, note the format of the main menu
  783. file, the first line of which is a prompt, the second is the header
  784. and the following lines are the menu. The other menu files are not
  785. set up this way.
  786.  
  787. In the MESSAGE BASE EDITOR option 3 allows for the customizing of
  788. some message base attributes which may be confusing, all other
  789. options should be self-explanatory. Use option 3 to specify the
  790. type of the message base (ie: echomail, local, netmail). It also
  791. allows for the turning on of anonymous mode, which means for that
  792. message base, users entering or replying to messages are permitted
  793. to enter an optional other name. Also, reply can be disabled for
  794. individual message bases. The option to keep the SEEN-BY lines
  795. applies to echomail bases. Normally, SEEN-BY lines would not be
  796. wanted, but they can be set to be kept for testing purposes. Also,
  797. there is the option to turn on the QuoteRemover program, which
  798. applies to incoming echomail only. The QuoteRemover recognizes some
  799. forms of other BBS quoting, and removes those lines from incoming
  800. echomail and reports back how many lines of quotes were removed, if
  801. any. The QuoteRemover can be turned on for echomail conferences
  802. where people use excessive message quoting which may use up a lot
  803. of VortexNet disk space.
  804.  
  805. As well, option 3 is used to turn on the ability for users to quote
  806. messages in that base, and also to turn on the option to keep
  807. Kludge Lines (preceeded by a control A) on incoming echomail.
  808. Normally, Kludge lines would not be wanted (as SEEN-BY lines) but
  809. they are sometimes useful for testing purposes. They should be
  810. turned off since they use up disk space unnecessarily.
  811. Note: Kludge lines may be sent from the BBS by preceeding the test
  812. on that line by the string "^a:". The mail tosser recognizes this
  813. as the command to turn that line into a Kludge line. A lower case
  814. a denotes a Kludge line entered locally from the BBS, an upper case
  815. A denotes a Kludge line which was received. Kludge lines are mailer
  816. and tosser commands, and unless the sysop knows what he/she is
  817. doing with them they should be avoided. In a number of areas,
  818. inserting unnecessary Kludge lines may be considered "excessively
  819. annoying".
  820.  
  821. Note: Caution must be taken in echomail message bases to ensure
  822. that the origin line of an echo, plus the name entry (Default:
  823. VortexNet) from the DATA FILE 2, plus the string " * Origin: ",
  824. plus the "(Z:###/###)" does not exceed 69 characters. Since the "
  825. * Origin " and node address are constant lengths, the shorter the
  826. name in the data file, the longer the origin line can be for an
  827. echo, so long as the total number of characters that appear on that
  828. line does not equal 70 or greater.
  829.  
  830. The USERLOG editor allows for the individual editing of each user's
  831. account. There are two "Extra fields" at the bottom of the user
  832. record, these correspond to the first 22 characters (or less) of
  833. the strings entered in the first two questions of the new user
  834. application. For this reason, there should always be at least 2
  835. new-user questions on the application. If question number one, for
  836. example, is: "What is your real name?" whatever the user answers to
  837. that question will be stored in Extra Field 1, and likewise,
  838. question 2 for Extra Field 2. These fields are only for records and
  839. are not used by VortexNet, although their contents appear on the
  840. status line.
  841.  
  842.  
  843.  
  844. NODEMOD:
  845.  
  846. As the editor and config programs, when NODEMOD is exited, it
  847. either returns to the BBS or to basic, depending from where it was
  848. run. Quit exits without updating the DXX file, but individual node
  849. entries made during the session are saved. Quit shouldn't be used
  850. unless no changes were made at all.
  851.  
  852. Save & Exit updates the DXX file and then quits.
  853.  
  854. Initially, NODEMOD is empty of node entries. A list is displayed on
  855. screen with numbers 1 to 96 listed, initially followed by 0's. 1 to
  856. 96 corresponds to the record entry # for that node. To edit entry
  857. #1, type 1 and hit return. There can be (in this present version of
  858. VortexNet) a maximum of 96 nodes in the nodelist.
  859.  
  860. After entering a number, the record is displayed. The record number
  861. should not be confused with the node number for that node.
  862.  
  863. The options to Abort the edit, Delete the entry, or Edit the entry
  864. are displayed.
  865. Abort returns the entry to its original status. Delete resets it to
  866. an empty entry. Edit prompts with all the information for that
  867. node. Hitting return will leave the data for that field unchanged,
  868. unless the record was previously empty.
  869.  
  870. VortexNet supports netmail message routing, which is accomplished
  871. through NODEMOD by entering the phone number of the system that
  872. should be routed through in the phone number field. The format for
  873. phone numbers for LOCAL nodes is "-AAAXXXXXXX". The "-" must be the
  874. first character of the string or VortexNet will attempt to dial
  875. long distance. The format for the phone number for direct dialing
  876. of a long distance node is "1AAAXXXXXXX". In both cases, AAA is the
  877. area code, and XXXXXXX is the phone number. If the first character
  878. is "-", VortexNet will only dial the last 7 digits.
  879.  
  880. The rules within individual nets should be checked before any
  881. routed mail is sent.
  882.  
  883.  
  884. SETUP: mentioned above, is the program (run"setup") which creates
  885. all the necessary data files. It contains its own instructions.
  886.  
  887.  
  888. RESET: use run"reset", it loads the DXX file and then questions the
  889. sysop for some cursory information. It then scans either of two
  890. message drives for file data errors and mis-allocated blocks.
  891. Information and general statistics of each message processed are
  892. displayed on the screen. More information on RESET is detailed
  893. above.
  894.  
  895. When RESET is finished it allows for aborting, or updating the DXX
  896. file & exiting, or to run it again on the other message drive.
  897.  
  898. --------------
  899.  
  900.  
  901.  
  902. *** Any questions may be directed to Stephen Kunc at Fidonet
  903. address (1:163/227).
  904.  
  905. VortexNet and its affiliated programs are all copyright (c) 1991,92
  906. by Stephen Kunc. They are considered ShareWare and unregistered
  907. versions may be distributed provided no fee is charged.
  908.  
  909. VortexNet may be evaluated for a trial basis, but the obtaining of
  910. a Fidonet or other national network node number with the software
  911. requires that the $25 registration fee be mailed and a registered
  912. version of the software be obtained. Netmail 1:163/227 for
  913. information on obtaining a registered copy of VortexNet.
  914.  
  915.  
  916.  
  917. General Information on obtaining a node number:
  918. -----------------------------------------------
  919. To receive a node number, obtain a copy of your local nodelist from
  920. a networking BBS and transcribe the entries into the NODEMOD
  921. database. Find out which local node must receive node applications.
  922.  
  923. VortexNet is CRASHMAILable, both for regular mail and file-
  924. attaches. However, it requires that ALL netmail and echomail must
  925. be sent UNCOMPRESSED. This is indicated in the nodelist by having
  926. the MN flag marked for your node, which must be specified to
  927. whoever receives node applications in your net.
  928.  
  929. VortexNet is FTS-0001 compatible (minimum requirements according to
  930. Policy4) and is uses Lotek Xmodem transfers. It has been
  931. successfully tested with high volumes of echomail with the Binkley
  932. mailer (any version) and also with the Opus built-in mailer as a
  933. relay. It has been successfully tested with FrontDoor (any version)
  934. for low echomail volumes (under 60k per transfer), which are sent
  935. as file-attaches. Because of FTS-0001 incompatibilities on the part
  936. of FrontDoor, some batch file programming is required by the
  937. FrontDoor relay to make FrontDoor send echomail uncompressed. It is
  938. suggested that VortexNet nodes attempt to acquire either Binkley or
  939. Opus relays.
  940.  
  941. Some IBM tosser programs do not accommodate non-compressed sending
  942. properly. VortexNet has achieved the best success with QMail,
  943. SquishMail or the built-in Opus tosser.
  944.  
  945. VortexNet has been tested successfully for sending and receiving
  946. capability with Frontdoor 1.99c to 2.02, Binkley 2.0 to 2.5 and
  947. Opus, as well as a number of other less used mailer programs. It
  948. will work with any truly FTS-0001 compliant mailer.
  949.  
  950. ** Any problems with relaying to a VortexNet node, questions about
  951. required IBM program set-ups and configs can be netmailed to
  952. Stephen Kunc at 1:163/227.
  953.  
  954.  
  955.  
  956.  
  957.  
  958. CITADEL
  959. -------
  960.  
  961. Citadel is accessed from the main menu of the BBS by pressing 'C'.
  962. It is turned online from the CONFIG program, where a security level 
  963. must be set which allows for its access, or 0 for not online. Note:
  964. If you are running Citadel, don't forget to add the option listing
  965. to the main menu so that users will know it's there. Citadel
  966. instructions are found online in the game.
  967.  
  968. To set-up Citadel, copy the program MSEQ from the citadel disk onto
  969. the BBS main disk. Run the INSTALL program included on the Citadel
  970. disk, and then insert the BBS disk at the prompt. More instructions
  971. follow on screen during the install process. After Citadel is
  972. installed and the rest of the files from the Citadel disk copied to
  973. the BBS disk, it's advisable to run the optimizer program. This is
  974. done by first activating Citadel from the CONFIG and then pressing
  975. '4' from the Waiting For Caller screen of the BBS. After the
  976. optimizer program is run for the first time, anyone may start
  977. playing.
  978.  
  979. Note: With infrequent and few players, it's probably best to run
  980. the optimizer manually by pressing '4' whenever a sufficient amount
  981. of time has passed. With a number of regular players, the optimizer
  982. can be set to run automatically at midnight each day. This option
  983. is set in the CONFIG program. Note though: there is a small bug, if
  984. someone is online at midnight, the optimizer will neglect to run
  985. itself after they log off.  
  986.  
  987. Any suggestions as to Citadel game improvement or other feedback
  988. are welcome.
  989.  
  990.  
  991. Note: Citadel v3.2 or higher must be used with VortexNet v4.6. Do 
  992.       not attempt to use Citadel v3.1 or lower with VortexNet 4.6.
  993.       Use Citadel v3.0 with VortexNet v4.4 or lower.
  994.  
  995.  
  996.  
  997.  
  998. OUTSIDE MODULES
  999. ---------------
  1000.  
  1001. The outside module is accessed by pressing 'O' from the main menu.
  1002. At the time of this writing, only one outside module is allowed
  1003. connected at a time. The access level required is set in the CONFIG
  1004. program (0 for none active).
  1005.  
  1006. VortexChess is an example of an outside module, but sysops can
  1007. write their own for use on their BBS or distribution.
  1008.  
  1009. The requirements for a home-written program for VortexNet are few,
  1010. but important. The program must be called OUT on the main BBS disk,
  1011. and the  memory from 4000 dec. to 16000 dec. in Bank 1 must be
  1012. protected. To re-run VortexNet from an outside module, put a value
  1013. 250 into memory location 4008 of bank 1 and then RUN"BBS". (ie:
  1014. bank1: poke4008,250: run"bbs")
  1015.  
  1016. There's more information available which could be useful for anyone
  1017. writing an additional module, such as parameters that can be passed
  1018. from the BBS, but this documentation isn't the place for it. Please
  1019. netmail 1:163/227 for additional information. I would be interested
  1020. to hear about anyone's efforts to write or adapt existing outside
  1021. programs to work with VortexNet.
  1022.  
  1023.