home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / TELECOM / OSKBox.lzh / MAILBOX / CC / DOCS / forward.doc < prev    next >
Text File  |  1992-06-17  |  7KB  |  137 lines
  1. NAME:
  2.  
  3.      forward - packet radio mail forwarding program.
  4.  
  5. AUTHOR:
  6.  
  7.      Eric Williams  WD6CMU, 71336,1424
  8.  
  9. SYSTEM CONFIGURATION:
  10.  
  11.      OS9/68K, MW C v2.0
  12.  
  13. SYNTAX:
  14.  
  15.      forward [options] <port> <callsign> <callsign>...
  16.  
  17. DESCRIPTION:
  18.  
  19.      forward allows for mail forwarding to other W0RLI-compatible packet
  20. radio mailboxes.  It integrates both with the mailbox mail database and
  21. the host mode translator program.
  22.  
  23.      The first argument to forward specifies the port through which the
  24. target mailbox(s) can be connected to.  It is the device name (minus the
  25. '/') of the SCF device which is connected to the TNC.  This device must
  26. also have associated with it a background task which is running the host
  27. mode translator (host).  The port name is used to build the names of pipes
  28. through which forward communicates with host.
  29.  
  30.      The remainder of the arguments specify the callsigns of the
  31. mailboxes to which mail might be forwarded.  These callsigns are
  32. translated into file names and these forwarding files are assumed to
  33. exist in the directory FWDIR directory as defined in mailbox.h. 
  34. Translation involves appending ".fwd" to the callsign and translating
  35. the hyphen for the ssid (if any) to underline.  For example, "w6cus-1"
  36. would become "w6cus_1.fwd".  If the forwarding file does not exist,
  37. forwarding to that mailbox is aborted. 
  38.  
  39.      Forwarding files are text files which contain information about the
  40. path or paths to that mailbox and callsigns of stations whose mail should
  41. be sent to the mailbox.  If a line in the forward file begins with "VIA",
  42. the remainder of the line is used as a path for connection to the mailbox. 
  43. If more than one such lines are in the forward file, connection will be
  44. attempted using the first such path.  Should that fail, the second path
  45. will be tried, and so on until the last path.  If no "VIA" lines are
  46. present in the forwarding file, the path is assumed to be a direct connect. 
  47. Callsigns in a VIA line that have a leading "*" specify NET/ROM nodes. 
  48. An "*" all by itself as the last call indicates that the station is a G3RUH
  49. node, and that the "BBS" command is needed to access the mailbox port.
  50.  
  51.      Lines which begin with "@" contain a filename path to another
  52. forward file which will be inserted into the current file at that point. 
  53. Such inserted files may contain other insertion lines.  (Note that
  54. relative paths are relative to /dd/MAILBOX.)
  55.  
  56.      Lines that begin with a ";" are comments and are ignored by the
  57. program.
  58.  
  59.      Other lines in the forward file are assumed to contain a single
  60. callsign.  Wildcard characters are allowed in these callsign lines: a '?'
  61. will match any single character, while a '*' will match any number of any
  62. characters
  63.  
  64.      The sequence of events during execution of forward is as follows: The
  65. first forward file is opened and its contents read.  Then the mail database
  66. is searched for any messages destined for this mailbox.  If there are any,
  67. then communication with the host translator is established.  Using the
  68. first of the paths specified in the forward file, a connection with the
  69. mailbox is attempted.  If the link fails, then the next path in the file is
  70. attempted.  Once connection is established with the mailbox, the messages
  71. for it are sent and then deleted from the mail system (except for type B
  72. messages or those to a distribution designator).  The next mailbox in the
  73. command line is then processed. 
  74.  
  75.      Distribution designators are special BBS addresses that indicate
  76. that messages to these addresses should be copied to more than one BBS. 
  77. Distribution designators are specified by placing a file with a name
  78. consisting of the designator followed by ".dis" in the directory
  79. specified by the DISDIR definition in mailbox.h.  These files contain a
  80. list of bbs callsigns (one per line, no SSID) to which bulletins
  81. carrying the designator are to be distributed.  IMPORTANT NOTE: The
  82. designator address must also appear in each of the forward files
  83. corresponding to the BBSs listed in the distribution file. 
  84.  
  85.      As the bulletins is forwarded to each BBS in the distribution list,
  86. that BBS is checked off in a bit field in the mail directory record for the
  87. bulletin.  This 16-bit field can be examined by using the 'E' option to
  88. the list command of the mailbox program and is displayed as a 4-digit hex
  89. number, the LSB of which corresponds to the first BBS in the
  90. distribution list, etc.  Examining the value of this field and comparing
  91. it to the distribution list file corresponding to the message's address
  92. can help the sysop to diagnose forwarding hangups.
  93.  
  94.      The following options are currently available:
  95.  
  96.      -r       Inhibit reverse forward prompt.
  97.  
  98.      -s       Don't do any forwarding, but only prompt for reverse forward.
  99.  
  100.      -m<num>  Set the maximum connect time to <num> minutes.  (Note that
  101.               reverse-forwarding is under control of the other system,
  102.               and that the connect time cannot be limted by this option.)
  103.  
  104.      -b<num>  Set the maximum forwarded message size to <num> kilobytes.
  105.  
  106.      -p<str>  Set the message type priority.  <str> is one or more
  107.               characters, each one specifying a type of message that
  108.               will be forwarded before other types.  The message types are:
  109.  
  110.                    *  any message
  111.                    p  any non-bulletin message
  112.                    x  any message of type 'x'
  113.  
  114.               For example, the option "-pt*" means to forward NTS
  115.               messages (type 'T'), and then any other messages.  Note
  116.               that this option may have to be quoted to prevent wild-
  117.               card expansion by shell.
  118.  
  119.      Periodic execution of forward can be accomplished with the cron
  120. daemon.  Messages that have been successfully forwarded will create an
  121. entry in /dd/MAILBOX/logfile with the callsign "AUTOFW".  The entry will
  122. use the code 'f' and be followed by the message number and the callsign of
  123. the mailbox forwarded to.  Mail which has been refused forward by the other
  124. BBS will be entered with the code 'r' in the log file, followed by the text
  125. of the message sent by the refusing BBS. 
  126.  
  127.      Verbose debugging output is created by forward during operation if
  128. it was compiled with the DEBUG flag defined.  This can be used to track
  129. its progress and any problems in its execution.  If such output is not
  130. desired, it can be redirected to the /nul device. 
  131.  
  132. BUGS:
  133.  
  134.      forward has been known to hang during the forwarding process for
  135. unknown reasons.  The sysop should check regularly to make sure his
  136. system is operating properly.
  137.