ProBoard BBS Documentation

The Choice of Professionals

User Tools

Site Tools

Trace: • start
protocol_configuration_f2

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
protocol_configuration_f2 [2022/04/30 04:16] – created adminprotocol_configuration_f2 [2022/04/30 10:27] (current) – admin
Line 1: Line 1:
-┌───────────────────────────────────────────────────────────────────────┐ +====== Protocol Configuration - (F2) ======
-│ Protocol Configuration - (F2)                                         │ +
-└───────────────────────────────────────────────────────────────────────┘+
  
 The second option in PROCFG.EXE is "Protocols".  You may want to skip The second option in PROCFG.EXE is "Protocols".  You may want to skip
Line 12: Line 10:
 be obtained from any ProBoard Support BBS, as well as many others. be obtained from any ProBoard Support BBS, as well as many others.
  
- 
-───────────────────────────────────────────────────────────────────────────── 
-                                     22  
 Downloading and uploading files has always been one of the most important Downloading and uploading files has always been one of the most important
 activities of BBS's.  Most BBS programs have file transfer protocols activities of BBS's.  Most BBS programs have file transfer protocols
Line 30: Line 25:
 <Ins>, remove a protocol by pressing <Del>. <Ins>, remove a protocol by pressing <Del>.
  
 +**__A protocol is entirely defined by the following parameters:__**
 +
 +**Protocol Name**
 +
 +Protocol's name, to be displayed in the down/upload menu. This can include a short
 +description if you like.
 +
 +**Hotkey**
 +
 +Key to be pressed by the user to activate the protocol.
 +
 +**Batch**
 +
 +Determines whether the protocol can handle batch-mode (whether it can handle multiple
 +files). Xmodem for example can handle only one file at a time, while Zmodem can handle
 +multiple files.
 +
 +**Enabled**
 +
 +ProBoard comes with several pre-configured protocols for which you may not have the
 +necessary files.  It would be useless to have these protocols displayed in the menu.
 +You can prevent this by setting Enable to 'No', without having to lose the
 +configuration for this protocol.
 +
 +**Both-Way**
 +
 +Determines whether the protocol is a full-duplex protocol, i.e.. whether it can send
 +and receive files at the same time. (eg. Bimodem)
 +
 +**Bimodem**
 +
 +The Bimodem protocol uses an odd format for its control file. Setting Bimodem to 'Yes'
 +causes the control file to be written to disk in Bimodem-format.
 +
 +**Log File**
 +
 +Name of the log file created by the protocol. After the file transfer, the
 +information needed to update the user- records will be obtained from this file by
 +ProBoard.  Most protocols write a file specified in the environment variable
 +DSZLOG.  ProBoard will set this variable to the right filename for you. ProBoard checks
 +for the logfile in the directory where it was started from, so if some external
 +protocol writes a different logfile than the one specified in the DSZLOG-variable,
 +make sure it writes the file in the startup-directory!
 +
 +**Control File**
  
-A protocol is entirely defined by the following parameters:+Protocols that can handle batch-mode usually allow parameters to be passed not 
 +only on the command line, but also (should the command line grow too long) by means of 
 +a control file. ProBoard must know of this file, to be able to pass the filenames to 
 +the protocol.
  
-Protocol Name ............... Protocol's name, to be displayed in the +**Download Command**
-                              down/upload menu. This can include a short +
-                              description if you like.+
  
-Hotkey ...................... Key to be pressed by the user to activate +Command needed to start the protocol in download-mode. You may want to use the 
-                              the protocol.+shell options of menu function 7 here.  If the first character of this command is a 
 +'@', the named pex-file will be run.  Note that no shell parameters (*x) are supported 
 +when calling a pex-file. You can use string macros though.
  
-Batch ....................... Determines whether the protocol can handle +**IMPORTANT:** The command should be independent of the path it is called from.
-                              batch-mode (whether it can handle multiple +
-                              files). Xmodem for example can handle only +
-                              one file at a time, while Zmodem can handle +
-                              multiple files.+
  
-Enabled ..................... ProBoard comes with several pre-configured +Batch-mode protocols also require a control file to be specified. Should you, anywhere 
-                              protocols for which you may not have the +in this field, fill in a '#', then this character will at run-time be replaced by 
-                              necessary files.  It would be useless to +the filename of the file to be sent (only for non-batch protocols).
-                              have these protocols displayed in the menu. +
-                              You can prevent this by setting Enable to +
-                              'No', without having to lose the +
-                              configuration for this protocol.+
  
-Both-Way .................... Determines whether the protocol is a full- +**Upload Command**
-                              duplex protocol, i.e.. whether it can send +
-                              and receive files at the same time. (eg. +
-                              Bimodem)+
  
-Bimodem ..................... The Bimodem protocol uses an odd format for +Command needed to start the protocol in upload-mode. Here also, the command should 
-                              its control file. Setting Bimodem to 'Yes' +be independent of the directory it is called from and a '#' will be replaced by 
-                              causes the control file to be written to +the filename of the file to be received (for non-batch protocols), or by the 
-                              disk in Bimodem-format.+directory where files should be received into (for batch-protocols).  A '@' as the 
 +first character will execute a pex-file (see DL Command).
  
-Log File .................... Name of the log file created by the +**Download String**
-                              protocol. After the file transfer, the +
-                              information needed to update the user- +
-                              records will be obtained from this file by +
-                              ProBoard.  Most protocols write a file +
-                              specified in the environment variable +
-                              DSZLOG.  ProBoard will set this variable to +
-                              the right filename for you. ProBoard checks +
-                              for the logfile in the directory where it +
-                              was started from, so if some external +
-                              protocol writes a different logfile than +
-                              the one specified in the DSZLOG-variable,+
  
-───────────────────────────────────────────────────────────────────────────── +Determines what should be written in the control file when downloading.  A '#' 
-                                     23  +character is replaced by the path and filename of the file to be sent to the 
-                              make sure it writes the file in the +user. Most often, a single '#' is the only character in this field. This works for 
-                              startup-directory!+most of the protocols.
  
-Control File ................ Protocols that can handle batch-mode +**Example:**
-                              usually allow parameters to be passed not +
-                              only on the command line, but also (should +
-                              the command line grow too long) by means of +
-                              a control file. ProBoard must know of this +
-                              file, to be able to pass the filenames to +
-                              the protocol.+
  
-Download Command ............ Command needed to start the protocol in +In case a user wants to download 3 files, entering 'Send #' in this field causes 
-                              download-mode. You may want to use the +the following to be written in the control file:
-                              shell options of menu function 7 here.  If +
-                              the first character of this command is a +
-                              '@', the named pex-file will be run.  Note +
-                              that no shell parameters (*x) are supported +
-                              when calling a pex-file. You can use string +
-                              macros though.+
  
-                              IMPORTANT: The command should be +     Send C:\PB\FILES\COMM\TM.ZIP 
-                                         independent of the path it is +     Send C:\PB\FILES\COMM\TBILL.ZIP 
-                                         called from.+     Send C:\PB\FILES\UTIL\SHEZ55.ZIP
  
-                              Batch-mode protocols also require a control +You can always take a look at the pre-configured protocols, to lighten things 
-                              file to be specified. Should you, anywhere +up for you.
-                              in this field, fill in a '#', then this +
-                              character will at run-time be replaced by +
-                              the filename of the file to be sent (only +
-                              for non-batch protocols).+
  
-Upload Command .............. Command needed to start the protocol in +**Upload String**
-                              upload-mode. Here also, the command should +
-                              be independent of the directory it is +
-                              called from and a '#' will be replaced by +
-                              the filename of the file to be received +
-                              (for non-batch protocols), or by the +
-                              directory where files should be received +
-                              into (for batch-protocols).  A '@' as the +
-                              first character will execute a pex-file +
-                              (see DL Command).+
  
-Download String ............. Determines what should be written in the +<reserved for future use>
-                              control file when downloading.  A '#' +
-                              character is replaced by the path and +
-                              filename of the file to be sent to the +
-                              user. Most often, a single '#' is the only +
-                              character in this field. This works for +
-                              most of the protocols.+
  
-                              Example:+**Download Keyword**
  
-                              In case a user wants to download 3 files, +In order to allow ProBoard to update the user-records from the protocol's log file, 
-                              entering 'Send #' in this field causes the +a keyword must be specified to indicate a file has successfully been sent. If a 
-                              following to be written in the control +protocol writes 'Sent <filename>' in the logfile, you should specify 'Sent' as the 
-                              file:+keyword. This keyword is CASE SENSITIVE!
  
-                                  Send C:\PB\FILES\COMM\TM.ZIP +**Upload Keyword**
-                                  Send C:\PB\FILES\COMM\TBILL.ZIP +
-                                  Send C:\PB\FILES\UTIL\SHEZ55.ZIP+
  
-───────────────────────────────────────────────────────────────────────────── +Same as the previous field, for uploads.
-                                     24  +
-                              You can always take a look at the pre- +
-                              configured protocols, to lighten things +
-                              up for you.+
  
-Upload String ............... <reserved for future use>+**File Word Number**
  
-Download Keyword ............ In order to allow ProBoard to update the +This is the number of the sent file's filename, counting from the keyword, but 
-                              user-records from the protocol's log file, +NOT including the keyword. This is used for both uploads and downloads.
-                              a keyword must be specified to indicate a +
-                              file has successfully been sent. If a +
-                              protocol writes 'Sent <filename>' in the +
-                              logfile, you should specify 'Sent' as the +
-                              keyword. This keyword is CASE SENSITIVE!+
  
-Upload Keyword .............. Same as the previous field, for uploads.+     Eg. Sent 12/05/90 12334 PB_220.ZIP
  
-File Word Number............. This is the number of the sent file's +In this case, you should enter '3' as the word number, because PB_220.ZIP is the 
-                              filename, counting from the keyword, but +third word counting from, but not including, the keyword ('Sent').
-                              NOT including the keyword. This is used +
-                              for both uploads and downloads.+
  
-                              Eg. Sent 12/05/90 12334 PB_220.ZIP+**Efficiency**
  
-                              In this case, you should enter '3' as the +A percentage that gives the throughput efficiency for this protocol. This value is 
-                              word number, because PB_220.ZIP is the +used to estimate the time needed to perform a file transfer.
-                              third word counting from, but not +
-                              including, the keyword ('Sent').+
  
-Efficiency .................. A percentage that gives the throughput 
-                              efficiency for this protocol. This value is 
-                              used to estimate the time needed to perform 
-                              a file transfer. 
  
 +**Local Only**
  
-Local Only .................. If set to "Yes", this protocol will only be +If set to "Yes", this protocol will only be available when logging in locally.
-                              available when logging in locally.+
  
  
-CONCLUSION:+__**CONCLUSION:**__
  
 Correctly installing the protocols may seem somewhat difficult at first, Correctly installing the protocols may seem somewhat difficult at first,
protocol_configuration_f2.1651263405.txt.gz · Last modified: 2022/04/30 04:16 by admin

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki