home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / zip / diskutil / dscan12.lzh / DSCAN12 / DISKSCAN.DOC next >
Text File  |  1985-11-19  |  34KB  |  629 lines

  1. Hi,
  2.  
  3. Since I have shelved DISKTOP for a bit, I thought I would combine DISKTOP and
  4. HDSCAN and produce a new program. DISKSCAN 1.0 is included in this release.
  5. DISKSCAN is a FREE (but copyrighted by me) program that has pretty much all the
  6. features of both DISKTOP and HDSCAN. It is a fully functional program with lots
  7. of features and, in keeping with the HDSCAN tradition, I have reserved only a
  8. few additional bells and whistles for the Professional version (2.0 = not free).
  9. In this case, these extra features include things like sort options, mouse
  10. control, extra output options, etc, all of which you can live without if you
  11. are strapped for money. To keep things simple, the following document covers the
  12. features of both 1.0 and 2.0.
  13.  
  14. Some useful things to note. This version of DISKSCAN (1.0) has extended command
  15. macro features, better directory viewing, and a few other enhancements that were
  16. added to HDSCAN 1.4/2.4 (just finishing the docs on that). So if you are
  17. familiar with the old HDSCAN I would still recommend reading the docs.
  18.  
  19.   -Todd Burkey
  20.   trb@stag.UUCP
  21.  
  22. -------C--U--T-----H-E-R-E---------------------------------------
  23.                      
  24.                         DISKSCAN Version 1.0/2.0
  25.                       (The ST Floppy Disk Manager)
  26.                                (c) 1988
  27.                             by Todd Burkey
  28.  
  29.  
  30. Note: This documentation must be included with DISKSCAN Version 1.0 if you
  31.       wish to transmit the program to anyone by email, bbs, or any other means.
  32.       
  33.       Any modification of the binaries or this document is expressly forbidden.
  34.       DISKSCAN 1.0 is copyrighted 1988 by Todd Burkey-All Rights Reserved.
  35.  
  36.       DISKSCAN Professional (2.0) is copyrighted 1988 by Todd Burkey-All Rights
  37.       Reserved and may NOT be copied, except for personal use by users who have
  38.       purchased the product legally.
  39.  
  40. DISCLAIMER: I spend all my money on computers that outdate themselves within a
  41.             year, so I really don't need a disclaimer...although with all the
  42.             strange things TOS and GEM occasionally do, I should say "LET THE
  43.             USER BEWARE".  There. Safe.
  44.  
  45. 1.0 INTRO:
  46.  
  47. DISKSCAN was designed initially to satisfy a simple need. I kept losing files.
  48. Not permanently, but just in that frustrating sense of knowing that one of
  49. those disks with the little cryptic writing on the plastic contains the file
  50. I want. And also knowing it is going to be on the very last diskette that I
  51. stick in the drive. So, DISKSCAN is first and foremost a utility that lets
  52. you 1) archive file information quickly and painlessly and 2) easily find
  53. the files at a later date.
  54.  
  55. A program I wrote almost two years ago (DISKTOP) had covered this problem
  56. fairly well, but I quickly ran into limitations in how many disks I could
  57. adequately archive with it (both array limitations and the user interface).
  58. DISKSCAN is hopefully my final solution to the problem. DISKSCAN bypasses
  59. the old 2000 file limit (currently it is set to 5000 files/database), but
  60. also keeps track of what directory a file is in, its' size, and its' date.
  61. And, since you can have multiple databases there really aren't any hardnosed
  62. limitations anymore.
  63.  
  64. You will find that DISKSCAN is optimized for speed. It scans disks quickly
  65. and, by letting you use the volume name, lets you scan your existing disk
  66. collection with a bare minumum of effort. DISKSCAN also recognizes the
  67. DISKTOP.INF file which was used by DISKTOP (it is a small file that just
  68. contains the name of the disk...up to 20 chars long). By default, DISKSCAN
  69. will still look for the DISKTOP.INF file and create one for you if you
  70. put in a disk that doesn't have the file. This feature can be easily
  71. disabled by one keypress (or by setting a configuration parameter...see
  72. the discussion on DISKSCAN.KEY). I call it a feature because I prefer to
  73. call my disks by a name like: "Source Code Disk #1" as opposed to a yucky
  74. SRC_CODE.001 volume name.
  75.  
  76. Other features include viewing files, hexdumping files, tagging for copying
  77. and or deleting groups of files, renaming files, changing protections on
  78. files,  invoking external programs, and sorting files.  You can sort by
  79. date, name, and size in ascending or descending order. For example, you can
  80. select all .c files (all disks), sort them by reverse date, then easily
  81. track down that elusive program you lost. Or maybe sort an entire library
  82. by name to help find duplicate files (this will make more sense if you have as
  83. many disks as I do). The sort in DISKSCAN is a recursive quicksort, so even
  84. thousands of files will be sorted in a few seconds. I have also added a very
  85. simple (but fast) file compare routine to allow quick checks to see if files
  86. are duplicates. And you will find even more features embedded in the program
  87. as you start using it.
  88.  
  89.  
  90. 1.1 BRIEF HISTORY:
  91.  
  92. I wrote this program for one reason only...I needed it.
  93.  
  94. 1.1.1 Who else needs it?
  95.  
  96. Anyone who has more than 20 floppies laying around can probably use a quick
  97. archiving mechanism. DISKSCAN's predecessor (DISKTOP) was used heavily by the
  98. local Atari clubs to keep track of files and to provide a simple way of
  99. letting members find the right disks to buy. As a developer, I have little
  100. trust in hard disks, so I tend to back certain files up to lots of temporary
  101. disks and DISKSCAN has proven invaluable for keeping track of my mess.
  102.  
  103. 2.0.0 USING DISKSCAN:
  104.  
  105. 2.1.0 First things first: The DISKSCAN.KEY Control File
  106.  
  107. Before you run DISKSCAN for the first time, you should probably create a
  108. file called DISKSCAN.KEY and place it in C:\DISKSCAN.KEY or on your floppy
  109. if you don't have a harddisk and don't trust your ram disk. DISKSCAN will
  110. search for DISKSCAN.KEY in your current directory when you first invoke
  111. DISKSCAN, and if it can't find it there, it will automatically check
  112. C:\DISKSCAN.KEY. If DISKSCAN doesn't find it, DISKSCAN will come up with some
  113. defaults of its own.
  114.  
  115. DISKSCAN.KEY is control file that defines system and user specific things
  116. for DISKSCAN. This includes 'things' like telling DISKSCAN where your best
  117. editor is located, where to find your copy of arc, or even what commands
  118. to 'attach' to the auto-invoke keys (Function Keys 1-10) for macros. While
  119. DISKSCAN will work fine without DISKSCAN.KEY, proper setup of the file will
  120. be well worth the time it takes to learn its somewhat cryptic structure.
  121.  
  122. 2.1.1 DISKSCAN.KEY Syntax
  123.  
  124. The format of DISKSCAN.KEY is actually very simple.  Each line in the file
  125. acts as either a key definition (keys F1-F10), a parameter assignment, or
  126. a comment. If a line does not have an equal sign ('=') or colon (':') in
  127. the second character position, it is taken as a comment line.
  128.  
  129. 2.1.1.1 DISKSCAN.KEY Key Bindings
  130.  
  131. If the line begins with one number followed by an '=' sign, then the text that
  132. follows the equal sign will be taken as a command (or commands) to be executed
  133. when you press the appropriate number key. These commands can consist of
  134. pretty much anything you would normally type from a shell. A nice feature is
  135. that the commands can be parameterized by embedding @F, @P, @f, @p, ?, and < 
  136. in the command line. This will make more sense once you start using DISKSCAN,
  137. but @F will expand into the full pathname of the file you are 'ON' when you
  138. select the command, @P will be the full file name without the extender (i.e.
  139. if C:\trb\test.c is the FULL pathname, then @P will expand to C:\trb\test).
  140. Likewise, @f will give you the full file name (test.c) and @p will give just
  141. the prefix of the name (test). Finally, if the first character of the command
  142. line is a ? the user will be prompted before the command is invoked, and if
  143. it is a < then the user will be prompted to type in the full command.
  144.  
  145. 2.1.1.2 DISKSCAN.KEY Parameters
  146.  
  147. If the line begins with a letter, dash ('-'), or plus ('+') followed by a ':',
  148. then the information following the ':' will be passed (kind of like parameters)
  149. into DISKSCAN at startup.  I know, I could have used environment variables, but
  150. this was easier and simpler for people to set up. For now, the 'parameters'
  151. that are recognized by DISKSCAN are:
  152.  
  153.   'A'     (arc path)
  154.   'P'     (print file path)
  155.   'E'     (editor path)
  156.   '+'     Use the following floppy drive for scanning (default is drive A)
  157.   'V'     If set to Y then the Volume name is scanned instead of DISKTOP.INF
  158.  
  159. 2.1.2 DISKSCAN.KEY Example
  160.  
  161. For example, let's say your favorite editor is in C:\bin\emacs.tos, you
  162. have arc in your local directory, you always want drive B scanned,
  163. and you want to be able to perform a variety of commands on files at the
  164. press of the key. The following DISKSCAN.KEY file would accomplish this.
  165.  
  166. -------sample DISKSCAN.KEY file--------
  167. +:B
  168. E:C:\bin\emacs.tos
  169. A:arc.ttp
  170. V:Y
  171. /* Key 1 & F1 definition: do a word count of the current file */
  172. 1=wc @F
  173. /* compile the current file after prompting the user to do so */
  174. 2=?cc -O @F -o @P
  175. /* do a less of the current file */
  176. 3=less @F
  177. /* drop into a shell...somewhat unnecessary on BSD systems */
  178. 5=C:\bin\sh.prg
  179. /* copy the current file into my catchall directory */
  180. 6=C:\bin\cp.prg @F G:\packrat
  181. /* Look at a tiny picture */
  182. 7=C:\tinylook.ttp @F
  183. /* key 0 & F10 definition: dynamically prompt user for the command to issue */
  184. 0=<
  185. -----end of sample DISKSCAN.KEY file--------
  186.  
  187.  
  188. 2.2.0 INVOKING THE PROGRAM:
  189.  
  190. Very simple. Just click on the diskscan.prg icon. Or you can run it from a
  191. shell with command line options by typing:
  192.  
  193.   diskscan data_base_name    <--assuming you want to load a database other
  194.                               than the standard "DISKSCAN.DB"
  195.  
  196. Note that with this format, you can also install the application with
  197. a .DB extender and then just execute diskscan from the desktop by clicking
  198. on the database file itself (assuming you use a .db extender).
  199.  
  200. The screen will be somewhat confusing to the beginner, so I will explain
  201. here what you are looking at.
  202.  
  203. 2.2.2 The Main Display:
  204.  
  205. Right after invoking DISKSCAN for the first time, you will probably see a
  206. somewhat empty screen (because you haven't scanned anything yet). The
  207. best thing to do is to stick a disk in drive A and press the '!' key
  208. to start a scan. If this disk has never been scanned before and you didn't
  209. over-ride DISKSCAN's default use of DISKTOP.INF (note that this is NOT a
  210. typo for DESKTOP.INF!), then you will be prompted for the disks name. I
  211. recommend giving it the same name that you have scribbled on the top edge
  212. (or front) of the disk. Keep in mind that it must be 20 characters or less
  213. (DISKSCAN will just chop it off if you type too much). After you type it
  214. in, DISKSCAN will write out the file to the disk and scan the disk. Now
  215. you should have something on the screen to relate to in the following
  216. discussion.
  217.  
  218. Most noticeable on the screen will be a tall box near the right of the screen
  219. filled with file names. That is the 'selected file' window and you can scroll
  220. up and down through all selected files with the h, j, k, and l keys (more on
  221. this later) to quickly get to a file. The file you are currently 'ON'
  222. will be highlighted (both reverse fielded and with a > sign next to it).
  223. Right after scanning a disk, DISKSCAN sets the selection criteria to
  224. NEW DISK and selects, for viewing, only those files it just scanned.
  225.  
  226. As you scroll through the file names, notice that the directory the file is
  227. in, it's size, and it's dates (modify/access/change), are automatically
  228. updated in windows near the top left of the screen. The disk name is also
  229. updated (more important when you are searching for files...)
  230.  
  231. Next to the file size window is a window that will make more sense later. It
  232. displays the total size of all Tagged files. This proves useful when you are
  233. tagging files to copy to a RAM Disk, deciding which files will fit.
  234.  
  235. Below these two windows is a long window used for prompts. Look in this
  236. window if you aren't sure why something isn't happening...it might be asking
  237. you a question.
  238.  
  239. Below the prompt window is a big free space which I am sure will eventually get
  240. filled up. Right now it is mostly a billboard.
  241.  
  242. Below that is a status line that basically tells you 1) what you have selected
  243. (i.e. ALL will appear if all partitions are chosen, DISK will appear if you have
  244. selected a single directory to work in, and a string of 1-8 characters will
  245. appear if the selection was made using a wildcard string search), 2) the sort
  246. order (initially RANDOM to give you an idea of how fractured your file space
  247. is), 3) the number of disks total in your current database, 4) the number of
  248. selected files, and 5) the total size in bytes of all selected files.
  249.  
  250.  
  251. 3.0 File Selection Mode: Commands
  252.  
  253. You can skip this section and just use it for reference if you are familiar
  254. with the Unix version of HDSCAN. Everyone else would be wise to at least do
  255. a quick scan of the commands. One important difference to keep in mind between
  256. DISKSCAN and HDSCAN is that in HDSCAN, the files were always available
  257. throughout the session (i.e. you couldn't swap hard disks on me). In DISKSCAN,
  258. I actually check to see if the correct disk is in the drive before performing
  259. an operation (file viewing, deleting, copying, comparing, etc). If DISKSCAN
  260. doesn't see the correct disk in the drive, it will prompt you to put it in
  261. (or you can hit ESC to abort the operation.)
  262.  
  263. 3.1 Moving About:
  264.  
  265. One important thing to learn before we get into the various commands is
  266. that to scroll through the files in the file window, you can use the h,
  267. j, k, and l keys. The j/k keys will scroll down/up in the file window
  268. respectively. Likewise, the h/l keys will page up/down in the list. If
  269. you want to go all the way up or down in the list of files displayed in
  270. the window, then use the H and L keys. If you want to scroll a bit faster,
  271. use the J/K keys instead of the j/k keys. This will cause scrolling without
  272. updating the current file info on the screen.
  273.  
  274. For those of you who prefer the use of the arrow keys, then make the following
  275. substitutions to the above:
  276.  
  277.        Up Arrow---->k key-->scroll up
  278.        Down Arrow-->j key-->scroll down
  279.        Left Arrow-->h key-->page up
  280.        Right Arrow->l key-->page down
  281.  Shift Up Arrow---->K key-->scroll up (faster)
  282.  Shift Down Arrow-->J key-->scroll down (faster)
  283.        Clr/Home---->H key-->Goto first file in selected list
  284.  Shift Clr/Home---->L key-->Goto last file in selected list
  285.  
  286. Why did I do this? I just like keeping my fingers in the normal key range
  287. and hate searching around for the arrow keys. Likewise, the number keys are
  288. mapped into the Function Keys (0=F10, 1=F1, ..., 9=F9).
  289.  
  290. 3.2 TAGGING STuff:
  291.  
  292. Tagged files are a fundamental feature of diskscan and its usage. To tag a file,
  293. simply scroll to the file you want and press the 't' key. You will see a '*'
  294. appear in a little scrolling region next to the file name and the file window
  295. will scroll to the next file (so you can keep pressing 't' to select a bunch
  296. of files.) As each file is Tagged, you will see the total Tagged size increase
  297. in the TOTAL TAGGED window. To untag a file, just use the 'u' key. To untag
  298. all files, type 'ALT-U'. Note that directories will also appear in the file
  299. selection window (they have a 'D' next to them). I don't allow tagging of
  300. directories so you can't delete them, but they are useful for reference to
  301. see what all is in a directory (and when you are checking out protections,
  302. modify dates, etc).
  303.  
  304. 3.3 SEARCHING AND SELECTING STuff:
  305.  
  306. 3.3.1 Searching for files
  307.  
  308. Most of the time, you will probably just want to search out a few files for
  309. tagging and won't want to scroll over all 5000 or so files in the database. To
  310. accomplish this, if you press the 's' key, you will be prompted for a <13
  311. character string to search for (you can enter stuff like .doc, .c, junk, etc
  312. but no * or ? wildcards are supported...to be truthful, I never even had any
  313. requests for wildcards.) The 's' key option will make its selection from all
  314. available files. If you just want to perform a selection from the currently
  315. selected subset of files, the 'S' key should be used instead. This will
  316. allow you to easily narrow in on a set of file names. Both options will
  317. allow you to enter just an asterisk (*) if you want to just see Tagged files,
  318. and entering only a carriage return will reselect everything.
  319.  
  320. 3.3.2 Selecting/Searching for a directory
  321.  
  322. There are also times when you might only want to select the files in one
  323. disk or directory. To do so, pressing the TAB key will turn the DISK: window
  324. into a little scrolling region, allowing you to use the arrow keys to quickly
  325. scroll to the appropriate disk. If you have a lot of disks to scroll past,
  326. you can just type '/' or '\' followed by a few characters that are in the
  327. disk name to search forwards or backwards respectively in the disk
  328. tree. When you have the disk you want in the PATH: window, you can either
  329. press the TAB key again (to select all the files in the currently selected
  330. disk) or the right arrow key to move the scrolling region over into the
  331. PATH: window. Moving into the PATH: window will let you further refine your
  332. selection down to the exact directory on the disk in question. Again, once
  333. you have gotten to the correct directory, pressing the TAB key will select
  334. all files in that directory, on that disk. If there are no files in the
  335. directory you are trying to select, then DISKSCAN will inform you so and let
  336. you select another directory.
  337.  
  338. There is also another method that allows disk selection. If you press
  339. the N or P keys, the disk in the database that is Next/Previous to the
  340. one in the DISK: window will be selected.  This is a useful way of swinging
  341. through disks checking sizes or whatever. Note that in both selection
  342. methods, my definition of the next disk in a tree is based on the next
  343. alphabetically sorted path for that disk. This will be more apparent
  344. once you use the program.
  345.  
  346.  
  347. 3.4 DANGEROUS STuff (Copy/Erase all Tagged files...and more):
  348.  
  349. Once you have everything that you need Tagged, pressing the 'm' or 'M' keys
  350. will invoke the mass file copy routine. Selecting 'M' will copy files while
  351. preserving the original file dates and attributes, whereas the 'm' key will
  352. create a file with the current date. This option will prompt you for the
  353. destination path and allow you to copy all Tagged files (with or without an
  354. interactive query on each file). Once copied, the '*' next to a file name will
  355. become a '#' to show that the copy was successful. If you later want to re-tag
  356. the '#' files, possibly for mass erase ('E' key), you can do so by pressing
  357. the 'ALT-T' keys.
  358.  
  359.  
  360. 3.5 VISUAL STuff (Viewing and Dumping files):
  361.  
  362. One nice feature of DISKSCAN is that by pressing the 'v' key, you can view the
  363. file that you are currently 'ON' in the file window. The view option does
  364. a character by character analysis of the file, just displaying the ASCII
  365. printable characters on the screen, so it can be used for looking for strings
  366. in a binary file. Note that because I chose to allow looking at binary files,
  367. I also turned off highlighting, tabbing, and formfeeds that sometimes appear
  368. in files. If you want to get a HEX dump, press the 'V' key and you will get
  369. a page by page listing of your file in both HEX and ASCII. You can edit
  370. the file you are currently pointing at in the scroll window by pressing the
  371. '*' key (shift 8). 'vi', or whatever you designated as your favorite editor
  372. in the DISKSCAN.KEY file, will be loaded, read in the file, allow you to edit
  373. and save the file, and then return you to DISKSCAN when you are done.
  374.  
  375. 3.6 ARC STuff:
  376.  
  377. To get a verbose listing of the contents of an ARC file, move to the file you
  378. want to look at and then press the = key. While the verbose listing is being
  379. displayed, you can press the CTRL-S key to pause the listing and the CTRL-Q
  380. key to continue the listing in case it is longer than one screenful.
  381.  
  382. To add all Tagged files to an ARC file, just hit the + key. You will be asked
  383. for a path name, so just type in the full path to the file you want everything
  384. arc'ed to. Note that this name can be either an existing file name or it can
  385. be a new name. The Tagged files will then be ARC'ed together. Please note that
  386. the current implementation of 'add to ARC' is horribly inefficient...but it
  387. works.
  388.  
  389. 3.7 SOMEWHAT NEAT STuff:
  390.  
  391. 3.7.1 Sorting files  (Only in the Professional version)
  392.  
  393. DISKSCAN allows you to sort all selected files (don't confuse Tagged with
  394. selected...selected files are simply everything you can currently scroll past
  395. in the file name window, whereas Tagged files are those you have Tagged with
  396. the T key for some future purpose.) By pressing the 'o' key, you will tell
  397. DISKSCAN that you wish to sort the selected files. DISKSCAN will prompt you for
  398. the sort key (i.e. file size, name, date, protections, etc) and then ask
  399. whether you want to see them in ascending or descending order). Since you can
  400. sort files over a whole file system, a sort by descending date is a useful way
  401. to tag what has changed since your last backup. A sort by ascending name is
  402. useful to find all those duplicate files. One note on sorting: I always fall
  403. back to RANDOM order upon a new selection by either search (S) or directory
  404. select (TAB). This provides the fastest response assuming you aren't always
  405. wanting to see the stuff sorted. If you really want files to be maintained in
  406. a particular order for viewing purposes, use the 'O' key to initiate your
  407. sort option. This will tell DISKSCAN to maintain that sort order throughout all
  408. subsequent file reselects...until another sort option is selected.
  409.  
  410. 3.7.2 Comparing files  (Only in the Professional Version)
  411.  
  412. An interesting feature in DISKSCAN is the ability to quickly compare files.
  413. You can use either the 'c' key or the 'C' key to perform this function. This
  414. option will use an internal routine to quickly ascertain that the files are
  415. the same or not.  To perform a compare, move the cursor to one of the files
  416. you want to compare and press the 'c' or 'C' key.  When you do so, a C will
  417. appear next to the file name and you will be prompted to go find another file
  418. to compare it against. When you have the scroll bar over the other file, press
  419. c or C again and the two files will be compared. For sanity's sake, my routine
  420. just shows the first 15 differences (byte locations and values) that the program
  421. finds. Note that you can do any number of file searches and directory matches
  422. in between selecting the first and second compare files.
  423.  
  424. 3.8 POWERFUL STuff:
  425.  
  426. 3.8.1 Doing things to a file
  427.  
  428. Because I got tired adding features to DISKSCAN, and it was getting big, I
  429. decided to add one more feature. This is probably the most powerful feature
  430. (and the most confusing) as well. I decided to make the 0-9 keys into
  431. user definable keys. I have mentioned already how to create the DISKSCAN.KEY
  432. file, so will only mention here that to use the program you have assigned to
  433. the key, just press the appropriate key. If you forget what the user defined
  434. key assignments are, just press the 'I' key and you will be given a listing of
  435. the keys (along with a summary of disk space). This programmable key option
  436. uses the system() call, so you can even invoke commands that do redirection.
  437.  
  438. Note: I know it is confusing, but I decided to map the Function keys into the
  439. number keys (i.e. key 1=F1, 2=F2, ... , 0=F10) to keep things familiar for
  440. people using both the ST and Unix versions of HDSCAN.
  441.  
  442. 3.8.2 Doing things to all Tagged files
  443.  
  444. Guess what you can also do with Tagged files? If you press the 'M' key after
  445. tagging a bunch of files, you will be prompted to press a command key (0-9).
  446. Yep, you guessed it. You can invoke any command upon all of the files that
  447. you have Tagged, one at a time. You can optionally have DISKSCAN pause after
  448. each file is 'processed' in this fashion or just let it run through all the
  449. files.
  450.  
  451. 3.9 FINAL STuff:
  452.  
  453. Now, what have I missed? There are quite a few little options that I rarely
  454. use, but that people requested for some reason or other on the ST.
  455.  
  456. 3.9.1 Renaming files
  457.  
  458. To rename a file, just hit the 'R' key and type in the new name. The file name
  459. you are currently selecting in the file window will be renamed.
  460.  
  461. 3.9.2 Creating directories
  462.  
  463. To create a directory, just press the ~ key. You will be prompted for a
  464. directory name. You can type in the complete path of the directory you want
  465. created (i.e.  C:\trb\PICTURES) or if you are already inside the directory
  466. you want to create the new dir in, just prefix the name of the new directory
  467. with a ~ character (i.e. if you see C:\trb up in the PATH window, just type:
  468.    ~PICTURES
  469. to achieve the same thing as typing C:\trb\PICTURES). This was originally
  470. intended for creating directories on the output media, so creating a directory
  471. will not cause that directory to be visible in the file selector window unless
  472. you do a rescan ('!' key).
  473.  
  474. 3.9.3 Cleaning up the disk order
  475.  
  476. To beautify ('B' key) the order that files are presented, I added an option
  477. that goes through and groups all files into disk order, rather than the RANDOM
  478. order that you will see files in upon running DISKSCAN. The RANDOM order is
  479. actually the same order that you added the disks to the diskscan database and
  480. may be preferred by some people (access is faster).  After you get used to
  481. viewing files via using the match, directory select, and sort options, you
  482. will probably never even bother using the 'B' key. Note that if you invoke
  483. DISKSCAN with a -b option from a shell you will get this option by default.
  484.  
  485. 3.9.4 eXtra STuff  (Output Options)
  486.  
  487. For sanities sake, DISKSCAN (like DISKTOP) outputs directly to a file rather
  488. than a printer. This lets you post-process the files if you so desire before
  489. printing them. To invoke the eXtra stuff option, just press the X key. You
  490. will then be presented with another menu which lists the available options
  491. (currently just 'print' options).
  492.  
  493. I have added three print options to DISKSCAN. The 1.0 version has a Short
  494. output option which puts the disk name and a columnized listing of all the
  495. files in each disk out to a file. You can then edit this file and/or print
  496. it out at your leasure. The 2.0 version has a database dump option (printing
  497. out information of the form "DISK:full_path_name/file_name size date") to a
  498. file as well as a Long output option which columnizes the name, size, and date
  499. in a two across fashion. In all cases, only the selected set of files are saved
  500. to the output file and the sort order is preserved in the 2.0 version (which
  501. is handy if you want a printout of all your pascal files sorted by reverse
  502. date but still grouped in disk order...)
  503.  
  504. 3.9.5 WARNING!
  505.  
  506. Some words of caution before you continue. First, while copying, DISKSCAN
  507. does not check to see if the destination file already exists...it will
  508. just overwrite the destination file. Second, I don't do any bounds checking on
  509. input, so if you feel you must have long directory names that require you to
  510. type in over the scroll window graphics, go ahead. You can't hurt anything
  511. that pressing the ? key twice won't solve. I know that I should really go
  512. in and prevent that from happening, but this program was designed not to be
  513. restrictive and should allow you to use it in ways I haven't planned for yet
  514. (planning for the unplanned?)  Finally, be careful about using the 'e' key.
  515. If you tag some files in one directory, then do a search for some other files
  516. and tag some of them, be aware that the previously Tagged files will also get
  517. erased (unless you un-tagged them of course). Just because you can't see the
  518. file any more in your currently selected subset of the disk does not mean it
  519. isn't Tagged (that will be obvious, actually, if you look at the total Tagged
  520. window). If you are at all unsure, just use the select option to select all
  521. Tagged files prior to deleting them ('s' and then search for '*'). Happy
  522. computing...
  523.  
  524.  
  525. 4.0 SUMMARY OF COMMANDS:
  526.  
  527. Sure, now that I have told you about all the commands I condense everything
  528. into one paragraph:
  529.  
  530. ~ key:     Create a directory  
  531. ! key:     Scan the disk in the 'scan' drive (default drive is A)
  532. # key:     Invoke selected program (i.e. the file under the cursor)
  533. + key:     Add Tagged files to an existing .arc file (or create a new one)
  534. 0-9 keys:  Run external programs (defined in DISKSCAN.KEY)
  535. = key:     Verbose Arc listing (peek at the names/sizes of ARC files)
  536. HELP/?     HELP (basically this info)/keymap info (i.e. command key bindings) 
  537. TAB key:   Select files by disk (and by directory)
  538. c keys:    Compare two files. Tricky on big files unless on the same disk..
  539. D key:     Delete (kill) current disk from database.
  540. e key:     Erase all Tagged files (verification will be requested.)
  541. G key:     Globally run external programs on all tagged files. 
  542. h/l keys:  Page up/down in the file selection window
  543. H/L keys:  Go to the Top/Bottom of the selected list of files 
  544. k/j keys:  Scroll up/down in the file selection window
  545. m/M keys:  Mass copy all tagged files with new/preserved dates. 
  546. N/P keys:  Move to the next/previous disk and select all files in it
  547. o/O keys:  Order (sort) the selected files (o=just for now, O=Always)
  548. R key:     Change name and/or attributes of file
  549. s/S keys:  Select match on all/Subset
  550. t key:     Tag a file 
  551. ALT u key: Retag all Copied files   
  552. u key:     Untag a file 
  553. ALT u key: Untag all Tagged files    
  554. v key:     View a file/strings-like 
  555. V key:     View a file in HEX/ASCII  
  556. X key:     eXtra STuff. This includes print options.
  557. Z key:     Toggles between using DISKTOP.INF vs the Disk Volume name
  558.  
  559. 5.0 Currently known bugs/limitations:
  560.  
  561.   1) Occasionally a file will show up in a directory on a floppy, but you
  562.      won't be able to access it from within DISKSCAN. This is a GEM/TOS bug
  563.      that I haven't gotten around to working out a safe fix for. I kept
  564.      hoping the new TOS would solve the problem. There is a workaround.
  565.      Open up the floppy from the desktop and then run DISKSCAN.
  566.   2) You can run some GEM programs from within DISKSCAN, but TOS seems to
  567.      get flaky if you do this too much...all I am doing is pexecs, so...
  568.  
  569.  
  570. 6.0 So you already have HDSCAN.  What's New
  571.  
  572. This section is for those ST owners out there who already know all about
  573. the old ST version of HDSCAN and thought they could skip over the docs for
  574. DISKSCAN. The following 'HDSCAN'-like features are new for DISKSCAN:
  575.  
  576.   1) More use of colors to move the eyes to the right spots on the screen. I
  577.      suppose everyone is going to bug me about picking the colors I did, but
  578.      I can always add that as a configurable option in a later release.
  579.   2) I got kind of hooked on the key configuration I set up for the Unix
  580.      version of HDSCAN, so I brought those definitions back into this version.
  581.      In most cases, the old keys you are used to will work, but things like the
  582.      h,j,k and l keys can be used in place of the Arrow key options, for
  583.      example. The only key that actually changed definition was the H)ex dump
  584.      key...it is now V)ex dump :-) and to view a file, you can still press v.
  585.   3) Would you believe Mass command key invokes? If you tag a bunch of files,
  586.      then press the M key you will be prompted for a command key (0-9). Yep,
  587.      you can now perform a user-definable command operation on all the tagged
  588.      files. I have come up with a lot of strange uses for this option.
  589.   4) Parameterized macros attached to the 0-9 keys...
  590.   5) Enhanced directory features. This includes searching while in the
  591.      disk selection mode and the ability to cycle through the disks
  592.      one at a time with the N and P keys while in file selection mode.
  593.  
  594. 7.0 FINALLY, THE END IS NEAR:
  595.   
  596. Again, have fun with the program. It is meant to be a utility that is used
  597. from time to time. It was never intended to be used as a shell, although
  598. you may link into a shell from within it if you have enough memory (DISKSCAN
  599. is a memory hog). I should also remind everyone again that this is NOT a
  600. public domain program. It is copyrighted and I am distributing it free in
  601. the hopes that I can build up interest in the professional version. While it
  602. is true that I wrote the program to satisfy a need of my own, I did put a
  603. lot more work into making it into something that everyone else could use and
  604. understand. I have switched to this method of distribution because shareware
  605. didn't work and my brief exposure to marketting a product via magazine ads
  606. made me realize that I couldn't afford to do it and still sell programs for
  607. $20 or less (which is all I really think anyone should ever have to pay for
  608. a general purpose utility).
  609.  
  610. If there is a change in DISKSCAN you feel that the world must have, send me
  611. a note and I will try to integrate it into a future version. If you want to buy
  612. the production version, just send in $20 (U.S. dollars). If you don't think
  613. it is worth that, even a letter is appreciated if you find the program useful
  614. (or if it would be useful if it had a certain feature, for that matter).
  615.  
  616.        Todd Burkey
  617.        3546 Pilgrim Ln
  618.        Plymouth, MN 55441
  619.        
  620.      trb@stag.UUCP
  621.        or ..ihnp4!meccts!stag!trb
  622.  
  623. 2/25/88  -  DISKSCAN ver 1.0 (Tool-Ware) and 2.0 (Professional)
  624.  
  625. P.S. Feel free to put the 1.0 version on any BBS's you care to. Just make
  626.      sure these DOCS are included in the ARC file along with the sample
  627.      DISKSCAN.KEY file. Hopefully, this is the same configuration you got
  628.      the program in!
  629.