home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / comm / net / inetutils / contrib / sabot17.lha / Sabot / Sabot.doc < prev    next >
Text File  |  1994-02-27  |  8KB  |  230 lines
  1.                 Sabot - A Mailbox Monitor
  2.  
  3.                     By Scott Ellis
  4.  
  5.                 * Quick and Dirty Docs *
  6.  
  7. What is Sabot?
  8.  
  9.         Sabot is basically a clone of Mike Schwartz's MailMinder program, but
  10.     but smaller and with added functionality.  What Sabot does is watch
  11.     a file (presumably your mailbox), and do things when the mailbox
  12.     changes.
  13.  
  14.         What Sabot always does is display an AppIcon on your Workbench
  15.     screen showing you the status of the file being watched.  If the file is emply
  16.     it displays an icon illustrating an "empty mailbox". If the file is the same size
  17.         an icon depicting old mail is displayed.  If the mailbox gets bigger, then the
  18.     icon changes to a "full mailbox" icon, until you look at the file.
  19.     Very simple.
  20.  
  21.         Is a silly AppIcon worth almost 6k of space on your system? Of
  22.     course it is...but wait, that's not all! ;-) Sabot can also launch
  23.     programs.  Sabot can launch programs under a variety of circumstances,
  24.     including:
  25.                 Mailbox got bigger
  26.                 Click on the AppIcon
  27.                 Drop files onto the AppIcon
  28.  
  29.     Sounds exciting, eh?
  30.  
  31.  
  32. So how do I use Sabot?
  33.  
  34.         Sabot is simple to use.  You start Sabot from either the command
  35.     line, or from an Icon with appropriate ToolTypes.  All options are
  36.     optional, unless otherwise stated.
  37.  
  38.     The following are valid options:
  39.  
  40.         Mail (required) -
  41.  
  42.             This is the name of the icon you wish to be shown to indicate
  43.             that you have new mail. (Name is WITHOUT the ".info" extension)
  44.  
  45.         NoMail (required) -
  46.  
  47.             This is the name of the icon you wish to be shown to indicate
  48.             that you do not have new mail.  (Name is WITHOUT the ".info"
  49.                         extension)
  50.  
  51.         OldMail (required) -
  52.  
  53.                  This is the name of the icon you wish to be shown to indicate
  54.                 that you have old mail.  (Name is WITHOUT the ".info" extension)
  55.  
  56.         MailBox (MB) (required) -
  57.  
  58.             This is the name of your mailbox file.
  59.  
  60.         IconName (IN) -
  61.  
  62.             This option controls what is printed under the AppIcon.  If
  63.             this option is omitted, the AppIcon will be named "MailBox".
  64.  
  65.         XPos -
  66.  
  67.             XPos is the horizontal position, in pixels, where you want the
  68.             icon to appear.  If left out, the icon will be free floating
  69.             in the X direction.
  70.  
  71.         YPos -
  72.  
  73.             YPos is the vertical position, in pixels, where you want the icon
  74.             to appear.  If left out, the icon will be free floating in the Y
  75.             direction.
  76.  
  77.         ClickCommand (CC) -
  78.  
  79.             ClickCommand is the command that gets executed when the
  80.             AppIcon is double-clicked.
  81.  
  82.         ClickStack (CS) -
  83.  
  84.             ClickStack is the stack that ClickCommand is run with.  If
  85.             ClickCommand was omitted, ClickStack has no effect.
  86.  
  87.         MailCommand (MC) -
  88.  
  89.             MailCommand is the command that is executed when new mail
  90.             arrives.
  91.  
  92.         MailStack (MS) -
  93.  
  94.             MailStack is the stack that MailCommand is run with.  If
  95.             MailCommand was omitted, MailStack has no effect.
  96.  
  97.         DropCommand (DC) -
  98.  
  99.             DropCommand is the command that is executed when icons are
  100.             dropped on the AppIcon.  This command is executed once for each
  101.             icon dropped, and the name of the Icon is appended to the
  102.             DropCommand.
  103.  
  104.         DropStack (DS) -
  105.  
  106.             DropStack is the stack that DropCommand is run with.  If
  107.             DropCommand was omitted, DropStack has no effect.
  108.  
  109.         BeepLots -
  110.  
  111.             Normally, Sabot executes MailCommand only once, when the first
  112.             new mail message arrives.  If you want MailCommand to be run
  113.             for each new mail message, then use the BeepLots switch.
  114.  
  115.         CountDelete -
  116.  
  117.             Some mail programs delete the mailbox file when there are no
  118.             messages remaining, while others leave a zero length file.  If
  119.             your mailer deletes the file, then specify the CountDelete
  120.             switch so that Sabot will know that an empty file means there
  121.             are no messages, not that the mailbox just isn't completely
  122.             updated yet.
  123.  
  124.         MailRdy -
  125.  
  126.             Many mail utilities will send a message to the public port
  127.             "T:MailRdy" when new mail arrives.  If you wish to have Sabot
  128.             create a message port with this name, use the MailRdy switch.
  129.             When Sabot receives a signal at the T:MailRdy port, it will
  130.             change the icon to indicate that new mail has arrived.
  131.  
  132. Things you should know-
  133.  
  134.     I tried to make Sabot as small and simple as possible.  Sabot does
  135.     everything "by the book", or at least it tries to.
  136.  
  137.     Commands that Sabot executes are run asynchronously, so if you drag
  138.     100 icons onto Sabot's AppIcon, it will start 100 new processes.
  139.     That can make for a really slow system. ;-) Be careful, kids.
  140.  
  141.     Sabot tries to be intelligent with its icon switching, but there is
  142.     a limit.  If the mailbox file size grows by less than 130 bytes, Sabot
  143.     won't change the icon.  This is to allow for mail programs, such as
  144.     AmigaElm to add a few characters to the mail file, in order to mark
  145.     messages as old, answered, etc.  If you read your mailbox using
  146.     a program not started by Sabot, and you don't actually edit the file,
  147.     then Sabot cannot tell that you read it, and won't change the icon.
  148.  
  149.     AmigaElm, when writing back the mailbox, writes to a temp file, deletes the
  150.     original mailbox, then renames the temp file to the mailbox name.  This small
  151.     period when the mailbox is deleted causes some problems with Sabot. To eliminate
  152.     these problems Sabot is now optimized to work with AmigaElm, and knows to ignore
  153.     a non-existant file, but some mailers (dmail among them) would cause Sabot to
  154.     not go back to a NoMail state because of this.     So please specify the
  155.     "COUNTDELETE" flag when using a mailer such as dmail.
  156.  
  157.  
  158.  
  159. Suggested uses for Sabot -
  160.  
  161.     I suggest having Sabot set up in the following manner:
  162.  
  163.         ClickCommand runs your mailreader.
  164.         DropCommand runs sendmail, to your favorite person.
  165.         MailCommand plays a sample.
  166.  
  167.     I've found these settings to be most useful.
  168.  
  169. Thanks To -
  170.  
  171.     Michael B. Smith for lots of help with the code, and for sticking Sabot into
  172.     the InetUtils archives.
  173.  
  174.     Klaus Alexander Seistrup for lots of good ideas, and for the basis of the new
  175.     MagicWB icons included with Sabot.
  176.  
  177.     Colin Stuckless for filling in the 1/4 of the globe that was hidden in Klaus' icons.
  178.  
  179.     Kenneth Fribert for suggesting the OldMail idea first.
  180.  
  181.     Oleg Rovner    for making sure these docs are readable. ;-)
  182.  
  183.     Miscellaneous other people on IRC, who gave me ideas, and tidbits of code.
  184.  
  185. About the Author -
  186.  
  187.     The author is...
  188.  
  189.             Name:    Scott Ellis
  190.             E-mail:    sellis@ucssun1.sdsu.edu
  191.             Snail:    3640 Mt. Everest Blvd., San Diego, CA, 92111 (USA)
  192.  
  193.     Feel free to contact me if you have any problems or suggestions.
  194.  
  195.     P.S.    It's called "Sabot" because I really liked when Kim Catrall gave her little
  196.             speech about sabotage in Star Trek VI: The Undiscovered Country. ;-)
  197.  
  198. History -
  199.  
  200.     1.3    -    First Public Release with InetUtils V1.1
  201.  
  202.     1.4 -    Added MailRdy option.
  203.                 (Suggested by Michael B. Smith)
  204.  
  205.             Upped "ignored filesize change" to 200 bytes.
  206.  
  207.             Added icon positioning (XPos and YPos) option.
  208.                 (suggested by Klaus Alexander Seistrup)
  209.  
  210.             Removed redundant if(), and reorganized a bit of that code.
  211.  
  212.             Reorganized compare(), to reduce the number of icon image changes.
  213.  
  214.     1.5 -    Fixed silly bug where the "HaveMail" icon was updated, even if it was
  215.             already being shown.
  216.  
  217.     1.6    -    Reduced code size by changing linking with amiga.lib before sc.lib.
  218.  
  219.             Added "OldMail" icon.
  220.                 (suggested by Kenneth Fribert)
  221.  
  222.             Fixed bug where mailbox size wasn't getting set if the mailbox was deleted.
  223.  
  224.             Added "CountDelete" tooltype to help with deleted mailboxes.
  225.  
  226.     1.7    -    Sabot now shows "OldMail" if the mailbox is not empty when Sabot is started.
  227.             Thanks to the hordes of people who reported this "bug".  It was actually just
  228.             an oversight.
  229.  
  230.