home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / zip / diskutil / backupst.lzh / BACKUPST / BACKUPST.TXT < prev    next >
Text File  |  1990-11-01  |  16KB  |  364 lines
  1.             BACKUPST --- A backup program for the Atari ST
  2.  
  3.                         F.J.R. Appelman,
  4.                       University of Utrecht,
  5.                 3D Computer Vision Research Group,
  6.                        The Netherlands. 
  7.                     email: fred@cv.ruu.nl
  8.     
  9. 1. Info
  10.     BackupST is a backup program for the Atari-ST. BackupST writes the 
  11.     hard disk data to floppy disks. BackupST has 3 modes in which it 
  12.     works; creation (backup), listing or extraction (restore).
  13.     
  14.     The floppies written by BackupST are in a proprietary format, and 
  15.     are NOT readable by GEMDOS. You need BackupST again to read 
  16.     the floppies.
  17.  
  18. 2. STARTING THE PROGRAM
  19.     BackupST can be started by double clicking on the application 
  20.     from the desktop, and typing the parameters in the presented 
  21.     box. 
  22.  
  23.     Note:   BackupST is NOT case sensitive; this because the OS 
  24.             converts all input from the desktop to uppercase before 
  25.             passing it to the application.
  26.     
  27.     After execution BackupST will wait for a keypress before it 
  28.     returns to the desktop. BackupST will also work from a command 
  29.     interpretator like the Craft shell. If you set the 
  30.     environment variable
  31.     
  32.         BACKUPSTPAUSE=NO
  33.     
  34.     BackupST wil not wait for a keypress after execution.
  35.     The program can also be started by the GEM interface 
  36.     program bfront. This document does NOT describe the 
  37.     bfront program.
  38.  
  39. 3. CREATION (BACKUP) MODE
  40.     The ``-c'' flag sets BackupST in Creation mode. 
  41.  
  42.         backupst -c [options] files
  43.     
  44.     Files can be:
  45.         1. Plain files. 
  46.         2. directories
  47.         3. disks
  48.         4. regular expressions
  49.  
  50.     Slashes (/) are automatically converted to backslashes (\). 
  51.     Relative addressing is supported. Regular expressions are full 
  52.     regular expressions, not the GEMDOS regular expressions.
  53.     
  54.     The options supported in creation mode in alphabetical order 
  55.     are:
  56.     -b0     Set the archived bit. ``Setting'' the archived bit is a 
  57.             little bit symbolic since TOS 1.4 is introduced. The 
  58.             introduction of TOS 1.4 inverted the meaning of the 
  59.             archived bit. Before TOS 1.4 the bit was set to ``1'' to 
  60.             indicate the file was archived. Before TOS 1.4 this bit 
  61.             was automatically cleared by the OS once the file was 
  62.             changed. Since the introduction of TOS 1.4 this bit is set 
  63.             to ``0'' to indicate the file is archived. In TOS 1.4 this 
  64.             bit is set to ``1'' by the OS if the file is changed. 
  65.             BackupST will automatically adjust its behavior to the 
  66.             present TOS version. This is a default option.
  67.  
  68.     -b1     Don't set the archived bit.
  69.  
  70.     -f0     Never format a track. If a disk I/O error occurs, BackupST 
  71.             is aborted with an error message.
  72.  
  73.     -f1     Format every track before trying to write on the track. 
  74.             After formatting of the track the behavior of BackupST is 
  75.             as if the -f2 option was typed. 
  76.  
  77.     -f2     Format a track if an I/O error occurs. After formatting of 
  78.             this track, writing to the track is tried again. Up to 5 
  79.             retries will take place. If the retries have no effect, 
  80.             BackupST is aborted. When every track needs reformatting, 
  81.             it turns out to be a time consuming proces. If more than 3 
  82.             tracks need formatting on a particular side of a disk the 
  83.             remaining tracks on that side will be formatted before 
  84.             trying to write on that side. This is a default option.
  85.  
  86.     -l0     Incremental backup. Only files which have been changed 
  87.             since the last backup are stored on disk.
  88.  
  89.     -l1     Full backup. All files specified are stored. This is a 
  90.             default option.
  91.  
  92.     -r      Read file names from stdin. You can either type the 
  93.             filenames by hand, or put BackupST in a pipeline.
  94.  
  95.                 find c: '*.c' | backupst -cr
  96.  
  97.     -u0        Don't verify after write. This is a default option.
  98.     
  99.     -u1     Verify after write.
  100.     
  101.     The following options are available in all modes:
  102.  
  103.     -da     Use drive A as the backup drive. This is a default option.
  104.   
  105.       -db     Use drive B as the backup drive
  106.  
  107.     -s1     Use single sided floppies
  108.  
  109.     -s2     Use double sided floppies. This is a default option.
  110.  
  111.     -v        Verbose mode. This option has no use to the normal user, 
  112.             only to the programmer. You are not advised to use this 
  113.             option, it will slow down the backup.
  114.  
  115.     -j#     No of sectors per track. The only valid numbers are 9 and 
  116.             10. If you restore or list an archive, this option may be 
  117.             supplied but is overruled by the values stored in the 
  118.             archive info. 9 sectors per track is the default value.
  119.  
  120.     -k#        No of tracks per side. The only valid numbers are 80-84. 
  121.             If you restore or list an archive, this option may be 
  122.             supplied but is overruled by the values stored in the 
  123.             archive info. 80 tracks per sector is the default value.
  124.  
  125.  
  126.     After writing the ``written and archived'' flag on the hard disk 
  127.     is set. So if you make an incremental backup, BackupST knows which 
  128.     files are changed, and which are not. This ``written and 
  129.     archived'' flag is automatically reset by GEMDOS if the file is 
  130.     changed. (see also the description of the ``-b0'' flag)
  131.  
  132.     BackupST first checks all the arguments entered. If one file could 
  133.     not be found, an error message is printed. First all the files are 
  134.     written to floppy. The space used by the archive index is known 
  135.     and skipped on the first disk. If all data is written to disk, you 
  136.     are asked to reinstall disk #1. The archive index is now written 
  137.     to disk. This ``strange'' aproach is taken, because future 
  138.     versions of BackupST will compress the data, when it is written to 
  139.     disk. If data is compressed, BackupST will not know where exactly 
  140.     the file data is written on the floppies, and this information is 
  141.     stored in the archive index. A backup archive index is stored 
  142.     behind the data. This backup archive index is used by the ``-y'' 
  143.     option (See extract mode).
  144.     
  145.     Examples:
  146.         backupst -c c:              # Backup disk C: 
  147.         backupst -c .               # Backup the current directory 
  148.         backupst -cl0das1 c: d:     # Store all changed files on disk
  149.                                     # C: and disk D: on floppy A:, and use
  150.                                     # single sided floppies.
  151.         backupst -c c:/bin          # Store all file in the 
  152.                                     # directory c:/bin
  153.         backupst -c *.[ch]          # Store all C-files and H-files in the
  154.                                     # current directory
  155.     Note1:
  156.         If you use regular expressions, be aware of the fact that most 
  157.         shells already expand regular expression patterns. If you want 
  158.         to use the regular expression, quote the regular pattern, e.g.
  159.  
  160.             backupst -c '*.[ch]'
  161.     Note2:
  162.         It's strongly advised you use the FOLDRxxx program, because 
  163.         the 40-folder bug is still present.
  164.     
  165.  
  166. 4. LIST MODE
  167.     The ``-t'' flag sets the program in List mode. 
  168.  
  169.         backupst -t [options]
  170.  
  171.     The List mode does not have special options. Only the general 
  172.     options apply.
  173.     
  174.     The following options are available in all modes:
  175.  
  176.     -da     Use drive A as the backup drive. This is a default option.
  177.   
  178.       -db     Use drive B as the backup drive
  179.  
  180.     -s1     Use single sided floppies
  181.  
  182.     -s2     Use double sided floppies. This is a default option.
  183.  
  184.     -v        Verbose mode. This option has no use to the normal user, 
  185.             only to the programmer. You are not advised to use this 
  186.             option, it will slow down the backup.
  187.  
  188.     -j#     No of sectors per track. The only valid numbers are 9 and 
  189.             10. If you restore or list an archive, this option may be 
  190.             supplied but is overruled by the values stored in the 
  191.             archive info. 9 sectors per track is the default value.
  192.  
  193.     -k#        No of tracks per side. The only valid numbers are 80-84. 
  194.             If you restore or list an archive, this option may be 
  195.             supplied but is overruled by the values stored in the 
  196.             archive info. 80 tracks per sector is the default value.
  197.  
  198.  
  199.     BackupST will list all the data found in the archive. If BackupST 
  200.     is functioning in list mode, the data listed will be piped through 
  201.     more. After every full page of data, you must press a key to see 
  202.     the next page full of data.
  203.  
  204. 5. EXTRACT MODE
  205.     The ``-x'' flag sets the program in Extract mode. 
  206.  
  207.         backupst -x [options]
  208.  
  209.     The options supported in extract mode are:
  210.  
  211.     -h path
  212.         Set root of restore path to ``path''. If this option is used, 
  213.         BackupST will not write back the data at the position it was 
  214.         originally stored. Suppose you have stored a directory named 
  215.         ``c:/bin''. If you restore the data by using the command 
  216.  
  217.             backupst -xh d:/tmp
  218.         the data will be stored in the directory d:/tmp/bin. The 
  219.         directory structure is still maintained.
  220.     -o0 Restore the original creation date. After writing to the file 
  221.         to harddisk, the creation date is set to ``today''. With this 
  222.         option the creation date is reset to the original date. This 
  223.         is a default option.
  224.  
  225.     -o1 Set creation date at ``today''. (See -o0)
  226.  
  227.     -i    Interactive mode. After reading the archive index BackupST 
  228.         will go into interative mode. The following command are 
  229.         available:
  230.         
  231.         ls [directory]
  232.         dir [directory]
  233.             This command will list the contents of a directory. If you 
  234.             don't specify a directory, the current directory is listed 
  235.             by instead. By default, no files are extracted in 
  236.             interactive mode. Only the files specifically ``added'' 
  237.             (see command add) by the user are extracted. Files to be 
  238.             extracted are marked by a ``+''. Directories are marked by 
  239.             a ``\''. Directories are never marked by a ``+'', only the 
  240.             contents of a directory is. If you list the contents of a 
  241.             directory, you see the contents of a fictive disk. There 
  242.             is absolute no relation with the current contents of the 
  243.             hard disk. This so fictive disk has a root directory under 
  244.             which all disks are mounted. If you type ``ls'' at the 
  245.             root level you probably only see the volume label(s) of 
  246.             the disks you have stored in this archive. If only one 
  247.             ``disk'' is available, an automatic ``cd disk'' will be 
  248.             done when the program is started.
  249.         ll [directory]
  250.             The ``ll'' command will make a long directory listing. 
  251.             (see ls)
  252.         quit
  253.         stop
  254.         exit
  255.             This will abort the program without extracting the marked 
  256.             files.
  257.         help [command]
  258.         h [command]
  259.             This command gives a list of all commands available. If an 
  260.             argument is given, an explanation of this command is 
  261.             given.
  262.         cd [directory]
  263.         chdir [directory]
  264.             Change directory to ``directory''. If no argument is 
  265.             given, the new directory is the root directory of the 
  266.             ramdirectory.
  267.         add [files]
  268.             Add files to the list of files to be extracted. If the 
  269.             argument is a directory, all files in this directory are 
  270.             added to the list.  Regular expressions are also valid. 
  271.             Added files are marked by a ``+'' in front of the filename 
  272.             in a ``ls'' command. (see ``ls'')
  273.         rm [files]
  274.             Opposite of add command. Same syntax.
  275.         extract
  276.         retrieve
  277.         go
  278.             Retrieve all marked files from the archive.
  279.  
  280.     -w  Overwrite existent files silently. Normally BackupST will not 
  281.           overwrite an existing file without asking permission to do so. 
  282.           If you give the ``-w'' argument, will overwrite all files 
  283.           without asking. 
  284.           
  285.     -y    Same as ``-x'', only instead of using the main archive index, 
  286.            an attempt is made to read the backup archive index from disk. 
  287.            This mode is slow (and not thoroughly tested), and scans the 
  288.            disk for the backup archive index. The backup archive index is 
  289.            always written at the end of the archive. If you use this 
  290.            option, you will be asked to install the the disk on which you 
  291.            expect the backup archive is written. If the backup archive is 
  292.            not broken into two parts, this is the last disk of the 
  293.            archive. The disk# the backup archive is written on, is 
  294.            reported during the creation of the archive. If you have a 
  295.            small archive which fits on a single disk, the main archive 
  296.            info, which is written before the archive will be skipped in 
  297.            the search for the backup archive info.
  298.  
  299.     -z0 Never create subdirs. This means that all the files are 
  300.         restored at the root disk of the ``original'' disk the files 
  301.         were located on. This command is usually used in conjuction 
  302.         with the ``-h'' flag. For example the command 
  303.  
  304.             backupst -xz0 -h d:/tmp
  305.  
  306.         will restore all the files in the directory d:/tmp without 
  307.         creating the subdirectories in d:/tmp. If needed the directory 
  308.         d:/tmp will be created. 
  309.         
  310.     -z1 Create subdirs if needed. This is the default mode of the 
  311.         program.
  312.  
  313.     The following options are available in all modes:
  314.  
  315.     -da     Use drive A as the backup drive. This is a default option.
  316.   
  317.       -db     Use drive B as the backup drive
  318.  
  319.     -s1     Use single sided floppies
  320.  
  321.     -s2     Use double sided floppies. This is a default option.
  322.  
  323.     -v        Verbose mode. This option has no use to the normal user, 
  324.             only to the programmer. You are not advised to use this 
  325.             option, it will slow down the backup.
  326.  
  327.     -j#     No of sectors per track. The only valid numbers are 9 and 
  328.             10. If you restore or list an archive, this option may be 
  329.             supplied but is overruled by the values stored in the 
  330.             archive info. 9 sectors per track is the default value.
  331.  
  332.     -k#        No of tracks per side. The only valid numbers are 80-84. 
  333.             If you restore or list an archive, this option may be 
  334.             supplied but is overruled by the values stored in the 
  335.             archive info. 80 tracks per sector is the default value.
  336.  
  337.     If BackupST in extract mode is not started in interactive mode, 
  338.     all files in the archive will be extracted. If BackupST is started 
  339.     in interactive mode, no file is extracted unless you specifically 
  340.     tell BackupST to do so.
  341.     
  342. 6. Remarks
  343.     I probably forgot a lot in this documentation. If you have any 
  344.     further questions or wishes for the program please let me know. I 
  345.     can be reached at the Atari bulletin board or by email.
  346.  
  347.     BackupST does not work properly with Turbo--ST. (The software 
  348.     blitter) BackupST only uses regular library calls, and does not 
  349.     effect any vectors. The only low level I/O BackupST uses are some 
  350.     BIOS calls for screen output, and keyboard input. 
  351.  
  352.     Some of the options are not so logical. The next version should 
  353.     support options like 
  354.  
  355.         -tracks 80
  356.  
  357.     instead of
  358.  
  359.         -k 80
  360.  
  361.     Fortunally when using the GEM frontend bfront, you don't have to 
  362.     remember the options.
  363.     
  364.