home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / f / fdu_1c3.zip / FDU.DOC < prev    next >
Text File  |  1992-09-12  |  18KB  |  411 lines

  1.  
  2.                     ╒══════════════════════════════════╕
  3.                     │  FDU 1.00 - FrontDoor Utilities  │
  4.                     └──────────────────────────────────┘
  5.  
  6.  Fdu.Exe/Fdu.Doc written by geoffrey booher; 1:2270/233.1@fidonet
  7.  
  8. ┌─────────────┐
  9. │ disclaimer: │
  10. └─────────────┘
  11.  FDU 1.00 is  *ONLY*  guaranteed to consume diskspace.  It has been very
  12.  extensively  tested and  found  to be pretty  reliable.   In no way is the
  13.  author  of this  program responsible  for any  damages, consequential,  or
  14.  otherwise from the neglect of FDU 1.00's use or misuse.  FDU 1.00 is
  15.  provided as is, without warranty of any kind, either expressed or implied.
  16.  
  17.  FDU 1.00 is  NOT  Public Domain Software, it is Shareware.  It may be used
  18.  on any Computer with the following restrictions:
  19.  
  20.  1.  It may be evaluated for a period not exceeding 30 days at which time
  21.      you must register your copy or remove the software from your computer.
  22.      Please see the REGISTER.FDU file for details on how to register.
  23.  
  24.  2.  Any part of the FDU 1.00 files are NOT to be modified in *any* way.
  25.  
  26.  3.  The FDU Distribution Archive is NOT to be recompressed/reprocessed.
  27.  
  28.  4.  FDU 1.00 may NOT be utilized in any unlawful or illegal manner.
  29.  
  30.  5.  No Fees may be charged for FDU 1.00 - other than diskette cost.
  31.      FDU_100.ZIP may be put up for download on pay/subscription systems,
  32.      provided a fee is not charged for downloading FDU_100.ZIP itself.
  33.  
  34. ┌──────────┐
  35. │ support: │
  36. └──────────┘
  37.  Send Netmail to geoffrey booher, 1:2270/233.0@fidonet.  If you are expecting
  38.  a response, usually if you return poll me within 24 hours (nay weekends) and
  39.  I'll respond with a Netmail msg on HOLD for you.   This assumes you are in a
  40.  current *FIDONET* Nodelist.
  41.  
  42.  geoffrey booher - SysOp - The Gateway Net Bulletin Board System
  43.                            North American RemoteAccess Support
  44.                            RemoteAccess Beta Site
  45.                            FrontDoor Beta Site
  46.                            1:2270/233.0@fidonet
  47.                            (815)233-5008  1200/2400/9600/14400  HST/V32b/V42b
  48.                            Freeport, IL - USA
  49.  
  50.  You can contact me through the above Bulletin Board System.  Feel free to
  51.  send me your comments about FDU 1.00.
  52.  
  53.  If you aren't a multitasking FrontDoor BBS SysOp, you probably won't have
  54.  much of a use for FDU.
  55.  
  56.  :-)
  57.  
  58. ┌────────────────────────┐
  59. │ overview and features: │
  60. └────────────────────────┘
  61.  
  62.  FDU started out as most of my little programs, it was a series of small
  63.  utilities seperate.  I wrote an Fdrescan.Exe program that simply created/
  64.  touched the FDRESCAN.NOW and FMRESCAN.NOW files.  Then I wrote an Fdexit.Exe
  65.  program which created the FDEXIT.nnn file, then a Netmail renumber program,
  66.  etc.  Before I knew it, I had 5 programs all reading FD.SYS (now SETUP.FD)
  67.  all doing various things.  So ... one day I slapped them all together into
  68.  the first FDU version.  Then as FrontDoor got more functionality with
  69.  'semaphore' files - FDU was enhanced right along with it.
  70.  
  71.  As time passed - more feature requests by my select vigilant betatest team
  72.  were added.  Then FrontDoor 2.10/Commercial showed up at my door.  Along
  73.  with it - a whole new dimension in semaphore files dealing with 'TASK' and
  74.  freezing the mailer, et al.  FDU became a very powerful functional small
  75.  program.  And of course, support for RA's RAXITn.eee file was added along
  76.  with support for both FrontDoor 2.10/C and prior versions from 1.99c on up.
  77.  
  78.  FDU is a 'smart' program that will totally maintain ALL of FrontDoor's
  79.  'semaphore' files.  What is a semaphore file?  Well, if you don't run
  80.  DESQview or a LAN and use FrontDoor in a multitasking environment, they
  81.  really aren't much use to you.  Semaphore files are a way of "signaling"
  82.  a program that something is going on in the background, or specific actions
  83.  are needed.  For example, creating a FDRESCAN.NOW file will alert FrontDoor
  84.  to rescan the Netmail directory.  This is needed if you add new Netmail or
  85.  create file attaches in another window or 'task'.  FrontDoor constantly
  86.  looks for semaphore files while it is active, and responds accordingly.
  87.  In our example, FrontDoor 'checks' the FDRESCAN.NOW file (it actually checks
  88.  it's timestamp against when the dynamic packets in the temporary packets
  89.  directory were created).  If FDRESCAN.NOW is newer than the timestamp of
  90.  the temporary packets directory, the Netmail folder is rescanned, and any
  91.  "new" messages are bundled into packets.
  92.  
  93.  Why use FDU?  True, semaphore files can be created with a REM >SEMA.FIL
  94.  statement to create a 0 byte SEMA.FIL file.  One of the principle reasons
  95.  I wrote FDU is that with some versions of DESQview, the REM was NOT 100%
  96.  reliable, and would occasionally 'hang' a window - not desired whatsoever!
  97.  Besides - FDU is 100% more relaible and is also 'TASK aware', an important
  98.  factor if you are running FrontDoor 2.10/Commercial.  FDU is very fast, and
  99.  also supports removal of these files, along with being very FrontDoor/
  100.  RemoteAccess 'smart' as well as respecting the 'rules' of what can happen.
  101.  
  102.  And lastly - FDU will remove MANY lines of code in your batchfiles!
  103.  
  104.  
  105. ┌───────────────┐
  106. │ installation: │
  107. └───────────────┘
  108.  Put the FDU.EXE file anywhere in your DOS PATH, along with any of your other
  109.  favorite program utilities.  See your DOS manual about the PATH Statement if
  110.  needed.  It will function perfectly in this manner, and does not need to be
  111.  in a 'specific' directory, AS LONG as it is IN the DOS PATH that is fine.
  112.  
  113.  requirements:
  114.  
  115.  FDU requires the following to run:
  116.  
  117.  PC/MSDOS 3.10 or newer
  118.  A working FrontDoor installation to be of any use at all
  119.  
  120.  The FD environment variable MUST be set!  This is usually done in your
  121.  Autoexec.Bat file, and sometimes modified in batchfiles to point to a
  122.  different SETUP.FD file.  example:
  123.  
  124.  SET FD=C:\FD   (note no spaces before or after the = sign)
  125.  
  126.  This tells FDU to read the SETUP.FD in the C:\FD directory to act on that
  127.  configuration.  Changing the FD environment variable to 'point' to another
  128.  location to suit your needs is perfectly valid.  example, SET FD=C:\FD\LINE2
  129.  will tell FDU to read the SETUP.FD in the C:\FD\LINE2 directory and use it's
  130.  configuration.
  131.  
  132.  The FD environment variable is a REQUIREMENT, FDU will NOT run without it.
  133.  
  134.  The RA environment variable is required ONLY if you wish to use the RAXIT
  135.  option (/Xnnn).  This tells FDU where to locate and read the RemoteAccess
  136.  configuration file CONFIG.RA.  Again, changing the RA environment variable
  137.  to suit your needs to 'point' to a different location is perfectly valid.
  138.  
  139.  
  140.  FDU gets information from the FD and optionally RA config files specifically:
  141.  
  142.  FrontDoor
  143.  System directory path location
  144.  Netmail directory path location
  145.  Temporary dynamic packets path location
  146.  Semaphore directory path location (valid ONLY for FD 2.10)
  147.  
  148.  Important Note!  If you are running FrontDoor 2.10 - you are strongly advised
  149.  to setup the semaphore path location in FDSETUP - most preferrably a RAMDISK
  150.  drive and directory.  I use D:\SEMA for mine.  THIS IS THE ONLY MANNER IN
  151.  WHICH FDU CAN TELL IF FD 2.10 IS BEING USED.  Otherwise if this is blank, it
  152.  assumes FD 2.02/NC and lower, which uses the system path location for its
  153.  semmaphore files and supports less semaphore files and a differing naming
  154.  convention for the FDEXIT routine.
  155.  
  156.  If the Semaphore directory path is used and FD 2.10 is then assumed, FDU will
  157.  use the TASK environment variable that is used extensively by FD 2.10/C.
  158.  See your FrontDoor documentation regarding the TASK environment variable and
  159.  it's use.  It will be "somewhat" covered in it's use with a description of
  160.  how to use it with FDU commands.
  161.  
  162.  RemoteAccess
  163.  System directory path location
  164.  Semaphore directory path location (defaults to System directory if blank)
  165.  
  166.  The TASK environment variable is also supported to determine the node number.
  167.  
  168. ┌───────────────┐
  169. │ command sets: │
  170. └───────────────┘
  171.  To get a list of the valid commands for FDU - just type FDU with no parameters
  172.  or FDU /? for the help screen.  ONLY the valid commands for your environment
  173.  will be shown.  In other words, SETUP.FD (CONFIG.RA) is read to determine this
  174.  first.  If you see things like TASK and RA options, then FDU has successfully
  175.  determined what is valid for your system.  ONLY concern yourself with what
  176.  applies to your particular system!  using FD 2.10 commands will basically be
  177.  ignored with a message stating so if they are not supported.
  178.  
  179. FDU 1.00 (X86)  Turbo(C++)                 FD 1.99c -> FD 2.02/NC Command Set
  180. by: geoffrey booher; 1:2270/233.1@fidonet.usa
  181. Copyright (c) 1991, 1992; boo software technologies
  182.  
  183. ■ DESQview 2.42 detected
  184.  
  185. ■ Usage: FDU [/Lnnn] - use alternate RA node number (default = 1)           +
  186.              [/R]    - renumber *.MSG Netmail messages
  187.              [/K]    - kill temporary dynamic packets
  188.              [/D]    - touch/create FDRESCAN.NOW
  189.              [/M]    - touch/create FMRESCAN.NOW
  190.              [/NS]   - touch/create FDNOSCAN.NOW
  191.              [/NU]   - touch/create FDNOUSER.NOW
  192.              [/NE]   - touch/create FDNOEXIT.NOW
  193.              [/I]    - display status information
  194.              [/C]    - remove FDNO????.NOW files
  195.              [/Ennn] - create FDEXIT.nnn
  196.              [/Xnnn] - create RAXIT1.nnn                                    +
  197.  
  198. + RemoteAccess BBS ONLY
  199.  
  200.  
  201. FDU 1.00 (X86)  Turbo(C++)                     FD 2.10/Commercial Command Set
  202. by: geoffrey booher; 1:2270/233.1@fidonet.usa
  203. Copyright (c) 1991, 1992; boo software technologies
  204.  
  205. ■ OS/2 2.00 DOS Mode detected
  206.  
  207. ■ TASK 1
  208.  
  209. ■ Usage: FDU [/Tnnn] - use alternate TASK number nnn
  210.              [/Lnnn] - use alternate RA node number (default = 1)           +
  211.              [/R]    - renumber *.MSG Netmail messages
  212.              [/K]    - kill temporary dynamic packets
  213.              [/D]    - touch/create FDRESCAN.NOW
  214.              [/M]    - touch/create FMRESCAN.NOW
  215.              [/Fnnn] - touch/create FDFREEZE.1, wait nnn for FDFROZEN.1
  216.              [/NC]   - touch/create FDNOCALL.1
  217.              [/NS]   - touch/create FDNOSCAN.NOW
  218.              [/NU]   - touch/create FDNOUSER.NOW
  219.              [/NE]   - touch/create FDNOEXIT.NOW
  220.              [/I]    - display status information
  221.              [/C]    - remove FDNO????.NOW, FDNOCALL.1, FDFREEZE.1 files
  222.              [/G]    - globally remove FDNO????.*, FDFREEZE.* files
  223.              [/Ennn] - create FDXIT1.nnn
  224.              [/Xnnn] - create RAXIT1.nnn                                    +
  225.  
  226. + RemoteAccess BBS ONLY
  227.  
  228. ┌───────────────────────────┐
  229. │ command set descriptions: │
  230. └───────────────────────────┘
  231.  
  232.  * /Tnnn  - nnn is a number between 0 and 255.  this tells FDU to act upon a
  233.             certain "TASK" number - overriding the current TASK setting.
  234.             FDU defaults to using the current TASK= setting, and uses TASK=0
  235.             if the TASK environment is not set (like FrontDoor).
  236.  
  237.  + /Lnnn  - nnn is a number between 1 and 250.  this tells FDU to act upon a
  238.             certain RemoteAccess node number.  FDU defaults to using node 1
  239.             if /L is not used and TASK=0 or TASK is not set, otherwise it also
  240.             uses and supports the current TASK= environment variable setting.
  241.  
  242.    /R     - renumbers *.MSG netmail and updates LASTREAD.  The /R parameter
  243.             will respect any FDINSESS.* semaphore present and not renumber the
  244.             netmail messages while FD is 'in mail session' for any TASK number.
  245.             If the netmail folder is renumbered, FDRESCAN.NOW and FMRESCAN.NOW
  246.             are created/touched.  /Renumber supports up to 2048 *.MSG files.
  247.  
  248.    /K     - kills FD's temporary dynamic packets directory.  it only removes
  249.             the *.PKT and *.FDC files - it will not remove any other files.
  250.             This creates/touches FDRESCAN.NOW if it finds and deletes any
  251.             temporary packets.  The /K parameter will respect any FDINSESS.*
  252.             semaphore present and will not kill temporary dynamic packets
  253.             while FD is 'in mail session' for any TASK number.  If the
  254.             temporary packets are deleted, FDRESCAN.NOW and FMRESCAN.NOW are
  255.             created/touched.
  256.  
  257.    /D     - touch/create FDRESCAN.NOW.
  258.  
  259.    /M     - touch/create FMRESCAN.NOW.
  260.  
  261.  * /Fnnn  - create FDFREEZE.t and wait for FD to create FDFROZEN.t before
  262.             continuing where TASK=t.  FDU will default to waiting up to 30
  263.             seconds and continue if no FDFROZEN.t file is found.  If you want
  264.             to change the wait, use /F60 to tell FDU to wait a minute, or
  265.             /F3600 to tell FDU to wait an hour before continuing.  It will
  266.             attempt to give up DV, WIN, OS/2 CPU time slices while waiting.
  267.  
  268.             NOTE:  If FDU does not find an FDREADY.t file, it *assumes* the
  269.                    mailer is DOWN and will NOT wait the time specified!
  270.  
  271.  * /NC    - create FDNOCALL.t where TASK=t.
  272.  
  273.    /NS    - create FDNOSCAN.NOW.
  274.  
  275.    /NU    - create FDNOUSER.NOW.
  276.  
  277.    /NE    - create FDNOEXIT.NOW.
  278.  
  279.    /I     - display status information, all active semaphore conditions.
  280.  
  281.    /C     - deletes FDNO????.NOW, FDNOCALL.t and FDFREEZE.t files where TASK=t.
  282.  
  283.  * /G     - globally clear all FDNO????.* and FDFREEZE.* files (all tasks).
  284.  
  285.  * /Ennn  - creates FDXITt.nnn where TASK=t and errorlevel to exit=nnn.
  286.  
  287.    /Ennn  - creates FDEXIT.nnn where errorlevel to exit=nnn.
  288.  
  289.  + /Xnnn  - creates RAXITt.nnn where TASK=t and errorlevel to exit=nnn.
  290.             If TASK not used, t defaults to 1 or /L value is used instead.
  291.  
  292. ┌──────────────────┐
  293. │ batchfile usage: │
  294. └──────────────────┘
  295.  
  296.  FDU's primary purpose is to be used in your Mailer/BBS batchfiles.  Below
  297.  are some examples showing it's use, flexibility and power:
  298.  
  299.  File request in a second window:
  300.  
  301.  Xr Get FILES 1:2270/868 /C
  302.  Fdu /D
  303.  
  304.  Using FM in a second window:
  305.  
  306.  @Echo OFF
  307.  rem * RunFm.Bat
  308.  Fdu /NE
  309.  Fm
  310.  If Exist C:\Ra\Msgbase\Echomail.Bbs TosScan Scan
  311.  Fdu /C /M /D
  312.  Exit
  313.  
  314.  Processing a Nodelist using Freeze Function:
  315.  
  316.  :MAIL
  317.   If Exist C:\Fd\File\Nodediff.A?? Call Nodediff
  318.  
  319.  @Echo OFF
  320.  rem * Nodediff.Bat
  321.  Fdu /T1 /F60
  322.  Fdu /T2 /F60
  323.  Fdu /T3 /F60
  324.  rem - FDU will wait the specified 60 seconds for each FDFROZEN.t file.
  325.  rem * process NODEDIFF here *
  326.  Fdu /G
  327.  
  328.  
  329. ┌──────────────────────────┐
  330. │ FDU 1.00 technical info: │
  331. └──────────────────────────┘
  332.  Fdu.Exe  was compiled with  Borland International's  Turbo(C++) 1.00
  333.  using the Small Memory Module (  < 64kb heap ) and the C++ (Fdu.Cpp)
  334.  option.  Fdu will run in less than 128kb RAM (64kb code - 64kb data).
  335.  
  336.  FDU 1.00  exits with the following errorlevels for trapping in *.BAT
  337.  files.  Although not really needed, they are there for batchfile gurus.
  338.  
  339.   errorlevel 7 - no parameters or /h help screen
  340.   errorlevel 6 - invalid parameters
  341.   errorlevel 5 - error renumbering netmail messages
  342.   errorlevel 4 - invalid directory pathname
  343.   errorlevel 3 - could not remove a file
  344.   errorlevel 2 - file i/o error
  345.   errorlevel 1 - missing FD environment variable/incorrect DOS version
  346.   errorlevel 0 - successful completion
  347.  
  348.  FDU 1.00 also writes error messages to a file called FDU_ERR.LOG.  This
  349.  file will be located in the FrontDoor system directory specified in FDSETUP
  350.  by default.   In the case that the error is a missing FD environment variable
  351.  or a missing/invalid SETUP.FD file, it will be written in the current
  352.  directory it was executed from.  FDU will also put the FDU_ERR.LOG in a
  353.  directory specified by the FDULOG environment variable overriding all of the
  354.  above actions.  SET FDULOG=D:\LOG will cause the FDU_ERR.LOG file to be
  355.  created/appended to in D:\LOG .  The error log is a more detailed report of
  356.  what went wrong when FDU generates an error, as well as having a record of
  357.  it since FDU screen displays often do not remain on the screen too long.
  358.  
  359.  Environment Variables Supported:
  360.  
  361.  FD      - location of SETUP.FD
  362.  RA      - location of CONFIG.RA
  363.  TASK    - current TASK number (defualt)
  364.  FDULOG  - alternate location of FDU_ERR.LOG file
  365.  
  366.  All program parameters are case INsensitive.  all semaphore files created
  367.  are 0 bytes in size.  Parameters can be entered in ANY order, the NO functions
  368.  and clear functions take priority (done LAST) in the order in which executed.
  369.  
  370.  
  371. ┌─────────┐
  372. │ thanks: │
  373. └─────────┘
  374.  Thanks to my vigilant select group of betatesters - who helped with FDU
  375.  testing as well as providing me with many excellent suggestions:
  376.  
  377.  Kevin Zimmerman, The Boomtown BBS (1:2270/868)
  378.  Sandy Theriault, sandy's office (1:2270/233.2)
  379.  David Gibbs, The Midrange System (1:115/439)
  380.  Kelly Griffin, 7th Inning Stretch! (1:170/900)
  381.  Rocky Simler, The Black Star BBS (1:2270/443)
  382.  Bruce Bodger, The Truckstop BBS (1:170/400)
  383.  Jay Desio, Network Communications (1:107/574)
  384.  Bob R., The Anonymous BBS (1:154/40)
  385.  
  386.  Thanks to Joaquim Homrighausen for his excellent FrontDoor product
  387.  Thanks to Andrew Milner for the best BBS software in the world, RemoteAccess
  388.  Thanks to Jay Desio for his *excellent* semaphore knowledge!
  389.  Thanks to Sandy for always being an inspiration no matter what.
  390.  Thanks to James Smith and Bruce Bodger for letting me test their stuff and
  391.  be a part of Online Communications.  :-)
  392.  
  393.  The following products/examples are the Copyrighted materials of their
  394.  respective named holders:
  395.  
  396.  FDU                        boo software development team
  397.  
  398.  FrontDoor                  joaquim homrighausen - Advanced Engineering sarl
  399.  RemoteAccess               andrew milner - Continental Software
  400.  
  401.  Turbo(C++) 1.00            Borland International
  402.  DESQview                   QuarterDeck Office Systems
  403.  OS/2                       International Business Machines Corporation
  404.  Windows                    Microsoft Corporation
  405.  PC/MSDOS                   International Business Machines and Microsoft
  406.  
  407.  Fidonet                    Tom Jennings
  408.  
  409.  
  410.  
  411.