rom/filesys/SFS/SFScheck/SFScheck.txt

   1 SFScheck
   2 --------
   3
   4 This tool checks an SFS disk's structure and looks for
   5 anything which is out of the ordinary.  It makes no
   6 modifications, it only reads the disk.  Any errors it finds
   7 will be printed.
   8
   9 You can use this tool to give me more information when
  10 reporting bugs, but also to convince yourself that the SFS
  11 disk is still in working order.
  12
  13 If SFScheck reports any errors, then be very careful with
  14 the disk!  The best thing to do would be to copy all
  15 important files and reformat.  Try to remember what you did
  16 the last time you ran SFScheck -- you might be able to
  17 discover what caused the error.
  18
  19 Continuing to use an SFS disk with errors will eventually
  20 result in fatal errors which means you lose all data on that
  21 disk.
  22
  23 Don't run SFScheck when you're writing something to the
  24 disk.  SFScheck will get confused (because the structure
  25 changes right under its feet) and reports errors which
  26 aren't really there.  This isn't dangerous as SFScheck only
  27 reads the disk (it can't repair a disk), but you should be
  28 aware of this when using SFScheck.  Rerunning it should give
  29 correct results.
  30
  31
  32 How do I use it?
  33 ----------------
  34
  35 I've put SFScheck in my user-startup, and I let it print all
  36 the output to a Shell, so I can see that the disks are still
  37 okay each time I reboot.  SFScheck will generate errorcode
  38 20 (FAIL) when anything is found wrong, so you can redirect
  39 the output to a logfile as well.
  40
  41 For example try this:
  42
  43   failat 20
  44   date >>sys:logfile
  45   sfscheck dh3: >>sys:logfile
  46
  47
  48 Usage
  49 -----
  50
  51 Use SFScheck from a CLI.  It's commandline syntax is:
  52
  53   DEVICE=DRIVE/A,LOCK/S,LINES/N,READAHEADSIZE/N
  54
  55 DEVICE=DRIVE/A:  This is a required parameter.  It is the
  56 disk you want to check with SFScheck.
  57
  58 LOCK:  If you specify this parameter, then SFScheck will
  59 lock the disk for the duration of the scan.  This makes sure
  60 that no programs modify the disk during the check, which
  61 avoids the 'fake' errors SFScheck can generate if the disk
  62 was modified during the check.
  63
  64 LINES:  The nubmer of lines SFScheck uses for its cache
  65 during the check.  Setting this high enough can reduce the
  66 SFScheck scanning time drastically.  Try LINES=500 on the
  67 command-line to see the speed improvement -- use higher
  68 values if needed.
  69
  70 READAHEADSIZE:  Another parameter to control the cache
  71 SFScheck uses.  It works similair to the parameter in
  72 SetCache.
  73
  74
  75 So you can use SFScheck like this:
  76
  77   SFScheck dh0:
  78
  79 If you want to redirect its output to a temporary file try
  80 this:
  81
  82   SFScheck dh0: >RAM:output.txt
  83
  84 or this if you want the output appended each time:
  85
  86   SFScheck dh0: >>RAM:output.txt
  87
  88
  89 Don't use your SFS disk while SFScheck is checking it,
  90 unless you specify the LOCK parameter.  SFScheck will be
  91 confused (by default it doesn't lock the disk during the
  92 checking period).
  93
  94 Also note that this version of SFScheck is an early version
  95 of a program which isn't complete yet.  This means that it
  96 probably contains bugs and may crash your system.  Please
  97 make sure you've saved all your work before using SFScheck.
  98 SFScheck won't make any modifications to your disks -- it
  99 only reads data from them and reports any problems.
 100
 101
 102 Requirements
 103 ------------
 104
 105 SFScheck can only be used on SFS disks.  Using it on a FFS
 106 disk or other type of disk is harmless and SFScheck will
 107 simply report that the disk isn't in the correct format.
 108
 109 SFScheck requires quite a lot of memory to operate (but it
 110 helps to make the check quite fast).  It takes 10-20 seconds
 111 to check a disk with 20.000 files on it on my system.  About
 112 2 MB of free memory is required.