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 / mailbox.doc < prev    next >
Text File  |  1991-02-02  |  6KB  |  132 lines
  1. NAME:
  2.  
  3.      mailbox - packet radio mailbox system.
  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.      mailbox [<callsign> <port> <callsign>...]
  16.  
  17. DESCRIPTION:
  18.  
  19.      mailbox provides a reentrant messaging system for use in conjunction
  20. with the WA8DED host translator (host).  It provides packet radio users
  21. with a public message system and file services, as well as maintaining
  22. accounting information for the mailbox administrator.  Although the normal
  23. mode of operation for mailbox is to be forked from the host translator, it
  24. can be run from any terminal in the system in order to allow debugging and
  25. local access to the mail system. 
  26.  
  27.      The first argument to mailbox, if provided, gives the callsign of the
  28. station accessing the mail system.  If not provided, it defaults to
  29. "SYSOP" and the user is given sysop privileges.  The second argument is
  30. intended to be the device name of the TNC through which the mailbox user
  31. is connected, minus the "/".  Any additional arguments are assumed to be
  32. the callsign of the digipeaters through which the user has connected.
  33. For example:
  34.  
  35.         mailbox W6MEO T7 KB6GOZ-1
  36.  
  37.      When mailbox runs, its first action is to change its working data
  38. directory to "/dd/mailbox".  Within this directory it expects to find
  39. several files.  All files and directories described below reside within
  40. this directory.
  41.  
  42.      The first file mailbox expects to find is one called "users" which
  43. contains a database of all stations which have checked into the mail
  44. system.  Various vital statistics on each user are kept by mailbox and a
  45. user's entry will be updated each time he connects.  (Note: no entry is
  46. made for someone running mailbox without a callsign argument.)
  47.  
  48.      A text file called "motd" will then be searched for.  If it exists,
  49. and if its last access date is later than the last checkin date of the
  50. user, it is printed out.
  51.  
  52.      A file called "mail_dir" must be in the mailbox directory, with a
  53. copy of the file in a data module of the same name.  This file is loaded
  54. by the program "mbinit".
  55.  
  56.      A directory called "MAIL" contains the message database.  Each file
  57. in this directory represents a message in the mail system.  The file name
  58. consists of a 6-digit number (with leading zeroes) which corresponds to
  59. the message number.
  60.  
  61.      Zero or more distribution list files, whose name end with ".dis" are
  62. then searched for in the mailbox directory.  The names of these files are
  63. used to specify bulletin distribution designators and the mailbox will
  64. force a BID to be generated for messages addressed @ any of these
  65. designators.  These files consist of one or more BBS callsigns, one per
  66. line, to which copies of bulletins carrying a designator matching the
  67. file's name should be sent. 
  68.  
  69.      The directory "HELP" contains several text files which are accessed
  70. and printed when the user asks for help.
  71.  
  72.      The directory "FILES" contains the user-accesible files which can be
  73. downloaded and uploaded, as described in the user commands.  The file
  74. "file_ownders" contains a list of files and the callsigns of the stations
  75. that uploaded them, and so have permission to rename or delete them.
  76.  
  77.      The text file "info" will be printed out in response to the I
  78. command.
  79.  
  80.      The file "logfile" is a running log of who did what.  Currently, only
  81. actions which actually modify the message or file data are logged.  The
  82. first seven characters of each line are the callsign of the station making
  83. the action.  The next 10 characters are the date and time of the action in
  84. the format YYMMDDHHMM.  The next character is the action itself.  Upper-
  85. case characters refer to commands given to the mailbox and are followed by
  86. the arguments to the command, if any.  Lower-case characters refer to
  87. actions other than those caused by user commands.  The following codes
  88. (other than mailbox commands) are currently defined:
  89.  
  90.      c: connect (followed by connect path, including port)
  91.      d: disconnect
  92.      f: message forwarded (followed by msg #, see doc for forward)
  93.      r: message was refused forward (followed by msg # and reason for
  94.         refusal, if any)
  95.  
  96.      Documentation for the various commands that mailbox responds to can
  97. be found in the help files as used by the program.  Listed here are the
  98. non-user oriented commands.
  99.  
  100.      If a user is marked in the userfile as having sysop privileges, then
  101. he is allowed to read or kill any message in the system.  He is also
  102. allowed to rename or erase any file in the system.  Users marked as sysop
  103. or bbs in the userfile can also send messages with an originating callsign
  104. other than their own by adding "< <callsign>" to the send command.
  105.  
  106.      The List command can be augmented by the X and/or E flag.  X calls for
  107. a listing of deleted messages as well as active messages.  Deleted messages
  108. will show a X in the status column.  The E modifier will give an extended
  109. message listing, showing date last modified, distribution status, full
  110. hierarchical route, and message BID.  The distribution status is a
  111. hexidecimal number, each bit of which corresponds to a callsign in the
  112. distribution list file (described above).  The X and E flags can be added
  113. to any legal list command after the L, for example: "LXL 5", or "LE@
  114. AMSAT".  Note that the X and E flags must appear in that order if they are
  115. used together, for example: "LXE> WD6CMU".  (Not: "LEX> WD6CMU"!)
  116.  
  117.      A user marked sysop can use the Modify command to change any message,
  118. and to change fields in the mail database not available to users. 
  119.  
  120.      The @ command provides a "back door" into the OSK operating system.
  121. This is available only to users marked as sysop, and required a numerical
  122. key for an argument.  This key is created by passing the month, day, year,
  123. hour, minute, and second through the standard OSK 24-bit CRC algorithm.
  124. The CRC can be initialized with a sysop-selected "password" to make the
  125. code unique.  Programs to calculate the CRC are available in C, Basic,
  126. and for the HP-16C programmable calculator.
  127.  
  128. BUGS:
  129.  
  130.       The Bye command does not always result in a disconnect, for unknown
  131. reasons which probably involve the host command.
  132.