home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / TGBACKUP.ZIP / TGBACKUP.DOC < prev    next >
Text File  |  1997-09-21  |  8KB  |  193 lines
  1.     Telegard Backup
  2.     Release 1.5  (September 21, 1997)
  3.     Copyright (c) 1996-97 by Jon Parise
  4.     North Star Technologies
  5.  
  6.  
  7. ┌─--Introduction
  8. └─────────────────────────--· ·   ·
  9.  
  10.     So what did you just download?  In short, you now have in your possession
  11. the most complete (in my feeble mind) backup utility designed specifically for
  12. (Fan fare, please!) Telegard.  That's right, no longer will you experience
  13. that nauseous feeling of anxiety you get in the pit of your stomach when you
  14. go to mod your board, nor will you be up the creek if your drive goes south on
  15. you (which is my own personal reason for writing this).  Now you can rest easy
  16. knowing that the long hours you've spent customizing and configuring your BBS
  17. are insured against most (un)natural disasters.
  18.  
  19.  
  20. ┌─--Disclaimer
  21. └─────────────────────────--· ·   ·
  22.  
  23.     While this program is intended to aid you and make your life easier, I
  24. cannot be responsible should something unexpected happen.  Hey, that's what
  25. backups are for!  Remember, should something brake, you own all the pieces.
  26.  
  27.  
  28. ┌─--Installation
  29. └─────────────────────────--· ·   ·
  30.  
  31.     1.      Unzip this archive wherever you want.  Telegard Backup does not
  32.         require its own directory, but I like to keep everything neat and
  33.         tidy by doing so.
  34.  
  35.    2.       Run the internal configuration program.  See 'Configuration'
  36.         below for detailed information.
  37.  
  38.                 TGBackup.Exe -C
  39.  
  40.    3.       Set it up in your nightly batch file or as a Telegard event.  See
  41.         the Telegard Documentation for how to set that up.
  42.  
  43.             Simple execute it as: TGBackup.Exe
  44.                   - No switches or parameters -
  45.  
  46.  
  47. ┌─--Configuration
  48. └─────────────────────────--· ·   ·
  49.  
  50.     Renegade Backup has an internal configuration program, so there's no need
  51. for you to edit a text file.  To enter it, type TGBackup -C from the command-
  52. line.  Below is a detailed explanation of each command.
  53.  
  54.     Telegard Path
  55.         The directory to your Config.Tg file.  Telegard Backup reads this
  56.         file to determine your system's directories.  The file is opened in
  57.         Read-Only mode, so no harm will come to it.
  58.  
  59.     Backup Path
  60.         This is the directory where the backups will be created.  If this
  61.         directory does not exist at runtime then it will be created.  All
  62.         work and storage is done in the directory, so don't point this
  63.         option to a Ram drive or a floppy that lacks adequate disk space.
  64.  
  65.     Archiver Path
  66.         This is the path to where you store your archivers.  This way, you
  67.         can specify the direct path to your archivers without them residing
  68.         in your Path statement.
  69.  
  70.     Archiver
  71.         This is the current archiver used to compress and archive the files
  72.         being backed up.  Currently, the only supported archivers are PkZip,
  73.         Arj, Lha, and Rar.  If you would like to request a additional
  74.         archiver, please contact me and I'll add it in.
  75.  
  76.     Dated Backups
  77.         Telegard Backup has a feature called Dated Backups.  By default, the
  78.         backup file created is TGBackup.[Arc].  If Dated Backups are Enabled,
  79.         then the filenames will be dated in the format TGB-mmdd.[Arc], where
  80.         `mm` is the current month and `dd` the current day.  For example,
  81.         a dated backup made on December 23 would be labeled as TGB-0210.[Arc].
  82.         This allows you to keep a series of backups, instead of overwriting
  83.         the previous one.
  84.  
  85.     Days to Keep
  86.         Telegard Backup includes a maintenance option that will purge backups
  87.         older than the number of days specified here.  Telegard Backup will
  88.         use the file's creation date to determine if it is older than this
  89.         number of days.  Maintenance can be forced with TGBackup.Exe -M.  The
  90.         maximum number of days to purge back is 30.  Set this option to zero
  91.         to disable maintenance.
  92.  
  93.     Screen Fades
  94.         I coded in some text-mode screen fades just to make things look nicer.
  95.         If you experience problems or just don't like them, you can turn them
  96.         off here.
  97.  
  98.     Backup Main  -through-  Backup Msgs
  99.         This allows you to be selective about which directories you want
  100.         backed up.
  101.  
  102.     Mask
  103.         These filemasks correlate to their repective directories listed to
  104.         their left.  This option allows you to be even more selective with
  105.         your backups by allowing you to only backup a specific filemask
  106.         (ie. *.*, *.exe, *.ans) in each directory.
  107.  
  108.     Extra Paths
  109.         I also added two extra paths options for you to fill in.  These
  110.         directories, if they exist at runtime, will be backed up and stored
  111.         as Extra1.[Arc] and Extra2.[Arc] in the final backup archive.
  112.  
  113.     When you're finished, press Escape and save the configuration.  The
  114. configuration file must remain in the same directory as TGBackup.Exe.
  115.  
  116.  
  117. ┌─--Commandline Parameters
  118. └─────────────────────────--· ·   ·
  119.  
  120.     -A <archiver>
  121.  
  122.         This options allows you to specify the archiver to use for compressing
  123.         the backup.  Current valid types are ZIP, ARJ, LHA, and RAR.
  124.  
  125.     -B <filename>
  126.  
  127.         This option allows you to specify the filename (minus the extention)
  128.         of the final backup archive to create.  There is an eight character
  129.         limit.
  130.  
  131.     -C
  132.  
  133.         Loads the internal configuration utility.
  134.  
  135.     -M
  136.  
  137.         Forces TGBackup into Maintenance Mode.  No backups are backups are
  138.         created.
  139.  
  140.  
  141. ┌─--Notes
  142. └─────────────────────────--· ·   ·
  143.  
  144.     ∙ If Telegard Backup finds an existing backup archive of the same name as
  145.       the one it's about to create, the older archive will be deleted to make
  146.       room for the new.
  147.  
  148.     ∙ Telegard Backup appends a little tag to the day's Sysop.Log.  This will
  149.       verify that the backup was made.  It includes both time and date of the
  150.       backup.
  151.  
  152.     ∙ Arj and Lha use direct screen writes to display their progress on the
  153.       screen.  Because of this, their output bleeds over the graphic border
  154.       and scrolls the Progress window upward.  I have not yet found a fix for
  155.       this.  The mechanics of the backup work perfectly, just the screen gets
  156.       messed up.  It's just something you'll have to live with for now.
  157.       Rar takes over the whole screen and gives you more to look at that I
  158.       could ever supply.  Again, this won't interfere with the intended
  159.       operation of the program, so please don't be concerned.
  160.  
  161.     ∙ Use OS/2!  Just common sense, but you already knew that.
  162.  
  163.  
  164. ┌─--Closing
  165. └─────────────────────────--· ·   ·
  166.  
  167.     I'm just a lowly Pascal programmer trying to do some good in the world.
  168. Therefore, Telegard Backup is released as Freeware.  I will still support it,
  169. and can be reached at:
  170.  
  171.             Email: jon@interpow.net
  172.             Ftp:   ftp://connco.com/knights/
  173.  
  174.             Infinite Twilight
  175.             Telegard/2 Beta/Support Site
  176.             (908) 637-8243
  177.             USRobotics Sportster 33.6 v34+
  178.             FidoNet: 1:2606/421
  179.             STN:     111:4908/0
  180.             F'Req:   TGBackup
  181.  
  182.  
  183.     This program was written using Borland International's Turbo Pascal 7.0.
  184.  
  185.     Good luck, and drop me a line if you like my work.  I would enjoy hearing
  186. thoughts and comments.  Take care.
  187.  
  188.                                                         Jon Parise
  189.                                                   North Star Technologies
  190.  
  191.   All archivers mentioned above and in Telegard Backup are the copyrighted
  192.                      material of their respective owners.
  193.