ProBoard BBS Documentation

The Choice of Professionals

User Tools

Site Tools

Trace: • paths • example_batch_files • protocol_configuration_f2 • file_counters
protocol_configuration_f2

Differences

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

Link to this comparison view

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