home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SBBS1B00.ZIP / DOCS.EXE / DOCS / CONFIG.DOC < prev    next >
Text File  |  1992-09-25  |  69KB  |  1,613 lines
  1.  
  2.                    Synchronet Configuration Documentation
  3.                    ======================================
  4.  
  5. Contents
  6. ~~~~~~~~
  7. 1.0 SCFG
  8. 2.0 Nodes
  9.     2.1 Toggle Options
  10.     2.2 Advanced Options
  11.     2.3 Modem Configuration
  12.         2.3.1 Result Codes
  13.         2.3.2 Auto-Configuration
  14.     2.4 Wait for Call Number Keys
  15.     2.5 Wait for Call Function Keys
  16. 3.0 System
  17.     3.1 Toggle Options
  18.     3.2 New User Values
  19.     3.3 Advanced Options
  20.     3.4 Security Level Values
  21.     3.5 Alternate Command Sets
  22.     3.6 Quick-Validation Values
  23. 4.0 Message Base
  24.     4.1 Message Groups
  25.         4.1.1 Message Sub-boards
  26.             4.1.1.1 Toggle Options
  27.             4.1.1.2 Network Options
  28. 5.0 File Transfers
  29.     5.1 File Libraries
  30.         5.1.1 File Directories
  31.             5.1.1.1 Toggle Options
  32.     5.2 Viewable Files
  33.     5.3 Testable Files
  34.     5.4 Extractable Files
  35.     5.5 Tranfer Protocols
  36.     5.6 Alternate File Paths
  37. 6.0 External Programs
  38.     6.1 Events
  39.     6.2 Editors
  40.     6.3 Online Programs
  41.         6.3.1 Online External Program Configuration Examples
  42. 7.0 Text File Sections
  43. 8.0 Networks
  44.     8.1 QWK Packet Networks
  45.         8.1.1 Network Hubs
  46.             8.1.1.1 Networked Sub-boards
  47.     8.2 FidoNet EchoMail and NetMail
  48.  
  49.  
  50.  
  51. 1.0 SCFG
  52. ~~~~~~~~
  53. SCFG is the Synchronet Configuration Utility that can be executed from the
  54. "Waiting for call" screen by hitting 'C' or from DOS by typing SCFG from any
  55. node directory. SCFG is a separate executable program and must load the
  56. configuration information into memory upon initialization. Once SCFG has
  57. initialized, you will see a main menu titled "Configure". To manipulate the
  58. lightbar, use the up and down arrow keys or type a letter or number in the
  59. option you wish to highlight. To highlight the first option of the menu, hit
  60. HOME. To highlight the last option of the menu, hit END. You'll notice that if
  61. you hit up arrow when the lightbar is at the first option of the menu, the last
  62. option will become highlighted. This wrap effect also occurs when hitting the
  63. down arrow when the lightbar is at the last option of the menu. To select the
  64. current highlighted option, hit ENTER. To exit SCFG, hit ESC.
  65.  
  66.  
  67. 2.0 Nodes
  68. ~~~~~~~~~
  69. You can configure any node from within SCFG regardless of what computer
  70. (or virtual computer) you're using. To configure a node, select "Nodes" from
  71. the SCFG "Configure" menu. You will then see a list of all the nodes installed
  72. on your system. You will also see the bottom line of the screen now has two
  73. additional key commands added, INS and DEL. INS and DEL are used to add and
  74. delete nodes from the system. If you select one of the nodes listed, you will
  75. receive another menu titled "Node x Configuration" which contains general
  76. configuration information for this node and paths to more advanced
  77. configuration menus. We will now discuss the options of this menu.
  78.  
  79. Name:
  80.         This is the name of the node. This parameter is not used for anything
  81.         but documentary purposes in the BBS.
  82.  
  83. Phone Number:
  84.         This is the phone number of this node in the format AAA-EEE-NNNN.
  85.  
  86. Logon Prompt:
  87.         This is what will be displayed to callers after the Synchronet version
  88.         and registration number, but before the NN: prompt.
  89.  
  90. Minimum Connect Rate:
  91.         This is the minimum modem connection rate that will be allowed. Callers
  92.         can still connect and attempt to logon, but without the 'M' exemption,
  93.         they will be told what minimum connect rate is and disconnected.
  94.  
  95. Minimum User Age:
  96.         This is the minimum age of new users that will be allowed.
  97.  
  98. Maximum User Age:
  99.         This is the maximum age of new users that will be allowed.
  100.  
  101. Minimum Main Level:
  102.         This is the minimum main level that a user needs to be able to logon
  103.         to this node.
  104.  
  105. Allowed (Required) Main Flags:
  106.         This is a list of Main Flags (MF) that a user must have to be able
  107.         to logon to this node. He can either be required to have any one of
  108.     the flags (Allowed) or have to have all of the flags (Required).'
  109.  
  110. Local Text Editor:
  111.         This is the command line to use when editing text files or messages
  112.         locally. This command line is not used when posting or sending e-mail
  113.         unless the above option is set to 'Yes'. If this option is not
  114.         specified, the default editor for the current user will be used. An
  115.         example (using Qedit as the editor) would be:
  116.         q %f
  117.  
  118.         Assuming Q.EXE is in the DOS search path. If it isn't, you can specify
  119.         the location of the program. Example:
  120.         c:\qedit\q %f
  121.  
  122.         The %f parameter will expand to the path and filename of the file to
  123.         edit.
  124.  
  125. Text Viewer:
  126.         This is the command line to use to view text files locally. Currently,
  127.         this command line is only used to view the system log files. You should
  128.         use a program that allows the text scrolling up and down as well as
  129.         string searches. A popular program for this use is Buerg's LIST.
  130.         If you are running multiple nodes and the program you wish to use
  131.         leaves the file open while viewing, you should use a batch file that
  132.         actual copies the file to view and then views the copy.
  133.         Example (if program name is LIST):
  134.         LISTIT.BAT:
  135.         @echo off
  136.         copy %1 list.tmp
  137.         list list.tmp
  138.         del list.tmp
  139.  
  140.         An example for this field (using the LISTIT batch file) would be:
  141.         %!listit %f
  142.  
  143.         The %! parameter specifies that the batch file is located in the
  144.         EXEC directory. If is not located there, you can remove the %! so that
  145.         the DOS search path will be searched for the batch file or specify
  146.         its location.
  147.  
  148.         The %f parameter will expand to the path and filename of the file to
  149.         view.
  150.  
  151.  
  152. 2.1 Toggle Options
  153. ~~~~~~~~~~~~~~~~~~
  154. Alarm When Answering:
  155.         If you would like have the BBS sound an alarm when answering the phone,
  156.         set this option to Yes.
  157.  
  158. Status Screen While WFC:
  159.     This node will display a screen with system usage statistics and the
  160.     current status of all active nodes.
  161.  
  162. Use Editor for Messages:
  163.     If this option is set to 'Yes' and you have specified a Local Text
  164.     Editor (next option), when logged on locally this editor will be used
  165.     for the creation of all messages.
  166.  
  167.  
  168. 2.2 Advanced Options
  169. ~~~~~~~~~~~~~~~~~~~~
  170. Validation User:
  171.         This is the number of the user to whom validation feedback is sent.
  172.     This value will usually be set to 1 (the sysop). If this value is set
  173.     to 0, then new users will not be required to enter validation feedback.
  174.  
  175. Screen Length:
  176.     This is the length of the system screen or video window. This should
  177.     be set to "Auto-Detect" always, unless you have a specific reason
  178.     to force Synchronet to think the screen length is a certain value.
  179.  
  180. Cost Per Call:
  181.         This option should only be set to something nonzero for a billing
  182.         node. A billing node is a node attached to special phone line that will
  183.         automatically charge the caller a predetermined amount (usually area
  184.         code 900 or prefix 976 numbers). Set this value to the amount that the
  185.         caller will be billed after the initial 30 seconds. The user doesn't
  186.         actually access the BBS through this phone number as 900/976 services
  187.         charge the sysop by the minute an unrealistic amount. The user just
  188.         enters his or her name/alias and password and their account is credited
  189.         with the amount of credits per dollar specified in the System options
  190.         multiplied by this field (Cost per call) and the user is hung-up on.
  191.         The user then calls the normal BBS nodes and has instant access to
  192.         their purchased credits.
  193.  
  194. Daily Event:
  195.         This is the command line to execute when the first caller after
  196.         midnight logs off. If the program is located in the EXEC directory,
  197.         this command line should start with the %! specifier.
  198.  
  199. Merge Duplicate Text:
  200.         If this field is set to Yes, duplicate text strings found in TEXT.DAT
  201.         will use the same memory for storage. This can save memory, the amount
  202.         of which depends on how many duplicate strings are in TEXT.DAT, but
  203.         the reading of the TEXT.DAT upon SBBS initialization is slower due to
  204.         the string comparing.
  205.  
  206. Control Directory:
  207.         This is the path to the control directory where all the shared
  208.         configuration (.CFG) files for SBBS are stored. TEXT.DAT (the editable
  209.         ASCII file that contains almost all of the color and text that SBBS
  210.     displays) and a few miscellaneous binary data files are also stored
  211.     in this directory. All nodes of the system must have the same control
  212.     directory and this directory should not be located on a RAM disk.
  213.  
  214. Text Directory:
  215.         This is the path to the text directory. This is where all menus,
  216.         macros, SIF files, QWK files, system information, and other text
  217.         files are stored. All data beneath this directory branch is READ ONLY
  218.         as far as Synchronet is concerned, so changing this directory to a RAM
  219.         drive would enhance performance and wouldn't risk data loss. If you do
  220.         change this path, be sure to copy all the files and subdirectories of
  221.         the original text directory there. If you do change this path to a RAM
  222.         drive, you will need automate the copying of all of the files and
  223.         subdirectories there upon system startup (possibly AUTOEXEC.BAT) with a
  224.         sequence of commands like this:
  225.         md r:\text
  226.         xcopy c:\sbbs\text\*.* r:\text /S
  227.  
  228.  
  229. Temporary Directory:
  230.         This is the path to the directory that this node will use for
  231.         temporary file storage. This directory must point to somewhere unique
  232.         and nonvolatile. All the files in this directory are deleted upon
  233.         execution of the BBS, so do not store any files you want to keep in
  234.         this directory. Each node must have its own temp directory. For
  235.         increased performance on batch uploads, it is best if this directory
  236.         is on the same disk drive as the majority of your file transfer
  237.         directories.
  238.  
  239.  
  240. 2.3 Modem Configuration
  241. ~~~~~~~~~~~~~~~~~~~~~~~
  242. If you are not positive about the correct settings of any of the values on this
  243. menu (other than COM Port), select Auto-Configuration and select your modem
  244. type or a compatible modem.
  245.  
  246. COM Port:
  247.         This is the communications port that your modem is attached to. If you
  248.         are not using a modem, set this value to 0. If for some reason, you
  249.         do not specify the UART IRQ and I/O address, this number must be
  250.         relative to the BIOS data area (i.e. COM Port 1 refers to the first
  251.         COM Port found during your computers Power On Self Test). Normally,
  252.         when you select the COM Port, you should answer Yes to set the UART
  253.         IRQ and I/O address values to their defaults.
  254.  
  255. UART IRQ Line:
  256.         If you are not sure what IRQ line your modem's UART is using, select
  257.         the default for the COM Port number.
  258.  
  259. UART I/O Address:
  260.         If you are not sure what I/O address your modem's UART is using, select
  261.         the default for the COM Port number.
  262.  
  263. UART (DTE) Rate:
  264.         This is the data transfer rate between your computer and your modem.
  265.         If you're using a non-data-compressing, non-high-speed modem, this
  266.         should be set to your modem's highest DCE rate (i.e. 2400bps modem,
  267.         should use a 2400bps DTE rate). If you have a data-compressing or
  268.         high-speed modem, this value should be set to the highest DTE rate your
  269.         modem supports.
  270.  
  271. Hardware Flow Control:
  272.         If your modem supports CTS/RTS hardware flow control (usually
  273.         data-compressing or high-speed modems), set this option to Yes.
  274.  
  275. Initialization String:
  276.         This is the basic modem initialization command for SBBS. This option
  277.         should not be modified unless your unhappy with any of the settings
  278.         and are familiar enough with the Hayes AT command set to know the
  279.         consequences of the commands. As with all the modem command commands,
  280.     a tilde ('~') will produce a 500 millisecond pause.
  281.  
  282. Special Init String:
  283.         This is where additional initialization commands are placed for
  284.     specific modem types - usually error-correcting, data-compressing, or
  285.     high-speed modems.
  286.  
  287. Terminal Init String:
  288.         This is the initialization command given to the modem when Terminal
  289.         Mode is entered from the SBBS wait for call screen.
  290.  
  291. Dial String:
  292.         Not Yet Implemented.
  293.  
  294. Off Hook String:
  295.         This is the command sent to the modem when the phone is to be taken
  296.         off-hook (made busy).
  297.  
  298. Answer String:
  299.         This is the command sent to the modem when SBBS detects a ring.
  300.  
  301. Reinitialization Timer:
  302.     This field is used to automatically reinitialize the modem periodically
  303.     to make sure it is functioning correctly. If you find that your modem
  304.     works most of the time, but occasionaly will not answer or functions
  305.     incorrectly in other ways, you may wish to use this feature and set
  306.     it to a relatively low number (5 minutes or so). Setting this value
  307.     to 0 disables the periodic modem reinitialization function.
  308.  
  309.  
  310. 2.3.1 Result Codes
  311. ~~~~~~~~~~~~~~~~~~
  312. This is a list of the numeric result codes (connection codes) supported by
  313. your modem. For each result code, the numeric code, the DCE (connect) rate,
  314. estimated file transfer CPS, and an 8 character description are stored. Hit INS
  315. to add a result code above the highlighted one, or DEL to delete the
  316. highlighted result code. You can have up to 500 result codes per node. If you
  317. are not sure what the estimated transfer CPS is for a particular result code,
  318. just divide the DCE rate by 10 and use that number (i.e. DCE rate of 9600bps
  319. may have a rough estimate of 960cps through-put on file transfers).
  320.  
  321.  
  322. 2.3.2 Auto-Configuration
  323. ~~~~~~~~~~~~~~~~~~~~~~~~
  324. Using this option you can let SCFG automatically set the values of the Modem
  325. Configuration menu (except COM Port, UART IRQ, and UART I/O Address) by
  326. selecting your modem from the available choices. If your modem is a 2400bps
  327. Hayes compatible, select Hayes SmartModem 2400. If you have a high-speed
  328. (9600bps or faster) modem and it is not in the auto-configuration list, select
  329. Generic 9600 or Generic 14400 and then add any high-speed result codes that are
  330. listed in your modem's manual, but not already in the result code list.
  331. See 2.31 Result Codes for more information on adding result codes.
  332.  
  333.  
  334. 2.4 Wait for Call Number Keys
  335. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  336. This option lets you configure what command line will be executed for each
  337. number key (0-9) while waiting for call. These commands will generally be
  338. simple things that don't require much memory, such as listing the ERROR.LOG,
  339. listing the GURU.LOG, editing a file, or any other simple functions. For large
  340. program functions, see 2.5 Wait for Call Function Keys below.
  341.  
  342.  
  343. 2.5 Wait for Call Function Keys
  344. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  345. This option lets you configure what command line will be executed for each
  346. function key (F1-F12) while waiting for call. These commands can execute just
  347. about any program because Synchronet will shrink to 16k before executing it.
  348. Popular uses for these shrinking commands would be running a terminal program
  349. or other large applications.
  350.  
  351.  
  352. 3.0 System
  353. ~~~~~~~~~~
  354. BBS Name:
  355.         This is the name of the BBS.
  356.  
  357. Location:
  358.         This is the city, state and/or other pertinent location information.
  359.  
  360. Operator:
  361.         This is the name of the system operator. Doesn't have to be the same
  362.         as user #1.
  363.  
  364. The Guru:
  365.         This is the name of the system's guru.
  366.  
  367. Password:
  368.         This is the super-secret system password that only sysops should know.
  369.  
  370. Allow Aliases:
  371.         If you wish the users of the BBS to be allowed to use aliases publicly,
  372.         set this option to Yes.
  373.  
  374. Users Can Change Password:
  375.         If you want enhanced system security, it is suggested that you force
  376.         users to keep the original randomly generated password they were
  377.         assigned by setting this option to No. If you do allow users to change
  378.         their passwords, you can make them change their password periodically
  379.         with this selection.
  380.  
  381. Days to Preserve Deleted Users:
  382.     If a user is deleted, his slot will be preserved for this many days
  383.     since his last logon date. Preserved slots will not be written over
  384.     by new users.
  385.  
  386. Maximum Days of Inactivity:
  387.     If you wish that users that haven't logged on in a certain number of
  388.     days be automatically deleted, set this value to the maximum number
  389.     of days a user can be inactive before he is deleted. Users can be
  390.     exempted from the automatic deletion with the 'P' exemption. Setting
  391.     this value to 0 disables this feature (Unlimited inactivity).
  392.  
  393. New User Password:
  394.         If this field has a value, new users will have to enter this password
  395.         correctly before being able apply for access.
  396.  
  397.  
  398. 3.1 Toggle Options
  399. ~~~~~~~~~~~~~~~~~~
  400. Beep Locally:
  401.         If you wish to disable all bells locally, set this option to No.
  402.  
  403. Include Sysop in Statistics:
  404.         It is suggested that you set this option to No, so that the sysop's
  405.         activity on the BBS is not included in the usage statistics.
  406.  
  407. Closed to New Users:
  408.         If you wish to disallow access to any new users, set this option to
  409.         Yes.
  410.  
  411. Allow Anonymous E-mail:
  412.     You can disallow anonymous e-mail on your system by setting this option
  413.     to No. If this option is set to Yes, only users with the anonymous
  414.     exemption would be able to send anonymous e-mail.
  415.  
  416. Use Location In User Lists:
  417.     If you wish the location (City, State) of the user to be displayed
  418.     in user listings instead of the user note, set this option to Yes.
  419.     Setting this option to No will display the user's note (sysop created)
  420.     if one has been created.
  421.  
  422. Ask New Users for Address:
  423.     If you want new users to be prompted to enter their address and
  424.     zip/postal code, set this option to Yes.
  425.  
  426. Multi-Choice Computer Question:
  427.     If you want to use the multiple choice computer type questionaire
  428.     (COMPUTER.SIF) for the new users to specifiy their computer type, set
  429.     this option to Yes. Setting this option to No, will allow the user to
  430.     enter a free-form description of their computer of up to 40 characters.
  431.  
  432.  
  433. 3.2 New User Values
  434. ~~~~~~~~~~~~~~~~~~~
  435. This option allows you to modifiy the security values assigned to a new user
  436. after he completes his validation feedback. You can also set the number of
  437. credits and minutes new users start off with. If you have configured alternate
  438. command sets or external editors, you may select one of these as the default
  439. for new users. See USEREDIT.DOC for more information.
  440.  
  441.  
  442. 3.3 Advanced Options
  443. ~~~~~~~~~~~~~~~~~~~~
  444. BBS ID for QWK Packets:
  445.         This is the BBS ID used for QWK packets for offline message readers.
  446.  
  447. New User Magic Word:
  448.         If this field has a value, it is assumed the sysop would have put
  449.         some reference to this "magic word" in NEWUSER.MSG and the user
  450.         will be prompted for this after he enters his own assigned password.
  451.         If he doesn't enter it correctly, it is assumed he didn't read the
  452.         text displayed to him and he is disconnected.
  453.  
  454. Data Directory:
  455.         This is the path to the directory where all the data files for SBBS
  456.         are stored. This value should not be changed unless necessary.
  457.  
  458. Index Directory:
  459.         This is the path to the directory where all the index files for SBBS
  460.         are stored. This value should not be changed unless necessary.
  461.  
  462. Executables Directory:
  463.         This is the path to the directory where all the executable files for
  464.         SBBS are store. This value should not be changed unless necessary.
  465.  
  466. Pause During Logon:
  467.         If the LOGON.ANS or ANSWER.ANS files have animated ANSI sequences
  468.         in them, you will want to set this option to No. If you have important
  469.         information in either of these files that you do not want to scroll
  470.         off the user's screen regardless of whether the user has pause enabled
  471.         or not, set this option to Yes. If you don't care one way or the other,
  472.         set this option to User Default. The suggested setting is Yes.
  473.  
  474. Input SIF Questionnaire:
  475.         This is the name of a SIF file that resides the text directory that
  476.         all users will be prompted to answer upon logging on the first time.
  477.         See SIF.DOC for more information.
  478.  
  479. Output SIF Questionnaire:
  480.         This is the name of the SIF file that is used by the sysop to view
  481.         the users' answers to the input SIF questionnaire. If this value is
  482.         left blank, the input SIF questionnaire is used. This output SIF
  483.         questionable should be identical to the input SIF with the exception
  484.         of the text content. See SIF.DOC for more information.
  485.  
  486. Credits Per Dollar:
  487.         This is the monetary value of a credit (How many credits per dollar).
  488.         This value should be a power of 2 (1, 2, 4, 8, 16, 32, 64, 128, etc.)
  489.         since credits are usually converted by 100 kilobyte (102400) blocks.
  490.         To make a dollar worth two megabytes of credits, set this value to
  491.         2,097,152 (a megabyte is 1024*1024 or 1048576).
  492.  
  493. Minutes Per 100k Credits:
  494.         This is the value of a minute of time online. Credits can be converted
  495.         to minutes by the user with the &C command from the main menu. Credits
  496.         are only converted in 100k (102400) blocks. This field is the number
  497.         of minutes to give the user in exchange for the 100k credit block.
  498.  
  499. Maximum Number of Minutes:
  500.     This value is the maximum total number of minutes a user can have. If
  501.     the user has this number of minutes or more, he will not be allowed
  502.     to convert credits into minutes. A sysop can add minutes to a user's
  503.     account regardless of this maximum. If this value is set to 0, the
  504.     user will have no limit on the total number of minutes he can have.
  505.  
  506. Message 'To' Field:
  507.     This is the format of the 'To' field displayed at the top of messages
  508.     (posts and e-mail). It can include Ctrl-A codes for color changes.
  509.  
  510. Message 'Title' Field:
  511.     This is the format of the 'Title' line in messages.
  512.  
  513. Message 'From' Field:
  514.     This is the format of the 'From' line in messages.
  515.  
  516. Message 'Date' Field:
  517.     This is the format of the 'Date' line in messages.
  518.  
  519.  
  520. 3.4 Security Values
  521. ~~~~~~~~~~~~~~~~~~~
  522. This is where you define the values of the Main Security Levels (MLs) (0-99).
  523. The parameters are: time per day, time per call, calls per day, and lines per
  524. message. These limits are assigned to all users by ML.
  525.  
  526.  
  527. 3.5 Alternate Command Sets
  528. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  529. This option allows the sysop to add or modify alternate command sets. Alternate
  530. command sets are replacement key commands for the Synchronet command set. The
  531. sections of the BBS with configurable commands are the main, transfer, message
  532. reading, and mail reading menus. For each command set, the sysop can change
  533. each command key into another (unique) command that may be more familar to
  534. some users. Each alternate command set has separate menus for the above
  535. mentioned sections. These menus are stored in a sub-directory off of TEXT\MENU.
  536. The name of this sub-directory is configured separately for each command set.
  537. The sysop must create this sub-directory and the menus within. See CUSTOM.DOC
  538. for more information on the creation/modification of menus and the filename and
  539. extension formats.
  540.  
  541.  
  542. 3.6 Quick Validation Values
  543. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  544. This is where you define the values of the quick-validation sets (0-9). These
  545. are used to quickly set a user's ML, TL, MF, TF, Restrictions and Exemptions.
  546. A user can be quick-validated by hitting Alt-(0-9) while the user is online,
  547. or with the 'V' command from User Edit.
  548.  
  549.  
  550. 4.0 Message Base
  551. ~~~~~~~~~~~~~~~~
  552. This selection allows you to configure message groups and sub-boards. After
  553. selecting "Message Base" from the "Configure Menu", you will see a menu titled
  554. "Message Groups" and the options will be the currently configured message
  555. groups.
  556.  
  557.  
  558. 4.1 Message Groups
  559. ~~~~~~~~~~~~~~~~~~
  560. This menu is typical of the variable length option menus in SCFG. Press INS
  561. to delete a message group or DEL to delete a message group and all of its
  562. sub-boards. If the number of groups exceeds the displayable area of the
  563. screen, an arrow will appear at the bottom left of the menu specifying that
  564. the menu can be scrolled down to access more options. If the menu is scrolled
  565. down and is not currently at the last option, an arrow is displayed in the
  566. upper left of the option area of the menu specifying that the menu can be
  567. scrolled up to access more options. Pressing INS allows inserts will add
  568. a message group above the currently selected one. If you wish to add a message
  569. group to the end of the list, go to the blank option at the bottom of the menu
  570. before pressing INS. You can have up to 10,000 message groups. To edit the
  571. values associated with a message group, select the group by pressing ENTER when
  572. it is highlighted. Another menu will appear with the following options:
  573.  
  574. Long Name:
  575.         This is a description of the message group which is displayed when
  576.         a user of the system uses the '/*' command from the main menu.
  577.  
  578. Short Name:
  579.         This is a description of the message group which is used for main menu
  580.         and sub-board scanning prompts.
  581.  
  582. Minimum Age:
  583.         This is the minimum age of a user that is allowed to access this group.
  584.  
  585. Minimum Main Level:
  586.         This is the minimum ML of a user that is allowed to access this group.
  587.  
  588. Allowed (Required) Main Flags:
  589.         This is the set of main flags that are necessary for the user to access
  590.         this group. You can optionally set the requirement to be any one of the
  591.         flags in this value (Allowed), or all of the flags in this value
  592.         (Required).
  593.  
  594.  
  595. 4.1.1 Message Sub-boards
  596. ~~~~~~~~~~~~~~~~~~~~~~~~
  597. The list of sub-boards menu is very similar to the message groups menu. The
  598. use of the INS and DEL keys remains consistent and to select a sub-board, you
  599. use the enter key. Only the sub-boards that belong to the current selected
  600. message group are displayed. You can have up to 20,000 total sub-boards. The
  601. following options are available after selecting a sub-board to view or edit.
  602.  
  603. Long Name:
  604.         This is a description of the sub-board which is displayed when a user
  605.         hits '*' at the main menu.
  606.  
  607. Short Name:
  608.         This is a description of the sub-board which is used for the main menu
  609.         and sub-boards scanning prompts.
  610.  
  611. QWK Name:
  612.         This is the name of the sub-board used for QWK packets. This name
  613.         is limited to only 10 characters.
  614.  
  615. Minimum Age:
  616.         This is the minimum age of a user that will be allowed access to the
  617.         sub-board.
  618.  
  619. Minimum Level to Read:
  620.         This is the minimum main level (ML) required for read access to the
  621.         sub-board.
  622.  
  623. Minimum Level to Post:
  624.         This is the minimum ML required for posting access on the sub-board.
  625.         Setting this value lower than the read access will have no effect.
  626.  
  627. Allowed (Required) Flags to Read:
  628.         This is the set of main flags that are necessary for the user to have
  629.         read access to this sub-board. You can optionally set the requirement
  630.         to be any one of the flags in this value (Allowed), or all of the flags
  631.         in this value (Required).
  632.  
  633. Allowed (Required) Flags to Post:
  634.         This is the set of main flags that are necessary for the user to be
  635.         able to post on this sub-board. You can optionally set the requirement
  636.         to be any one of the flags in this value (Allowed), or all of the flags
  637.         in this value (Required).
  638.  
  639. Internal Code:
  640.         This is an internal code for SBBS to distinguish this sub-board from
  641.         the others on the system. This must be a unique name of up to 8 valid
  642.         DOS filename characters.
  643.  
  644. Maximum Number of Messages:
  645.         This is the maximum number of messages that will be allowed on the
  646.         sub-board. Once the maximum number of messages is reached, a new post
  647.         on the sub-board will purge (or roll-off) the first post on the sub
  648.         so that the total number of posts never exceeds the maximum. Posts can
  649.         be flagged non-purgable by the sysop. If all the posts on a sub-board
  650.         are non-purgable and the maximum number of posts is reached, no one
  651.         will be allowed to post new messages on that sub-board.
  652.  
  653.  
  654. 4.1.1.1 Toggle Options
  655. ~~~~~~~~~~~~~~~~~~~~~~
  656. Allow Private Posts:
  657.     If you want to allow users to post private messages to another user
  658.     on the sub-board, set this option to Yes. Since Synchronet has an
  659.     internal e-mail system, this option is usually only set to Yes on
  660.     networked sub-boards that allow private posts. You can also force
  661.     private posts on this sub-board by setting this option to Only.
  662.  
  663. Allow Anonymous Posts:
  664.     If you want to allow users that have the 'A' exemption to be able to
  665.     post anonymously on this sub-board, set this option to Yes. You may
  666.     also force anonymous posts by any one (with or without the 'A'
  667.     exemption) by setting this option to Only.
  668.  
  669. Post Using Real Names:
  670.     If you wish posts on this sub-board to be posted using the real name
  671.     of a user instead of his/her alias, set this option to Yes. Many
  672.     networks require BBSs that allow aliases to force real names on
  673.     networked sub-boards.
  674.  
  675. Users Can Delete Posts:
  676.     You may allow users to delete their posted messages by setting this
  677.     value to Yes. You may allows users to delete their messages only if
  678.     it is the last message on the sub-board by setting this value to
  679.     Last.
  680.  
  681. Forced New Scan:
  682.     If this option is set to Yes, the sub-board will not be skipped in
  683.     new message scans even if the user has configured his or her new scan
  684.     to not contain this sub-board.
  685.  
  686. Public 'To' User:
  687.     If you wish all posts to be prompted for a 'To' user, set this option
  688.     to Yes. Many networks do not allow private messages on networked
  689.     sub-boards, so the only way to send a message 'To' someone is to send
  690.     it publicy with a 'To' field. Normally, 'To' users are only prompted
  691.     for on private posts.
  692.  
  693.  
  694. 4.1.1.2 Network Options
  695. ~~~~~~~~~~~~~~~~~~~~~~~
  696. Append Tag/Origin Line:
  697.     If you want a tagline (QWK network) or origin line (FidoNet) to be
  698.     appended to messages sent out on the network from this sub-board,
  699.     set this option to Yes.
  700.  
  701. QWK Networked:
  702.     Setting this option to Yes will limit posted message titles to the
  703.     QWK packet limitation of 25 characters.
  704.  
  705. QWK Tagline:
  706.     This is an optional tagline that will be used for this sub-board. If
  707.     this field is blank, the default tagline will be used. If "Append
  708.     Tag/Origin Line" is set to No, then no tagline will be used.
  709.  
  710. FidoNet EchoMail:
  711.     If this sub-board is networked via FidoNet, set this option to yes.
  712.  
  713. FidoNet Address:
  714.     This is the FidoNet address used for this sub-board.
  715.  
  716. EchoMail Origin Line:
  717.     This is an optional origin line that will be used for this sub-board.
  718.     Do not include the FidoNet address in this line. Synchronet
  719.     automatically as the " * Origin: " and "(Zone:Net/Node.Point)".
  720.     If this field is blank, the default origin line will be used. If
  721.     "Append Tag/Origin Line" is set to No, then no origin line will be
  722.     used.
  723.  
  724. EchoMail Directory:
  725.     This is the storage directory where FidoNet style (FTS-0001 stored
  726.     message format) messages are imported from and exported to for this
  727.     sub-board. If this option is blank, then the EchoMail base directory
  728.     is used with the internal code of this sub-board as the sub-directory
  729.     where the FidoNet messages are stored.
  730.  
  731.  
  732. 5.0 File Transfers
  733. ~~~~~~~~~~~~~~~~~~
  734. This section allows you to configure various options that relate to the file
  735. transfer section of Synchronet.
  736.  
  737. Min Bytes Free Disk Space:
  738.         This is the minimum about of disk space (in kilobytes) that is
  739.         necessary for a user to be allowed an upload.
  740.  
  741. Max Files in Batch UL Queue:
  742.         This is the maximum number of files that can be stored in the batch
  743.     upload queue. The definite maximum is 500 files.
  744.  
  745. Max Files in Batch DL Queue:
  746.         This is the maximum number of files that can be stored in the batch
  747.     download queue. The definite maximum is 500 files.
  748.  
  749. Max Users in User Transfers:
  750.         This is the maximum number of destination users in user to user
  751.     transfers. The definite maximum is 500 users.
  752.  
  753. Credit Value in Bytes:
  754.         This is the value of one credit in bytes. It is suggested that this
  755.         value be set to 1, so that every credit is worth one byte.
  756.  
  757. Percentage of Credits for Upload:
  758.         This is the percentage of the credit value of a file that is given to
  759.         the uploader of a file upon a successful upload. The suggested value
  760.         is 100 percent.
  761.  
  762. Percentage of Credits for Download:
  763.         This is the percentage of the credit value of a file that is given to
  764.         the uploader of a file upon a successful download of the file by
  765.         another user. The suggested value is 90 percent.
  766.  
  767. Leech Protocol Detection Percentage:
  768.     This value is the sensitivity of the leech protocol detection feature
  769.     of Synchronet. If the transfer is apparently unsuccessful, but the
  770.     transfer time was at least this percentage of the estimated transfer
  771.     time (based on the estimated CPS of the connection result code), then
  772.     a leech protocol error is issued and the user's leech download counter
  773.     is incremented. Setting this value to 0 disables leech protocol
  774.     detection.
  775.  
  776. Extension for Temp Files:
  777.         This is the file extension that will be used in the creation of
  778.         temporary download files. The suggested extension is ZIP.
  779.  
  780. Command to Create Temp Files:
  781.         This is the command line used to create a temporary archive in the
  782.         temp directory. The program that this line executes should match the
  783.         extension for temp files (see above). The suggested command line is:
  784.         %!pkzip %f %s
  785.     Remember, PKZIP must be in your EXEC directory for the above command
  786.     line to work. The '%!' specificier is an abreviation for your EXEC
  787.     directory. Either remove the '%!' from the command line (assuming
  788.     PKZIP is in your DOS search path), or more preferably, specify the
  789.     exact location of PKZIP. Example: C:\BIN\PKZIP %f %s
  790.  
  791.  
  792. 5.1 File Libraries
  793. ~~~~~~~~~~~~~~~~~~
  794. This selection produces a list of file transfer libraries. You can add and
  795. delete libraries in the same fashion as message groups. If you select a
  796. file library, you can view or edit its values and all the file directories
  797. that belong to it. The options for each transfer library are as follows:
  798.  
  799. Long Name:
  800.         This is a description of the library and is displayed when the user
  801.         uses the '/*' command from the transfer menu.
  802.  
  803. Short Name:
  804.         This is a description of the library and is displayed at the transfer
  805.         prompt.
  806.  
  807. Minimum Age:
  808.         This is the minimum age of users that are allowed access to the
  809.         library.
  810.  
  811. Minimum Transfer Level:
  812.         This is the minimum transfer level (TL) that a user can have to access
  813.         the library.
  814.  
  815. Allowed (Required) Transfer Flags:
  816.         This is the set of transfer flags (TF) that are necessary for the user
  817.         to have read access to this sub-board. You can optionally set the
  818.         requirement to be any one of the flags in this value (Allowed), or all
  819.         of the flags in this value (Required).
  820.  
  821.  
  822. 5.1.1 File Directories
  823. ~~~~~~~~~~~~~~~~~~~~~~
  824. This selection produces a list of directories that belong to the current
  825. library. The available options for each directory are as follows:
  826.  
  827. Long Name:
  828.     This is a description of the file directory that is displayed when
  829.         the user uses the '*' command from the transfer section.
  830.  
  831. Short Name:
  832.     This is a description of the file directory that is displayed at
  833.         the transfer section prompt. Some short names have a predetermined
  834.         meaning:
  835.  
  836.         Temp:
  837.                 This short name is reserved and cannot be used.
  838.  
  839.         Offline:
  840.                 This short name specifies that this directory is to hold
  841.                 offline files for the selected library and is treated a bit
  842.                 differently than other directories. It will not be included
  843.                 in new-scans and will be the default location of files that
  844.                 are removed or moved. A directory with this short name should
  845.                 have the upload level set to 90 and the access level and flags
  846.                 set the same as the library. There can only be one directory
  847.                 per library with this short name.
  848.  
  849.         Sysop:
  850.                 This short name specifies that this directory will be the
  851.                 destination for files uploaded by users with the 'Z' command
  852.                 from the transfer section. There should only be one directory
  853.                 with this short name and it should belong to the most
  854.                 accessible library. A directory with this short name should
  855.                 have the access level set to 90 and the upload level and flags
  856.                 set the same as the library.
  857.  
  858.         User:
  859.                 This short name specifies that this directory will be the
  860.                 storage point for user to user transfers. There should only be
  861.                 one directory with this short name and it should belong to the
  862.                 most accessible library. Users can upload a file to another
  863.                 user or group of users with the '/U' transfer section command.
  864.                 Users download files sent to them with the '/D' transfer
  865.                 section command. A directory with this short name should have
  866.                 the access level set to 90 and the upload level and flags
  867.                 set the same as the library or at whatever level the sysop
  868.                 wishes to allows users to use the user to user transfer
  869.                 facilities.
  870.  
  871. Minimum Age:
  872.         This the minimum required user age to access this directory.
  873.  
  874. Minimum Level to Access:
  875.         This is the minimum required transfer level (TL) for users to access
  876.         this directory. Directories with a short name of Sysop or User should
  877.         have this value set to 90 so that only sysops can list the contents
  878.         of the directory.
  879.  
  880. Minimum Level to Upload:
  881.         This is the minimum required transfer level (TL) for users to upload
  882.         to this directory. Directories with a short name of Offline should
  883.         have this value set to 90 so that only sysop can upload files to this
  884.         directory.
  885.  
  886. Allowed (Required) Flags to Access:
  887.         This is a list of transfer flags (TF) that are required for a user
  888.         to have access to this directory. The number of flags required can be
  889.         set to One (Allowed) or All (Required).
  890.  
  891. Allowed (Required) Flags to Upload:
  892.         This is a list of transfer flags (TF) that are required for a user
  893.         to have access to this directory. The number of flags required can be
  894.         set to One (Allowed) or All (Required).
  895.  
  896. Internal Code:
  897.         This is an internal code for SBBS to distinguish this directory from
  898.         the others on the system. This must be a unique name of up to 8 valid
  899.         DOS filename characters. The code TEMP is reserved and cannot be used.
  900.  
  901. Extensions Allowed:
  902.         This is a list of file extensions (separated by commas) that are
  903.         allowed to be uploaded to this directory.
  904.  
  905. Default Extension:
  906.         This is the default extension used when a user views or extracts
  907.         files without specifying the extension.
  908.  
  909. Sort Value and Direction:
  910.         Directories can be sorted either by filename or upload date in an
  911.         ascending or descending order. This option selects the value to sort
  912.         on and in which direction.
  913.  
  914. Transfer File Path:
  915.         This is the actual path for the storage of the files that belong to
  916.         this directory. If no path is specified, the directory DATA\DIRS\CODE,
  917.         where CODE is the internal code for this directory, will be used to
  918.         store the files.
  919.  
  920. Maximum Number of Files:
  921.         This is the maximum number of files that will be allowed in this
  922.         directory.
  923.  
  924.  
  925. 5.1.1.1 Toggle Options
  926. ~~~~~~~~~~~~~~~~~~~~~~
  927. Check for File Existence:
  928.         If this option is set to 'Yes', when files are listed in the transfer
  929.         section, each file is checked to see if it actually exists in the
  930.         DOS directory. If the file doesn't exist, the credit value is displayed
  931.         in high intensity blinking and is followed by a minus symbol. Setting
  932.         this option to 'No' speeds up the file listings, but files not actually
  933.         on disk will appear just as the others. Directories with a short name
  934.         of Offline should have this value set to 'No' as they should solely
  935.         contain files that aren't actually in the DOS directory. Directories
  936.         that are stored on CD-ROM or other slow random access device should
  937.         have this option set to 'No'.
  938.  
  939. Copy to Temp Directory:
  940.         If this option is set to 'Yes', files will be copied from the normal
  941.         storage directory into the temp directory and downloaded from there.
  942.         This option is helpful in reducing the overhead associated with
  943.         multiple simultaneous user access to a slow storage device such as
  944.         CD-ROM.
  945.  
  946. Force Content Ratings:
  947.         If this option is set to 'Yes', when a user uploads a file he is
  948.         prompted to rate the content of the file he is uploaded with a rating
  949.         of G, R, or X, and the file description will begin with the rating
  950.         letter contained in brackets.
  951.  
  952. Multiple File Numberings:
  953.         If this option is set to 'Yes', when a user uploads a file he is
  954.         asked if the file he is uploading is part of a set of files. If the
  955.         user answers 'Yes', he is then prompted for the total number of files,
  956.         the number of the file he is uploading, and the file description will
  957.         end with the numbering in the format "[n/t]", where n is the file
  958.         number and t is the total number of files.
  959.  
  960. Extended Descriptions:
  961.         If this option is set to 'Yes', users will be prompted if they wish
  962.         to create an extended description for the file upon uploading. An
  963.         extended description is a message, much like e-mail or a post, that is
  964.         attached to the file and displayed when the extended file information
  965.         is displayed. If an extended description has been created for a file,
  966.         a plus sign will appear after the filename in the file listings.
  967.  
  968. Free Downloads:
  969.         If you want all files downloaded from this directory to be free for
  970.         the downloader (not cost any credits regardless of the credit value),
  971.         set this option to Yes.
  972.  
  973. Credit Uploads:
  974.         If you want users who upload files to this directory to get credit
  975.         for their upload based on the "Percentage of Credits for Upload", set
  976.         this value to Yes.
  977.  
  978. Credit Downloads:
  979.         If you want users who upload files to this directory to get credit
  980.         for subsequent downloads of the file based on the "Percentage of
  981.         Credits for Download", set this value to Yes.
  982.  
  983. Anonymous Uploads:
  984.         If you want users with the 'A' exemption to be able to upload file
  985.         anonymously to this directory, set this option to Yes. If you want all
  986.         uploads to this directory to be automatically forced anonymous, set
  987.         this option to Only.
  988.  
  989.  
  990.  
  991.  
  992. 5.2 Viewable Files
  993. ~~~~~~~~~~~~~~~~~~
  994. This is a list of file types that have content information that can be viewed
  995. through the execution of an external program. Here are a couple of command line
  996. examples for a few file types.
  997.  
  998. ZIP  %!pkunzip -v %s
  999. ARJ  %!arj l %s
  1000. GIF  %!gifdir %s
  1001. TXT  type %s
  1002.  
  1003. 5.3 Testable Files
  1004. ~~~~~~~~~~~~~~~~~~~
  1005. This is a list of file types that will have a command line executed to test
  1006. the file integrity upon their upload. The file types are specified by extension
  1007. and if one file extension is listed more than once, each command line will
  1008. be executed. The command lines must return a DOS error code of 0 (no error)
  1009. in order for the file to pass the test. This method of file testing upon upload
  1010. is also known as an upload event. This test or event, can do more than just
  1011. test the file, it can perform any function that the sysop wishes. Such as
  1012. adding comments to an archived file, or extracting an archive and performing
  1013. a virus scan. While the external program is executing, a text string is
  1014. displayed to the user. This "working" string can be set for each file type
  1015. and command line listed. Here are some example command lines and working
  1016. strings for various file types:
  1017.  
  1018. ZIP  %!pkunzip -t %f                            Testing ZIP Integrity...
  1019. ZIP  %!pkzip -z %f < ..\TEXT\ZIPMSG.TXT         Adding ZIP Comment...
  1020. ARJ  %!arj t %f                                 Testing ARJ Integrity...
  1021. GIF  %!gt %f                                    Testing GIF Integrity...
  1022.  
  1023. 5.4 Extractable Files
  1024. ~~~~~~~~~~~~~~~~~~~~~
  1025. This is a list of archive file types that can be extracted to the temp
  1026. directory by an external program. The file types are specified by their
  1027. extension. For each file type you must specify the command line used to extract
  1028. the file(s). Here are some example command lines for extracting various files:
  1029.  
  1030. ZIP  %!pkunzip -o %f %g %s
  1031. ARJ  %!arj e %f %g %s
  1032.  
  1033. Notes on command lines syntax:
  1034.         The use of conversion specifiers are supported in all command lines
  1035.         within SCFG. Conversion specifiers are proceeded by a percent (%)
  1036.         symbol and are not case sensitive. The above command line examples use
  1037.         the following specifiers:
  1038.  
  1039.         %! EXEC directory:
  1040.                 If the program you are executing with this command line is not
  1041.                 located in your EXEC directory, you can specify the directory
  1042.                 where the program is located or, if the program is in your
  1043.                 search path, start the command line with just the program name
  1044.                 (no prefix). We suggest specifying the location of the program
  1045.                 for security reasons.
  1046.  
  1047.         %f Filename:
  1048.                 This is the filename of the archive that is to be extracted.
  1049.  
  1050.         %g Temp Directory:
  1051.                 This is the path to the temp directory. In the above command
  1052.                 lines, it is the destination of the extracted files.
  1053.  
  1054.         %s File Specification:
  1055.                 This is the file specification to extract from the archive.
  1056.  
  1057.         See SPECS.DOC for a complete list of the available specifiers.
  1058.  
  1059.  
  1060. 5.5 Transfer Protocols
  1061. ~~~~~~~~~~~~~~~~~~~~~~~
  1062. This is a list of file transfer protocols that can be used to transfer files
  1063. either to or from a remote user. For each protocol, you can specify the
  1064. mnemonic (hot-key) to use to specify that protocol, the command line to use for
  1065. uploads, downloads, batch uploads, batch downloads, bidirectional file
  1066. transfers, and the support of DSZLOG. If the protocol doesn't support a
  1067. certain method of transfer, or you don't wish it to be available for a certain
  1068. method of transfer, leave the command line for that method blank. Be advised,
  1069. that if you add or remove any transfer protocols, you will need to edit the
  1070. protocol menus (ULPROT, DLPROT, BATUPROT, BATDPROT, and BIPROT) in the
  1071. TEXT\MENU directory accordingly. The '%f' command line specifier is used to
  1072. represent the filename or batch file list. The following is a list of example
  1073. protocol configurations:
  1074.  
  1075. DSZ Xmodem:
  1076.         Mnemonic                X
  1077.     Upload Command Line    %!dsz port %p estimate 0 %e rx %f
  1078.     Download Command Line    %!dsz port %p estimate 0 %e sx %f
  1079.         Batch UL Command Line
  1080.         Batch DL Command Line
  1081.         Biddir Command Line
  1082.         Uses DSZLOG             Yes
  1083.  
  1084. DSZ Ymodem:
  1085.         Mnemonic                Y
  1086.     Upload Command Line    %!dsz port %p estimate 0 %e rb %f
  1087.     Download Command Line    %!dsz port %p estimate 0 %e sb %f
  1088.     Batch UL Command Line    %!dsz port %p estimate 0 %e rb %g
  1089.     Batch DL Command Line    %!dsz port %p estimate 0 %e sb @%f
  1090.         Biddir Command Line
  1091.         Uses DSZLOG             Yes
  1092.  
  1093. DSZ Zmodem:
  1094.         Mnemonic                Z
  1095.         Upload Command Line     %!dsz port %p estimate 0 %e rz %f
  1096.         Download Command Line   %!dsz port %p estimate 0 %e sz %f
  1097.         Batch UL Command Line   %!dsz port %p estimate 0 %e rz %g
  1098.         Batch DL Command Line   %!dsz port %p estimate 0 %e sz @%f
  1099.         Biddir Command Line
  1100.         Uses DSZLOG             Yes
  1101.  
  1102. DSZ Ymodem-G:
  1103.         Mnemonic                G
  1104.         Upload Command Line     %!dsz port %p estimate 0 %e rb %f
  1105.         Download Command Line   %!dsz port %p estimate 0 %e sb %f
  1106.         Batch UL Command Line   %!dsz port %p estimate 0 %e rb -g %g
  1107.         Batch DL Command Line   %!dsz port %p estimate 0 %e sb @%f
  1108.         Biddir Command Line
  1109.         Uses DSZLOG             Yes
  1110.  
  1111. HS/Link:
  1112.         Mnemonic                H
  1113.         Upload Command Line
  1114.         Download Command Line
  1115.     Batch UL Command Line    %!hslink -i2 -p%p -e%e -u%g
  1116.     Batch DL Command Line    %!hslink -i2 -p%p -e%e -nu @%f
  1117.     Biddir Command Line    %!hslink -i2 -p%p -e%e -u%g @%f
  1118.         Uses DSZLOG             Yes
  1119.  
  1120. BiModem:
  1121.         Mnemonic                B
  1122.         Upload Command Line
  1123.         Download Command Line
  1124.         Batch UL Command Line   %!bimodem /l%p /b%e
  1125.         Batch DL Command Line   %!bimodem /l%p /b%e
  1126.         Biddir Command Line     %!bimodem /l%p /b%e
  1127.         Uses DSZLOG             Yes
  1128.  
  1129.  
  1130. 5.6 Alternate File Paths
  1131. ~~~~~~~~~~~~~~~~~~~~~~~~
  1132. This option allows the sysop to add and configure alternate file paths for
  1133. files stored on drives and directories other than the configured storage path
  1134. for a file directory. This command is useful for those who have one file
  1135. directory were they wish to have files listed from multiple CD-ROMs or hard
  1136. disks.
  1137.  
  1138. See ALTUL in SYSOP.DOC for more information.
  1139.  
  1140.  
  1141. 6.0 External Programs
  1142. ~~~~~~~~~~~~~~~~~~~~~
  1143. This selection will spawn a menu from you can select "Events", "Editors",
  1144. or "Online Programs". Events are event or time initiated programs, Editors
  1145. are external text editors, and Online Programs are external programs or games
  1146. (often referred to as doors) that are available to the users while online with
  1147. the 'X' command from the main section. An XTRN directory is created off of your
  1148. main SBBS directory upon installation and it is suggested you create a
  1149. subdirectory for each of your external programs off of this directory.
  1150. Synchronet Blackjack is, by default, installed in XTRN\SBJ and the Synchronet
  1151. External Programs Software Development Kit for C Programmers is installed in
  1152. the XTRN\SDK directory.
  1153.  
  1154.  
  1155. 6.1 Events
  1156. ~~~~~~~~~~
  1157. Logon Event:
  1158.         This is the command line for a program that will execute during the
  1159.     logon sequence of every user. The program cannot have user interaction.
  1160.     The program will be executed after the LOGON message is displayed and
  1161.     before the logon user list is displayed. If you wish to place a program
  1162.     in the logon sequence of users that includes interaction or requires
  1163.     account information, you probably want to use an online external
  1164.     program configured to run as a logon event. See 6.3 Online Programs
  1165.     for more information.
  1166.  
  1167. Logoff Event:
  1168.         This is the command line for a program that will execute during the
  1169.         logoff sequence of every user. This program cannot have user
  1170.     interaction because it is executed after carrier is dropped. If you
  1171.     wish to have a program execute before carrier is dropped, you probably
  1172.     want to use an online external program configured to run as a logoff
  1173.     event. See 6.3 Online Programs for more information.
  1174.  
  1175. Daily Event:
  1176.         This is the command line for a program that will run after the first
  1177.         user that logs on after midnight, logs off (regardless of what node).
  1178.  
  1179. Timed Event:
  1180.         This is the command line for a program that will run at a specified
  1181.         time every day.
  1182.  
  1183. Event Time:
  1184.         This is the time (in 24hr format) for the above mentioned program
  1185.         to execute.
  1186.  
  1187. Event Node:
  1188.         This is the node that will execute the event and can optionally be
  1189.         set to run exclusively (all other nodes inactive) by selecting this
  1190.         option.
  1191.  
  1192.  
  1193. 6.2 Editors
  1194. ~~~~~~~~~~~
  1195. This selection will bring up a list of external editors that are available
  1196. as alternatives to the Synchronet built-in editor. Editors can be added and
  1197. deleted with the INS and DEL keys. Selecting an editor allows you to view
  1198. and edit its settings. The available settings are:
  1199.  
  1200. Name:
  1201.         This is a description of the editor.
  1202.  
  1203. Local Command Line:
  1204.         This is the command line to use when the user is online locally.
  1205.  
  1206. Remote Command Line:
  1207.         This is the command line to use when the user is online remotely.
  1208.  
  1209.  
  1210. 6.3 Online Programs
  1211. ~~~~~~~~~~~~~~~~~~~
  1212. This selection will generate a list of the installed online external programs.
  1213. You can add and remove external programs from this list with the INS and DEL
  1214. keys. If you select an external program, you can edit it's configuration. The
  1215. available configuration options are:
  1216.  
  1217. Name:
  1218.         This is a description of the external program.
  1219.  
  1220. Command Line:
  1221.         This is the command line to execute.
  1222.  
  1223. Clean-up Command Line:
  1224.         Some external programs require a second program to be executed
  1225.         immediately after the main program is. If the program your configuring
  1226.         is such a program, you specify the necessary command line here.
  1227.  
  1228. Minimum Main Level:
  1229.         This is the minimum main level required to access this program.
  1230.  
  1231. Allowed (Required) Main Flags:
  1232.         This is a list of Main Flags (MF) that a user must have to be able
  1233.         to run this program. He can either be required to have any one of
  1234.         the flags (Allowed) or have to have all of the flags (Required).
  1235.  
  1236. ANSI Required:
  1237.         If this option is set to 'Yes', the user must have ANSI enabled in
  1238.         his defaults to access this program.
  1239.  
  1240. Multiuser:
  1241.         If this option is set to 'Yes', Synchronet will allow multiple
  1242.         simultaneous users to run it. If set 'No' it will handle rejecting
  1243.         users who attempt to run it while another is currently running it.
  1244.  
  1245. Write to Log File:
  1246.     If this option is set to 'No', the entry in the BBS data file will
  1247.         not contain the name of the log file to write to, thus disallowing
  1248.         the program to write to the log.
  1249.  
  1250. Intercept I/O Interrupts:
  1251.         If the program you are configuring does not have its own COM I/O
  1252.         routines, does not require a FOSSIL driver, and uses DOS for output,
  1253.         set this option to 'Yes'. This option cannot be enabled in conjunction
  1254.         with "Shrink BBS".
  1255.  
  1256. Shrink BBS:
  1257.         If this option is set to 'Yes', Synchronet will remove all but 16k
  1258.         of itself before running the program. This option cannot be used
  1259.         in conjunction with "Intercept I/O Interrupts", "Modify User Data",
  1260.     "Uses WWIV Color Codes", or "Execute on Event". If there isn't enough
  1261.     memory available to execute an external program, you may wish to
  1262.     enable this option, or switch to the overlay version of Synchronet
  1263.     by changing your SBBS.BAT in your node directory to read:
  1264.     @..\exec\sbbsovl %1 %2 %3 %4 %5
  1265.  
  1266.     You can check the amount of available memory from within Synchronet
  1267.     by using the sysop main menu command ";MEM".
  1268.     See SYSOP.DOC for more information.
  1269.  
  1270. Modify User Data:
  1271.         If this option is set to 'Yes' and the program creates the file
  1272.         MODUSER.DAT in the node directory, Synchronet will read this file
  1273.         upon returning and modify the user's data accordingly. This option
  1274.         cannot be used in conjunction with "Shrink BBS".
  1275.  
  1276. Execute on Event:
  1277.     You can optionally have this program execute on a certain user
  1278.     initiated event. This option can not be used in conjunction with
  1279.     "Shrink BBS". The available events are:
  1280.  
  1281.     Logon:
  1282.         After the LOGON message is displayed this program will be
  1283.         executed.
  1284.  
  1285.     Logoff:
  1286.         After the user initiates logoff with the 'O' command from the
  1287.         main or transfer sections, but before the LOGOFF message is
  1288.         displayed. The '/O' command does not initiate this event.
  1289.  
  1290.     New User:
  1291.         After a new user has sent validation feedback, this program
  1292.         will be executed.
  1293.  
  1294.     After selecting an event type, you will be asked if this program is
  1295.     to execute as an event only. If you select 'Yes', this program will
  1296.     not be available through the external programs menu ('X' main section
  1297.     command).
  1298.  
  1299. Uses WWIV Color Codes:
  1300.         If this option is set to 'Yes', any Ctrl-C# (where # digit from 0-9)
  1301.         will be expanded into ANSI escape sequences. This option must be used
  1302.         in conjunction with "Intercept I/O Interrupts" and cannot be used in
  1303.         conjunction with "Shrink BBS".
  1304.  
  1305. BBS Data File Type:
  1306.         This is the data file type created by the BBS for the external program
  1307.         to read and obtain information about the BBS and user that has run
  1308.         the program. This is often referred to as a door file. The available
  1309.         file types are:
  1310.  
  1311.     None:
  1312.         No data file is required.
  1313.  
  1314.         SBBS XTRN.DAT:
  1315.         For use with programs designed to run under Synchronet.
  1316.  
  1317.         WWIV CHAIN.TXT:
  1318.         For use with programs designed to run under WWIV or other
  1319.         CHAIN.TXT compatible BBS software.
  1320.  
  1321.     GAP DOOR.SYS:
  1322.         For use with programs designed to run under GAP or other
  1323.         DOOR.SYS compatible BBS software.
  1324.  
  1325.     RBBS DORINFO#.DEF:
  1326.         For use with programs designed to run under RBBS, QuickBBS,
  1327.         RemoteAccess, or other DORINFO#.DEF compatible BBS software.
  1328.  
  1329.     WildCat CALLINFO.BBS:
  1330.         For use with programs designed to run under WildCat, Genesis,
  1331.         or other CALLINFO.BBS compatible BBS software.
  1332.  
  1333.  
  1334. 6.3.1 Online External Program Configuration Examples
  1335. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1336. The following are configuration examples for some popular online programs
  1337. (all games), including Synchronet Blackjack! which comes free with Synchronet.
  1338. You will find example batch files in the EXEC directory for the execution of
  1339. each of the following programs.
  1340.  
  1341. Name                            Global War
  1342. Command Line                    %!gwar %f %#
  1343. Clean-up Command Line
  1344. Minimum Main Level              0
  1345. Allowed Main Flags
  1346. ANSI Required                   Yes
  1347. Multiuser                       Yes
  1348. Write to Log File               No
  1349. Intercept I/O Interrupts        No
  1350. Shrink BBS                      No
  1351. Modify User Data                No
  1352. Uses WWIV Color Codes           No
  1353. Execute on Event        No
  1354. BBS Data File Type              WWIV CHAIN.TXT
  1355.  
  1356. Name                            Trade Wars 2002
  1357. Command Line                    %!twar %f %h
  1358. Clean-up Command Line
  1359. Minimum Main Level              0
  1360. Allowed Main Flags
  1361. ANSI Required                   No
  1362. Multiuser                       No
  1363. Write to Log File               No
  1364. Intercept I/O Interrupts        No
  1365. Shrink BBS                      Yes
  1366. Modify User Data                No
  1367. Uses WWIV Color Codes        No
  1368. Execute on Event        No
  1369. BBS Data File Type              WWIV CHAIN.TXT
  1370.  
  1371. Name                            Food Fight!
  1372. Command Line                    %!food %f
  1373. Clean-up Command Line
  1374. Minimum Main Level              0
  1375. Allowed Main Flags
  1376. ANSI Required                   No
  1377. Multiuser                       No
  1378. Write to Log File               No
  1379. Intercept I/O Interrupts        Yes
  1380. Shrink BBS                      No
  1381. Modify User Data                No
  1382. Uses WWIV Color Codes           Yes
  1383. Execute on Event                No
  1384. BBS Data File Type              WWIV CHAIN.TXT
  1385.  
  1386. Name                            Dice War
  1387. Command Line                    %!dicewar %n
  1388. Clean-up Command Line        %!dwclean %n
  1389. Minimum Main Level              0
  1390. Allowed Main Flags
  1391. ANSI Required                   No
  1392. Multiuser                       Yes
  1393. Write to Log File               No
  1394. Intercept I/O Interrupts        Yes
  1395. Shrink BBS                      No
  1396. Modify User Data                Yes
  1397. Uses WWIV Color Codes           No
  1398. Execute on Event                No
  1399. BBS Data File Type              SBBS XTRN.DAT
  1400.  
  1401. Name                            Synchronet Blackjack!
  1402. Command Line                    %!sbj %n /l
  1403. Clean-up Command Line           %!sbjclean %n
  1404. Minimum Main Level              0
  1405. Allowed Main Flags
  1406. ANSI Required                   No
  1407. Multiuser                       Yes
  1408. Write to Log File               No
  1409. Intercept I/O Interrupts        Yes
  1410. Shrink BBS                      No
  1411. Modify User Data                Yes
  1412. Uses WWIV Color Codes           No
  1413. Execute on Event                No
  1414. BBS Data File Type              SBBS XTRN.DAT
  1415.  
  1416. Name                            Synchronet Blackjack! (No Risk)
  1417. Command Line                    %!sbj %n
  1418. Clean-up Command Line           %!sbjclean %n
  1419. Minimum Main Level              0
  1420. Allowed Main Flags
  1421. ANSI Required                   No
  1422. Multiuser                       Yes
  1423. Write to Log File               No
  1424. Intercept I/O Interrupts        Yes
  1425. Shrink BBS                      No
  1426. Modify User Data                No
  1427. Uses WWIV Color Codes           No
  1428. Execute on Event                No
  1429. BBS Data File Type              SBBS XTRN.DAT
  1430.  
  1431.  
  1432. 7.0 Text File Sections
  1433. ~~~~~~~~~~~~~~~~~~~~~~
  1434. This selection will produce a list of text file sections that the sysop has
  1435. created for users to freely view text files. It is requested that all sysops
  1436. make some or all of the Synchronet documentation available in a text file
  1437. section. At the very minimum, TEXT\SBBS.MSG should be available for users to
  1438. review. You can add and remove sections with the INS and DEL keys. The
  1439. following configuration options are available for each section:
  1440.  
  1441. Name:
  1442.         This is a description of the text file section.
  1443.  
  1444. Minimum Age:
  1445.         This is the minimum required user age for access to this section.
  1446.  
  1447. Minimum Main Level:
  1448.         This is the minimum required main level for a user to access this
  1449.         section.
  1450.  
  1451. Allowed (Required) Main Flags:
  1452.         This is a list of Main Flags (MF) that a user must have to be able
  1453.         to access this section. He can either be required to have any one of
  1454.         the flags (Allowed) or have to have all of the flags (Required).
  1455.  
  1456. Internal Code:
  1457.         This is an internal code for SBBS to distinguish this text file section
  1458.         from the others on the system. This must be a unique name of up to 8
  1459.         valid DOS filename characters.
  1460.  
  1461.  
  1462. 8.0 Networks
  1463. ~~~~~~~~~~~~
  1464. Selecting this option will produce a list of available network technologies.
  1465. Select the network technolgoy of your interest and refer to the following
  1466. section that pertains to your selected network technology.
  1467.  
  1468.  
  1469. 8.1 QWK Packet Networks
  1470. ~~~~~~~~~~~~~~~~~~~~~~~
  1471. QWK Packet Networks are message networks based on the QWK message packet
  1472. format. Since Synchronet internally support QWK packet networks, QWK Hubs
  1473. do not need any additional software and QWK Nodes only require a communications
  1474. program with scripting ability to perform the call-out and obtain the packets
  1475. from the QWK Hubs.
  1476.  
  1477. There are two options from the QWK Packet Networks menu, Network Hubs and
  1478. Default Tagline. Selecting the Default Tagline will allow you to create or
  1479. edit the tagline that will be used for messages that are sent out on the
  1480. network from your QWK netted sub-boards. Individual sub-boards can have a
  1481. different tagline to override this one, or use no tagline at all. Ctrl-A codes
  1482. can be used in taglines so that other Synchronet systems will see the tagline
  1483. in your preferred color scheme. The beginning of the tagline is not
  1484. configurable. It consits of a tear line and the Synchronet product name:
  1485. ---
  1486.  ■ Synchronet ■
  1487.  
  1488. Configured tagline text will attached to the end of the above tagline.
  1489.  
  1490.  
  1491. 8.1.1 Network Hubs
  1492. ~~~~~~~~~~~~~~~~~~
  1493. Selecting this option produces a list of configured hubs that your system
  1494. calls to upload REP packets to and download QWK packets from. If a system
  1495. calls your system for messages, it is a node and your system is the hub and you
  1496. should not have that system listed as a hub. If you do not call any systems
  1497. for networked messages, then your system is a hub and the only configuration
  1498. you need to do is set your taglines and the network options for each of your
  1499. netted sub-boards. Use INS to add hubs and DEL to delete hubs from this hub
  1500. list.
  1501.  
  1502. For each hub the following options are available:
  1503.  
  1504. Hub System ID:
  1505.     This is the QWK system ID of the hub.
  1506.  
  1507. Pack Command Line:
  1508.     This is the command line to execute to pack messages.
  1509.  
  1510. Unpack Command Line:
  1511.     This is the command line to execute to unpack messages.
  1512.  
  1513. Call-out Command Line:
  1514.     This is teh command line to execute to perform the call-out.
  1515.  
  1516. Call-out Node:
  1517.     This is the number of the node which should peform the call-out.
  1518.  
  1519. Call-out Days:
  1520.     These are the days to perform the call-out.
  1521.  
  1522. Call-out Time/Frequency:
  1523.     This is either the specific time to call-out, or the number of times
  1524.     per day to call-out.
  1525.  
  1526.  
  1527. 8.1.1.1 Networked Sub-boards
  1528. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1529. This is the list of sub-boards that are networked with this hub. For each
  1530. sub-board the following options are available:
  1531.  
  1532. Sub-board:
  1533.     Which sub-board is to be networked (Group and Sub-board name).
  1534.  
  1535. Conference Number:
  1536.     This is the conference number of the sub-board on the HUB system.
  1537.     If the hub is a Synchronet BBS and the sub-board is the second
  1538.     sub-board in the first group, the conference number is 102; if the
  1539.     sub-board is the first sub-board in the third group, the conference
  1540.     number is 301, etc. The conference numbering scheme for BBS programs
  1541.     other than Synchronet is usually just 1, 2, 3, etc.
  1542.  
  1543. Ctrl-A Codes:
  1544.     This option allows you to determine how to handle Ctrl-A codes in
  1545.     messages. If the hub is a Synchronet BBS, you will want to set this
  1546.     to "Leave in". If the hub is not a Synchronet BBS, you will almost
  1547.     always want to set this to "Strip out". If the hub is not a Synchronet
  1548.     BBS, but allows ANSI escape sequences in messages, set this option
  1549.     to "Expand to ANSI".
  1550.  
  1551.  
  1552. 8.2 FidoNet EchoMail and NetMail
  1553. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1554. FidoNet networking requires the use of the SBBSFIDO utility, a FidoNet
  1555. front-end mailer, and possibly an EchoMail Scan/Toss utility. For information
  1556. on SBBSFIDO, see SBBSFIDO.DOC.
  1557.  
  1558. The following options are available from this menu:
  1559.  
  1560. System Address:
  1561.     This is the default FidoNet address for sub-boards and the address
  1562.     used for the sending and receiving of NetMail.
  1563.  
  1564. Default Origin Line:
  1565.     This is the optional default origin line for sub-boards.
  1566.  
  1567. Semaphore File:
  1568.     This is an optional semaphore file that will be signled upon the
  1569.     creation of NetMail messages and EchoMail. If your front-end mailer
  1570.     supports semaphores, this option should be set to the path and name
  1571.     of the file that causes the mailer to re-scan the directories for
  1572.     new NetMail or EchoMail messages.
  1573.  
  1574. EchoMail Base Directory:
  1575.     This is the base directory for EchoMail sub-directories. If all of the
  1576.     EchoMail sub-boards have an EchoMail path specified, this option is
  1577.     not used. If one or more sub-boards do not have an EchoMail path
  1578.     specified, their FidoNet messages will be stored in a sub-directory
  1579.     off of this base directory with the internal code as the sub-directory
  1580.     name.
  1581.  
  1582. NetMail Directory:
  1583.     This is the directory where NetMail messages are exported to and
  1584.     imported from.
  1585.  
  1586. Allow Sending of NetMail:
  1587.     If you want to allow users of the BBS to send NetMail, set this option
  1588.     to Yes.
  1589.  
  1590. Send NetMail Using Alias:
  1591.     If NetMail should be sent using the user's Alias as the from name,
  1592.     set this option to Yes. If this option is set to No, the user's
  1593.     real name is used.
  1594.  
  1595. NetMail Defaults to Crash:
  1596.     If NetMail should default to crash status (send immediately), set this
  1597.     option to Yes.
  1598.  
  1599. NetMail Defaults to Hold:
  1600.     If NetMail should be held until the sysop can review and authorize it
  1601.     before it is sent, set this option to Yes.
  1602.  
  1603. Kill NetMail After Sent:
  1604.     If NetMail messages should be deleted after they are successfully sent
  1605.     out, set this option to Yes.
  1606.  
  1607. Cost to Send NetMail:
  1608.     If you want the sending of NetMail to cost the user credits, set this
  1609.     value to the amount of credits. Setting this value to 0, makes the
  1610.     sending of NetMail free.
  1611.  
  1612. /* End of CONFIG.DOC */
  1613.