home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FAKEFD.ZIP / FAKEFD.DOC < prev    next >
Encoding:
Text File  |  1995-04-16  |  8.5 KB  |  242 lines
  1. FakeFD // Absolute Solutions
  2. ----------------------------
  3.  
  4.     Copyright 1992-1994 Mats Wallin; All rights reserved
  5.  
  6.     Introduction
  7.     ------------
  8.  
  9.         FakeFD is a small program, that can be used for tossing mail
  10.     in the background, running events, and doing other automated
  11.     things. 
  12.  
  13.     FakeFD supports X-events in a FrontDoor event file, which can
  14.     be used to run certain things automatically at certain time of
  15.     days.
  16.  
  17.     FakeFD also supports the standard FXIT<task>.* semaphores, and
  18.     if it detects one (with it's TASK number), it exits with the
  19.     specified errorlevel.
  20.  
  21.     FakeFD also supports any number of other (semaphore) files,
  22.     that can trigger exits, or prevent FakeFD from exiting.
  23.  
  24.  
  25.     FrontDoor shareware version
  26.     ---------------------------
  27.  
  28.         FakeFD was initially designed to be used with FrontDoor
  29.     MultiLine, but it is possible to use it with the shareware
  30.     version also. 
  31.  
  32.     It is recommend, but not necessary, to use the TASK
  33.     environment variable when running FakeFD. By doing this, you
  34.     can have your own event file for FakeFD. Just create a event
  35.     file as usual in FDSETUP, and then rename it EVENTn.FD, where
  36.     n is the task number. If this file doesn't exist, FakeFD will
  37.     use EVENT.FD instead.
  38.  
  39.     The FDXIT<task>.* semaphore also acts a little bit different
  40.     than FrontDoor shareware does. FakeFD will not use FDXIT.*, it
  41.     does require a task number in the filename. If TASK isn't
  42.     defined, FDXIT0.* will be used.
  43.  
  44.     To set the TASK environment variable, just use 'SET TASK=n'
  45.     where n is the task number you would like to use.
  46.  
  47.     For the shareware version, the FrontDoor semaphore directory
  48.     is the same directory as the system directory.    
  49.  
  50.  
  51.     Keyboard commands
  52.     -----------------
  53.  
  54.         There are a few predefined keyboard commands that FakeFD
  55.     understand, and they try to use the same key combinations as
  56.     FrontDoor does. The following predefined keys exists:
  57.  
  58.     Alt-K      Display list of user defined keys
  59.     Alt-Q      Exit FakeFD (with errorlevel 10)
  60.     Alt-Z      DOS shell
  61.  
  62.  
  63.     Configuration file
  64.     ------------------
  65.  
  66.         FakeFD also has its own configuration file, where you can
  67.     define what the different keys should do, and other semaphore
  68.     files that FakeFD should look for, and use.
  69.  
  70.     Each line in the configuration file contains a definition for
  71.     FakeFD, and there is two types of definitions; keys and
  72.     semaphore files.
  73.  
  74.     The configuration file can contain comments, which should
  75.     start with a ; character, and blank lines. If a space is
  76.     needed in the middle of a parameter, or if the case of the
  77.     text is important, surround the parameter with " characters.
  78.  
  79.     
  80.     Key definitions
  81.     ---------------
  82.  
  83.         To define what a key should do, when it is pressed, use the
  84.     /key setting in the configuration file. The format of this
  85.     definition is:
  86.  
  87.     /KEY=<key> /SCAN=<scan> /ERRORLEVEL=<err> /DESCRIPTION=<text>
  88.  
  89.     where:
  90.  
  91.     <key> is the name of the key, and you can enter any text you
  92.     would like here, but I do suggest something useful. <key> is
  93.     displayed together with <text> when you press Alt-K to display
  94.     a list of all user defined keys.
  95.  
  96.     <scan> is the scan code this key generates (in hex). It is
  97.     actually this code that FakeFD uses to determine which key you
  98.     pressed. If you don't know the scan code for a key you would
  99.     like to use, just run FakeFD, and press it. FakeFD will always
  100.     display the scan code for a key, if the key hasn't been
  101.     defined.
  102.  
  103.     <err> is the errorlevel FakeFD should exit with, when you
  104.     press this key. Your .BAT file can then determine which key
  105.     you pressed, and do whatever you would like.
  106.  
  107.     <text> is a description of what the key does, and is displayed
  108.     when you press Alt-K, together with <key>.
  109.  
  110.     A few examples of key definitions:
  111.  
  112.     /KEY=F1         /SCAN=3B00 /ERRORLEVEL=200 /DESCRIPTION="Scan"
  113.     /KEY=F2         /SCAN=3C00 /ERRORLEVEL=201 /DESCRIPTION="Toss"
  114.     /KEY=F4         /SCAN=3E00 /ERRORLEVEL=100 /DESCRIPTION="RemoteAccess"
  115.     /KEY=F12        /SCAN=8600 /ERRORLEVEL=255 /DESCRIPTION="Restart"
  116.     /KEY="Shift F2" /SCAN=5500 /ERRORLEVEL=203 /DESCRIPTION="Comp nodelist"
  117.  
  118.     /key, /scan and /errorlevel is required for this type of
  119.     definition. 
  120.  
  121.  
  122.     Semaphore definitions
  123.     ---------------------
  124.  
  125.         You can also define different files that FakeFD should look
  126.     for, and when it finds the file, exit with a certain
  127.     errorlevel, wich either can be set in the configuration file,
  128.     or retrieved from the extension of the filename.
  129.  
  130.     The format of a semaphore definition is:
  131.  
  132.     /SEMAPHORE=<sem> /IFNOTEXIST=<file> /DELETESEMAPHORE
  133.     /ERRORLEVEL=<err> /SINCETIME=<secs> /WAITTIME=<wait>
  134.  
  135.     where:
  136.  
  137.     <sem> is the name of the semaphore file to wait for. The
  138.     filename can contain a complete path and wildcards. If only
  139.     the filename is specified, FakeFD checks for this file in the
  140.     FrontDoor semaphore directory.
  141.  
  142.     <file> is the name of a file that may not exist. While it does
  143.     exist, FakeFD will ignore the <sem> file specified in this
  144.     definition. The filename can contain a complete path and
  145.     wildcards. If only the filename is specified, FakeFD checks
  146.     for this file in the FrontDoor semaphore directory.
  147.  
  148.     <err> is the errorlevel FakeFD should exit with, when the
  149.     semaphore file is found, and all the other definitions are
  150.     fulfilled. If <err> is not defined, FakeFD will use the
  151.     extension of the semaphore file as the errorlevel.
  152.  
  153.     <secs> is the number of seconds that FakeFD waits before exiting,
  154.     from the time the semaphore file was created.
  155.  
  156.     <wait> is the number of seconds that FakeFD waits before
  157.     exiting, from the time FakeFD detects the semaphore file. If
  158.     FakeFD exits before this number of seconds has passed, FakeFD
  159.     will wait this number of seconds again, when it restarts.
  160.     
  161.  
  162.     If the /SINCETIME or /WAITTIME parameters are used together
  163.     with the /IFNOTEXIST parameter, /IFNOTEXIST will only prevent
  164.     FakeFD to detect the semaphore file. When FakeFD once has
  165.     detected the semaphore file, it will not check for the
  166.     /IFNOTEXIST semahore file again.
  167.  
  168.     If the /DELETESEMAPHORE parameter is specified, FakeFD will
  169.     delete the semaphore file when it exits with the specified
  170.     errorlevel.
  171.  
  172.     A few examples of semaphore definitions (all examples below
  173.     should be specified on one line in the configuration file):
  174.  
  175.     /SEMAPHORE=WAITEXIT.* /SINCETIME=300 /DELETESEMAPHORE
  176.  
  177.     This definition specifies that FakeFD should look for the file
  178.     WAITEXIT.* in FrontDoor's semaphore directory. When it finds a
  179.     file matching this filename, it will exit 300 seconds (5
  180.     minutes) after the files creation time, and the file will be
  181.     deleted when FakeFD exits. The errorlevel FakeFD exits with is
  182.     taken from the extension of the file.
  183.  
  184.     /SEMAPHORE=RUNPING.NOW /IFNOTEXIST=FDINSESS.* /ERRORLEVEL=202 
  185.     /DELETESEMAPHORE
  186.  
  187.     This definition specifies that FakeFD should exit with
  188.     errorlevel 202, if the semaphore RUNPING.NOW exits, but
  189.     FDINSESS.* does not exist. This can be used to force FakeFD to
  190.     wait for FrontDoor to complete a sessoin before exiting to do
  191.     something. When FakeFD exits, the RUNPING.NOW semaphore will
  192.     be deleted.
  193.  
  194.     /SEMAPHORE=O:\FIDO\*.PKT /WAITTIME=300 /ERRORLEVEL=201
  195.  
  196.     This definition specifies that FakeFD should exit with
  197.     errorlevel 201, 300 seconds (5 minutes) after it finds a .PKT
  198.     file in the O:\FIDO directory. The .PKT file will not be
  199.     deleted when FakeFD exits.
  200.  
  201.  
  202.     /semaphore is required for this type of definition.
  203.  
  204.  
  205.     Legal notice
  206.     ------------
  207.  
  208.         FAKEFD is provided to you as is, without warranty of any
  209.         kind. In no event shall Mats Wallin be liable to you or
  210.         anyone else for any damages or costs arising from the use
  211.         or inability to use this program.
  212.  
  213.         FAKEFD is protected by copyright laws, and may not be 
  214.         modified, reversed engineered, sold or distributed in any
  215.         way that would involve some sort of trade, without written
  216.         permission from Mats Wallin.
  217.  
  218.         FrontDoor is a registered trademark of Joaquim Homrighausen.
  219.  
  220.         All other brand or product names are trademarks or registered
  221.         trademarks of their respective holder.
  222.  
  223.  
  224.     Registering
  225.     -----------
  226.  
  227.         FAKEFD can be used free of charge, for as long as you would 
  228.     like.
  229.  
  230.     If you find FAKEFD valueable, I would appreciate a message
  231.     from you.
  232.  
  233.  
  234.     Bug reports, suggestions, etc.
  235.     ------------------------------
  236.  
  237.         If you find any bugs, or have suggestions or comments on 
  238.         this program, I would appreciate if you would let me know.
  239.         Send the information to me at:
  240.  
  241.         2:270/19@fidonet       or      mw@abslu
  242.