home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / disk / watch-1.0.lha / Watch / Watch.doc < prev    next >
Text File  |  1994-12-06  |  5KB  |  134 lines
  1.  
  2.   INTRODUCTION
  3.  
  4.     First, excuse my English, as it is not my native language.
  5.  
  6.     Notification is a feature of AmigaDOS 2.0+ which allows programs
  7.     to be notified in case a file or directory changes.
  8.  
  9.     Watch lets you specify files and directories to be watched, and
  10.     automatically run commands if the file/dir is changed.
  11.  
  12.     Not all filesystems will support this feature, (CrossDOS for one)
  13.     in particular most network filesystems won't support it.
  14.  
  15.   REQUIREMENTS
  16.  
  17.     At least AmigaDOS 2.0 (V36)
  18.  
  19.   USE
  20.  
  21.     In order for Watch to work, a background process, called Watcher,
  22.     must be installed.
  23.     You can start Watcher from the shell whenever you want, or just
  24.     add it to your startup-sequence or user-startup.
  25.  
  26.     Template: WATCHER QUIET/S
  27.  
  28.     The QUIET switch suppresses output of a banner and a diagnostic
  29.     message.
  30.     There will still be output when something went wrong while parsing
  31.     the arguments or you're trying to use it on a pre-2.0 machine.
  32.  
  33.     There's no need to RUN Watcher, it detaches itself from the shell
  34.     it started from, so the shell can close.
  35.  
  36.     When Watcher was succesfully installed, and you run it for the
  37.     second time, the process will be removed.
  38.  
  39.     Notes: * Use it from Workbench with an icon and visit the Guru.
  40.            * Don't try 'Watcher ?' or redirecting the output, the I/O
  41.              channels for this to work aren't there.
  42.  
  43.     Watch is a normal shell command, and is pure so it can be made
  44.     resident.
  45.  
  46.     Template: WATCH FILEDIR,COMMAND,REMOVE/S,RESET/S
  47.  
  48.     FILEDIR is a file or directory.
  49.     COMMAND is the command to run upon notification.
  50.      REMOVE allows you to remove an entry.
  51.       RESET allows you to remove all entries. When this switch is
  52.             present, all other arguments are ignored.
  53.  
  54.     Examples: Watch                             - lists all entries
  55.               Watch RAM: "LIST >T:Listing RAM:" - adds this entry, or
  56.                                                   if it existed,
  57.                                                   replaces the command.
  58.               Watch RAM:                        - lists the RAM: entry
  59.               Watch RAM: REMOVE                 - removes the RAM: entry
  60.               Watch RESET                       - removes all entries
  61.  
  62.     Notes: * FILEDIR and COMMAND are relative to the directory the
  63.              shell was in when the Watcher process was installed.
  64.              So it is best to use absolute paths for FILEDIR and
  65.              COMMAND, unless you know what you are doing.
  66.              For example, if the current directory when you installed
  67.              Watcher was SYS:Tools, and you add an entry like this:
  68.              Watch File "LIST >Listing", AmigaDOS actually watches
  69.              SYS:Tools/File and the contents of the SYS:Tools directory
  70.              will go to SYS:Tools/Listing...
  71.            * In case of a file, notification happens when:
  72.              - the file is created
  73.              - the file is changed
  74.              - the file is renamed
  75.              - the file is deleted
  76.              In case of a directory, notification happens when:
  77.              - the directory is created
  78.              - the directory is renamed
  79.              - the directory is deleted
  80.              - a file in the directory is created
  81.              - a file in the directory is changed
  82.              - a subdirectory is created
  83.            * Watch out for 'loops'. For example, if you have two
  84.              entries like this:
  85.  
  86.              RAM:File.X = "Rename RAM:File.X RAM:File.Y"
  87.              RAM:File.Y = "Rename RAM:File.Y RAM:File.X"
  88.  
  89.              When File.X is changed, its command will cause notification
  90.              and the command for File.Y will be executed. This in turn
  91.              causes notification and the command for File.X will be
  92.              executed, and so on.
  93.            * When executing commands upon notification, the output
  94.              normally will be sent to limbo. If you need the output,
  95.              use redirection to send the output of a command to a file
  96.              or device.
  97.  
  98.   TODO
  99.  
  100.     - Integrate Watcher and Watch into one single command.
  101.     - Remove the 255-character limit for FILEDIR and COMMAND.
  102.     - Improve internal communications. For example, if one shell is busy
  103.       listing the entries, another Watch command running in another
  104.       shell has to wait.
  105.     - Improved output. Maybe a 'notification count'?
  106.     - Anything you suggest.
  107.  
  108.   STATUS
  109.  
  110.     Watcher and Watch are Freeware.
  111.  
  112.   DISCLAIMER
  113.  
  114.     Watcher and Watch are provided "as-is" and subject to change; no
  115.     warranties are made. All use is at your own risk. No liability or
  116.     responsibility is assumed.
  117.  
  118.   COPYRIGHT
  119.  
  120.     Watcher and Watch are Copyright © 1994 by Ludo Dyzers.
  121.  
  122.     Suggestions, bug reports and friendly messages are welcome at:
  123.  
  124.     SnailMail: Ludo Dyzers
  125.                Broekhoven 18
  126.                2200 Morkhoven (Herentals)
  127.                Belgium
  128.  
  129.     or
  130.  
  131.     EMail: 2:292/603  (FidoNet)
  132.  
  133.   THAT'S IT
  134.