home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / ho51.zip / HO51.ZIP / gather.doc < prev    next >
Text File  |  1994-06-17  |  22KB  |  572 lines
  1.  
  2.  
  3.                      The GATHER.DOC           Page 1
  4.  
  5.  
  6.  
  7.  
  8.                      Version 2.5      June, 1994
  9.  
  10.  
  11.                              _______
  12.                         ____|__     |               (R)
  13.                      --|       |    |-------------------
  14.                        |   ____|__  |  Association of
  15.                        |  |       |_|  Shareware
  16.                        |__|   o   |    Professionals
  17.                      -----|   |   |---------------------
  18.                           |___|___|    Member
  19.  
  20.  
  21.  
  22.  
  23.           Gather gathers specified files from specified directories and
  24.           copies, or moves, them to a destination directory.  This
  25.           allows one to collect copies of crucial files, such as the
  26.           AUTOEXEC.BAT, or database files, into a central directory for
  27.           transfer to another computer as a backup and for ongoing
  28.           remote maintenance and diagnosis.  You can also use gather as
  29.           a form of ongoing BACKUP, MOVE, or ERASE program by running it
  30.           as a TSR or resident program.  When run as a TSR you can
  31.           direct GATHER to periodically gather files as specified in a
  32.           response file, or on the command line, to a specified
  33.           directory and/or a diskette.  You may discover that gather
  34.           occupies too much ram to be generally kept resident.  If so,
  35.           consider periodically using it in a batch file instead, you
  36.           should find that it is MUCH faster than other software that
  37.           you use for similar purposes.  Gather is command line
  38.           oriented, but the TeleShare remote menu program provides a
  39.           mousy menuing (SAA/CUA if you prefer) alternate interface.  If
  40.           you use the resident or tsr option with the remote menu
  41.           program, you can be in a very large program like dBASE IV and
  42.           the menu program will swap dBASE out of RAM and swap itself in
  43.           when you use its hotkey.  See the TELEMENU.DOC for information
  44.           on the remote menu programs.
  45.  
  46.           Please also note that gather is designed so it CAN copy files
  47.           over themselves, which effectively destroys them.  If you wish
  48.           to avoid destroying files, do not copy them over themselves.
  49.           Please note that you can use the Query switch to make gather
  50.           ask before it acts.
  51.  
  52.  
  53.           The Gather command line:
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                      The GATHER.DOC           Page 2
  61.  
  62.  
  63.  
  64.           Usage  gather  -time -show -clock -tsr @name -fname -d\A_DIR\ ...
  65.  
  66.           -clock      for the on screen clock.
  67.           -days10     the number of days to the oldest file to gather.
  68.           -d\DIR\     the destination directory.
  69.           -erase      to change the copy to an Erase command.
  70.           -fname      to Copy the named file.  You may use * as in *.dbf.
  71.           -h          this help.
  72.           -move       to change the copy to a Move command.
  73.           -n          reName copied files.  A number is inserted into the name.
  74.           -path       to search along the PATH for one or more files.
  75.           -q          to add a query, or ask for OK message.  -q- off.
  76.           -redir      use DOS screen output to allow file redirection.
  77.           -scatter    to reinstall a list of files, used with @filelist.
  78.           -show       to show filenames as they are copied.
  79.           -time60     the repeat or delay time between file copying.
  80.           -tsr        to run as a TSR or resident program.
  81.           -unload     to unload the TSR from ram.
  82.           [S] [R]     Send or Receive files by serial connection.
  83.           @some_file  to use a response file listing the files to copy.
  84.  
  85.           If there is 'extra' material left on the command line after
  86.           the above checks, gather tries to use it as a destination directory.
  87.           You can use "GATHER @FILELIST C:\SOMEDIR\", which is what other
  88.           TeleShare tools do.
  89.  
  90.           You may also use / as the switch character instead of -.
  91.  
  92.  
  93.  
  94.           These switches are explained further below:
  95.  
  96.           -DAYS10 the number of days to the oldest file to gather.  If a
  97.           file was last changed 9 days ago, and gather is run with
  98.           -DAYS10, the file will be gathered.
  99.  
  100.           -D\dir\ the destination directory.  This tells gather to copy
  101.           the file(s) to that directory.  Its a good idea to include the
  102.           drive as in -dD:\TRANSFER\.  It will yell and quit if the
  103.           destination directory does not exist.  It will also yell if
  104.           the destination file is write protected, hidden, or a system
  105.           file.  Also, if there is 'extra' material left on the command
  106.           line after checking for other switches, it will be checked for
  107.           a destination directory.
  108.  
  109.           -Fname to copy the named file.  You may use * as in *.dbf.
  110.           Use this to copy a specific file, such as -fADDRESS.DBF, or a
  111.           group of files, as in -f*.DBF.  Use the @response_file method
  112.  
  113.  
  114.  
  115.  
  116.  
  117.                      The GATHER.DOC           Page 3
  118.  
  119.  
  120.  
  121.           when you want to gather more files or be more specific.  If
  122.           the source file does not exist, gather will silently continue
  123.           to the next file.
  124.  
  125.           -H this help. You may also use /H -?  and ?, or even a blank
  126.           command line.
  127.  
  128.           -N to reName copied files to minimise overwriting previous
  129.           copies.  The renaming inserts a number into the file name,
  130.           with consecutive files having a consecutive number inserted.
  131.           The seed number is based on the current second at the time of
  132.           the start of the copying.  Files ROSTER, SALARY.DBF, and
  133.           WORKS.WKS will be renamed to ROSTER.20, SALARY21.DBF, and
  134.           WORKS22.WKS if copying starts at 11:30:20.  If LASTNAME.DBF
  135.           was the 180th file copied, it would become LASTN200.DBF, since
  136.           20+180 = 200.  Numbers above 999 restart at 0.  Using this
  137.           scheme might appear attractive but it can consume disk space
  138.           rapidly.
  139.  
  140.           -PATH to search along the PATH for one or more files.  This
  141.           instruction tells gather to look through every directory along
  142.           your machine's current path for the file(s).  Some uses of
  143.           this switch are incompatible with other switches, with the
  144.           idea that if you use *.* or the like, then you do not really
  145.           mean to copy every file along the path to the destination
  146.           directory.
  147.  
  148.           -REDIR DOS screen display, to allow redirection to a file.  If
  149.           you are also using -clock, the clock will continue to write
  150.           using the bios, with the program dynamically changing screen
  151.           drivers back to dos after each time update.  A side effect of
  152.           this setting may be a change in gather colours.  The default
  153.           is to use bios output.
  154.  
  155.           -SCATTER can be considered a form of uninstall, reinstall, or
  156.           install.  For example, you might GATHER the AUTOEXEC.BAT,
  157.           CONFIG.SYS, and all the various .INI files in a computer to
  158.           one directory before installing some trial software.  The
  159.           trial software might alter one or more files, but -SCATTER can
  160.           be used to replace the original files.  Gather uses a
  161.           @response_file that indicates the file's original drive and
  162.           directory with the SCATTER command.  Such a file is easily
  163.           created with DIRDBF (as in DIRDBF -path -xf *.ini for .ini
  164.           files) or with your text editor.
  165.  
  166.           -SHOW to show filenames as they are copied.  The source and
  167.           destination directories are included.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.                      The GATHER.DOC           Page 4
  175.  
  176.  
  177.  
  178.           -TIME15 the repeat or delay time between file copying.  The
  179.           default is 60, with an allowable range between 10 and 100000
  180.           seconds.  This value is the 'sleep' time for gather when it is
  181.           running as a TSR, and is the file update time when gather does
  182.           short term file copies.  Use -time60 to force gather to copy
  183.           files that have been updated in the past 60 seconds.  Note
  184.           that this is the actual tsr sleep time, it only becomes active
  185.           at the given intervals, and only for the length of time
  186.           necessary to do the given task.  If you want a longer time,
  187.           yell with an explanation, its easy to change.  You might also
  188.           consider using the @response_file method.
  189.  
  190.           -TSR to run as a TSR or resident program.  Gather takes about
  191.           100K when running as a TSR.  It is designed for speed, and
  192.           interactive use more than as a background backup program.
  193.           Gather is also designed to be very quickly and easily changed
  194.           for custom purposes.
  195.  
  196.           -UNLOAD to unload the TSR from ram.  Eg:  gather -unload
  197.  
  198.           [S] [R] to Send or Receive files by serial connection.  Gather
  199.           works with external file transfer tools.  It uses the
  200.           [transfer] section in the TELE.INI configuration file,
  201.           described below, to discover which tool to use and how to use
  202.           it.  The default Teleshare tool is XM, for xmodem 1k, which is
  203.           part of the TeleShare remote support package.  The default
  204.           HANDS ON remote access tool is the OMNI protocol, (OMI.EXE,
  205.           OMIPUT.EXE, and OMIGET.EXE) which is about as fast as zmodem,
  206.           and is quite portable.  For Teleshare, an easily used faster
  207.           protocol is hydracom, which is about as fast as DSZ zmodem,
  208.           and adds some other features as described in its
  209.           hydracom.doc.  XM is used by default because it is very
  210.           convenient, it automatically reads the TeleShare setup
  211.           information from RAM memory.  Hydracom, PCZ, Jmodem, and so
  212.           on, need more setup information.  XM, Hydracom, and the HANDS
  213.           ON OMNI protocol, accept response files, as described
  214.           immediately below.
  215.  
  216.  
  217.           @some_file to use a response file, or control file, listing
  218.           the files to copy.  You simply list the files to be copied as
  219.           a list in the given text file.  A sample that includes the
  220.           autoexec.bat, config.sys and equip.log follows (equip.log is
  221.           generally used to store information about your machine, often
  222.           to be send to another machine).
  223.  
  224.           AUTOEXEC.BAT
  225.           CONFIG.SYS
  226.  
  227.  
  228.  
  229.  
  230.  
  231.                      The GATHER.DOC           Page 5
  232.  
  233.  
  234.  
  235.           EQUIP.LOG
  236.  
  237.  
  238.           The following sample adds other commands [Copy Move Erase],
  239.           and comments.  They are generally used to change the copy
  240.           command to a Move or Erase command, or to reverse the change.
  241.           Both Copy and Move should have a destination directory on the
  242.           same command line.
  243.  
  244.  
  245.           ; comments start with ; or optionally #.
  246.           ; The ; follow the .INI file comment standard.
  247.           ; The first command is to copy EQUIP.LOG to C:\BACKUP\
  248.           [Copy C:\BACKUP\]
  249.           EQUIP.LOG
  250.           ; The NAMES and ADDRESS databases will be moved to
  251.           ; D:\STORAGE\
  252.           [MOVE D:\STORAGE\]
  253.           NAMES.DBF
  254.           ADDRESS.DBF
  255.           ; next some old and backup (BAK) files will be erased
  256.           [ERASE]
  257.           oldfile
  258.           letter.bak
  259.           oldfile2
  260.           \OTHER\*.BAK ; erase all the .BAK files in \OTHER\
  261.           [transfer]
  262.           c:\send\*.lzh  ; send all the lha archive files
  263.  
  264.           Please note that most programs that use response files will
  265.           not accept the additional features such as ";" and "[any]".
  266.           For example hydracom expects a simple file listing like that
  267.           produced by some filefinder tools such as dirdbf.  It also
  268.           accepts its own additional commands that add nice features
  269.           during file transfers.  The hydracom.doc file describes its
  270.           response files, which it calls control files.
  271.  
  272.           The DIRDBF tool can be used to create appropriate response
  273.           files listing the files in the current directory.  Use DIRDBF
  274.           to create a FILELIST file.  Run "DIRDBF -h" to get an idea how
  275.           it works.
  276.  
  277.  
  278.  
  279.           The TELE.INI configuration file
  280.  
  281.           The TELE.INI configuration file is designed to be used by some
  282.           TELEshare tools.  Gather uses the [TRANSFER] section which
  283.  
  284.  
  285.  
  286.  
  287.  
  288.                      The GATHER.DOC           Page 6
  289.  
  290.  
  291.  
  292.           will have a structure something like the following:
  293.  
  294.           [TRANSFER]
  295.           send=XM S %1  ; xm is the default, but you can change it.
  296.                   ; %1 locates the filename(s) to be transferred.
  297.                   ; Change it to OMI for the OMNI protocol, or hydracom
  298.                   ; or DSZ for Omen's zmodem package.
  299.           receive=XM R  ; use none to disallow file transfers
  300.           feed=no       ; yes would feed response file lines one at a
  301.                         ; time to the 'send' file transfer tool
  302.           copy=yes      ; could be none or no
  303.           move=yes
  304.           erase=yes
  305.           query=yes
  306.  
  307.           All of the commands are considered to be insensitive to case.
  308.           You can use either capitals or lowercase, unless you change
  309.           the file transfer tool to another tool that expects only one
  310.           case.
  311.  
  312.           The program after 'send=' is the file transfer tool and
  313.           protocol for sending.
  314.  
  315.           The program after 'receive=' is the setup for receiving over
  316.           the 'phone line.
  317.  
  318.           Feed indicates whether gather should feed the transfer
  319.           instructions to the file transfer tool one line at a time, or
  320.           just give it the whole file to use, as a response or control
  321.           file.  Both XM and hydracom can take the entire file if you do
  322.           not mix copy, move, or erase commands into the file.  OMNI, or
  323.           omi.exe/omiput.exe, works the same way.  Generally, its a good
  324.           idea to set feed=no or feed=none for XM, because it also knows
  325.           how to ignore copy/move/erase commands that it finds in
  326.           files.  Do the same for hydracom and other transfer software
  327.           if you know that the input file has no problem causing
  328.           commands in it.
  329.  
  330.           Copy, move, and erase are for normal same machine file
  331.           copying, moving, and erasing.
  332.  
  333.           Query is the file query switch.  Adding it on the command line
  334.           will tell gather to ask you before copying/moving/erasing.  If
  335.           you set "query=none", this will turn-off the the command line
  336.           "-Q" command globally.  Use -Q- to deliberately turn it off.
  337.           The January, 1994 Gather has query defaulting to on.  Earlier
  338.           versions defaulted to off.
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.                      The GATHER.DOC           Page 7
  346.  
  347.  
  348.  
  349.           These switches are global in that they 'overpower' any command
  350.           line commands that you might use, as a form of security.  They
  351.           allow you to setup gather to restrict file
  352.           copying/moving/erasing/transfer both by itself and while using
  353.           TeleShare.
  354.  
  355.  
  356.  
  357.           Other checks:
  358.  
  359.           This version of gather does disk space checking, but does not
  360.           check the destination for sufficient space to copy a file.  It
  361.           uses a 'fast write' to the bios, instead of using DOS or
  362.           direct screen writing.  Use -redir for DOS screen output.
  363.  
  364.           P.C Softsmith distributes an interactive TOUCH program that
  365.           allows you to alter the time and date of any file to any other
  366.           time and date, which can be useful when used for software
  367.           development and for 'backups' with gather.  Ask for it.
  368.  
  369.  
  370.           SUPPORT
  371.  
  372.  
  373.           For technical support, either call (604) 433-5189, or write to
  374.           Suite 606 - 6455 Willingdon Avenue, Burnaby, British Columbia,
  375.           Canada, V5H 4E4.  Both registered and soon to be registered
  376.           users currently get the same support without any arbitrary
  377.           time limit.  You may also try leaving a Compuserve message at
  378.           75020, 2664, or better yet send email to
  379.  
  380.           INTERNET:vic_williams@mindlink.bc.ca
  381.  
  382.  
  383.           P.C. Softsmith                       (604) 433-5189
  384.           Suite 606 - 6455 Willingdon Avenue,
  385.           Burnaby, British Columbia,
  386.           Canada, V5H 4E4
  387.  
  388.  
  389.           Please consider reporting the circumstances of ANY problems
  390.           that you discover, preferably in written form, to technical
  391.           support.
  392.  
  393.  
  394.           Some possible problems:
  395.  
  396.           The TSR option will not run after MSWindows is running. If you
  397.  
  398.  
  399.  
  400.  
  401.  
  402.                      The GATHER.DOC           Page 8
  403.  
  404.  
  405.  
  406.           must do this, ask for such a version, or just run it ahead of
  407.           Windows.  It can be reset to do so, but it will then be
  408.           unusually agressive running under DOS.
  409.  
  410.           You might possibly create a situation where gather runs out of
  411.           internal memory.  Gather has the capability to have such
  412.           memory usage altered at start-up, but this version does not
  413.           include such a command line switch.  Yell if you find such a
  414.           need.
  415.  
  416.           The -SHOW option overwrites your program's screen.  Sorry, but
  417.           the other options would require delays so humans could see the
  418.           message.  Try avoiding the -SHOW option in such a case.
  419.  
  420.           The clock appears in the wrong place.  Please wait for a
  421.           version using the TELE.INI configuration file.
  422.  
  423.           It repeatedly copies the same file to the backup directory.
  424.           Yes, if you are using the -days option, it is following your
  425.           instructions.
  426.  
  427.           It takes too much memory away from my usual applications.  Try
  428.           running it in a batch file during gaps in your work.  There
  429.           are some nifty small background TSR backup programs around.
  430.  
  431.           It does not check the available destination disk space before
  432.           copying a file.  If you believe that this is a major problem,
  433.           please indignantly say so, in order to encourage its addition
  434.           to the next release.  From a software developer's viewpoint
  435.           this is the start of adding an unlimited number of features
  436.           with the next likely feature being to add priorities for
  437.           copying individual files.  A complication is that such ongoing
  438.           backups often overwrite previous copies of the same file, so a
  439.           simple disk space check is not sufficient.
  440.  
  441.  
  442.           This product is Copyright (C) 1993-4 P. C. Softsmith all
  443.           rights reserved.  It is distributed as shareware and must be
  444.           distributed with this documentation.  It is normally
  445.           distributed with other P.C. Softsmith materials that further
  446.           explain the shareware process.  If you wish to distribute it
  447.           with your software or are unable to find the other
  448.           documentation that should accompany this file (such as the
  449.           SHR_WARE.DOC, FILE_ID.DIZ, and the VENDOR.DOC) please contact
  450.           whoever gave you the software or P.C. Softsmith. If you just
  451.           want to use this product on its own, you may license its use
  452.           for $US 10.00.
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                      The GATHER.DOC           Page 9
  460.  
  461.  
  462.  
  463.           History: (by date & version)
  464.  
  465.           June 7, 1994
  466.           2.5  minor changes to this manual.
  467.           April 5, 1994
  468.           2.5  Documentation changes for the HANDS ON remote
  469.           access OMNI protocol.
  470.           March 18, 1994
  471.           2.5 version change to match Teleshare.  There is now a
  472.           Teleshare Gather distribution specifically for remote and
  473.           local file management.
  474.           March, 1994
  475.           2.1 minor changes but Teleshare remote menu program mentioned
  476.           in the manual.
  477.           December, 1993
  478.           2.1 improves file attribute checking for read only files etc.
  479.           2.0  uses the TELE.INI file for copy, move, erase, the [R][S]
  480.           file transfer capability, and the optional Query switch.
  481.           November, 1993
  482.           1.10 improved wild card (*) handling and PATH support.
  483.           1.01 adds the -N rename switch and a larger stack.
  484.           1.00 was released in June, 1993.
  485.  
  486.           ASP Introduction:
  487.  
  488.           Please also carefully read the accompanying SHR_WARE.DOC
  489.           document.
  490.  
  491.           "This program is produced by a member of the Association of
  492.           Shareware Professionals (ASP). ASP wants to make sure that the
  493.           shareware principle works for you. If you are unable to
  494.           resolve a shareware-related problem with an ASP member by
  495.           contacting the member directly, ASP may be able to help. The
  496.           ASP Ombudsman can help you resolve a dispute or problem with
  497.           an ASP member, but does not provide technical support for
  498.           members' products. Please write to the ASP Ombudsman at 545
  499.           Grover Road, Muskegon, MI 49442 or send a CompuServe message
  500.           via CompuServe Mail to ASP Ombudsman 70007,3536."
  501.  
  502.  
  503.           THE DOCUMENTATION AND ASSOCIATED SOFTWARE ARE DISTRIBUTED AND
  504.           SOLD WITH NO WARRANTIES, EITHER EXPRESS OR IMPLIED, REGARDING
  505.           ITS MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE.
  506.           THE INFORMATION IN THIS DOCUMENTATION IS SUBJECT TO CHANGE
  507.           WITHOUT NOTICE AND DOES NOT REPRESENT A COMMITTMENT ON THE
  508.           PART OF THE VENDOR.
  509.  
  510.           OTHER PRODUCT AND BRAND NAMES MENTIONED ARE TRADEMARKS OR
  511.  
  512.  
  513.  
  514.  
  515.  
  516.                      The GATHER.DOC           Page 10
  517.  
  518.  
  519.  
  520.           REGISTERED TRADEMARKS OF THEIR RESPECTIVE HOLDERS.
  521.           SPECIFICALLY XBASE IS THE GENERIC DATABASE INDUSTRY
  522.           REPLACEMENT FOR THE REGISTERED TERM 'DBASE' OWNED BY BORLAND
  523.           INTERNATIONAL.
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.