home *** CD-ROM | disk | FTP | other *** search
/ Best of Big Blue Disk / bbdbest.zip / INDEXER.TXT < prev    next >
Text File  |  1987-09-15  |  15KB  |  319 lines

  1. |D╔══════════╗════════════════════════════════════════════════════════════════════
  2. |D║ |5Helpware |D║════════════════════════════════════════════════════════════════════
  3. |D╚══════════╝════════════════════════════════════════════════════════════════════
  4.  
  5. ^C^1Disk Indexer
  6. ^Cby
  7. ^CDaniel Tobias
  8.  
  9.    You've been using your PC for a while.  You've probably built up quite a 
  10. stack of diskettes containing the programs, data files, text files, etc., that 
  11. you have been working on.  Most likely, you often forget which disk a given 
  12. file is on and have to do a long, tedious search. 
  13.  
  14.    Or maybe you upgraded to a hard disk and thought that it would solve all of 
  15. your problems.  However, as you created more and more subdirectories and sub-
  16. subdirectories to hold everything, you faced a similar problem when it came to 
  17. remembering just which subdirectory contained some elusive file. 
  18.  
  19.    DISK INDEXER will solve these problems.  It will let you create a master 
  20. index of a collection of floppy disks, or all or part of a hard disk.  The 
  21. index is an alphabetized list of the files on all indexed disks, along with 
  22. their size, creation date, and (most importantly) where they can be located.  
  23. You can output all or selected parts of this index to your screen or printer. 
  24.  
  25.    DISK INDEXER has many options and features.  The best thing to do is to 
  26. print out this text and have it in front of you as you go through the program.  
  27. What follows is a description of the items on the menu.  Many of these items 
  28. invoke sub-menus; in each of these menus, you can return to the main menu by 
  29. pressing the ESC key. 
  30.  
  31.  
  32. ^C(I)ndex disks
  33.  
  34.    Select I to index disks, and you will be prompted to "Insert disk to 
  35. index."  DISK INDEXER will expect to find this disk in drive A.  (Later, you 
  36. will find out how to change this in order to use other floppy or hard disk 
  37. drives.)  Place any MS-DOS formatted disk (for example, BIG BLUE DISK, or your 
  38. MS-DOS system disk) in drive A and press the space bar.  If you really didn't 
  39. want to index disks, press ESC to return to the menu. 
  40.  
  41.    Next, DISK INDEXER will tell you the disk I.D.  The I.D., which is obtained 
  42. from the volume label, will be used in your index as an indication of where 
  43. each file is, so make sure it reflects the name by which you know the disk. 
  44.  
  45.    This disk has a label of "BOBBD VOL 1", so that is what will show as its 
  46. I.D. if that is the disk you inserted. 
  47.  
  48.    Press the ENTER key to accept the I.D. as given, or press the backspace key 
  49. to use a different string.  If you decide you really didn't want to index that 
  50. disk, press ESC to get back to the previous prompt; press ESC again to return 
  51. to the menu. 
  52.  
  53.    Once you press ENTER, the disk's directory will be read, sorted, and added 
  54. to your index.  DISK INDEXER will tell you how many files it added to the 
  55. index, and prompt for another disk.  Continue inserting disks to index, and 
  56. repeat the above sequence for each disk.  When done, press ESC instead of the 
  57. space bar when prompted to insert a disk. 
  58.  
  59.    If DISK INDEXER encounters more than one file of the same name under the 
  60. same disk I.D. (as might happen if you should insert the same disk twice 
  61. during the indexing process), only one entry of that filename will be kept; 
  62. file size and date information for this entry will be taken from the most 
  63. recently inserted disk with that file.  Duplicate filenames with different 
  64. disk I.D.'s will appear in the index as many times as there were occurrences 
  65. of that filename with different I.D.'s. 
  66.  
  67.  
  68. ^C(D)rive/Path/Mask Selection Options
  69.  
  70.    Here is where you tell DISK INDEXER which drive to use.  The default is 
  71. drive A, but you can indicate any drive or path.  Selecting the D command from 
  72. the main menu brings you a submenu containing three modifyable parameters. 
  73.  
  74.    Option 1 lets you enter a new value in standard MS-DOS syntax for the drive 
  75. and path to search.  For example, "A:\" selects the root directory of drive A, 
  76. "C:\" selects the root directory of drive C (usually a hard disk), and "C:" 
  77. (with no backslash) selects the current directory of drive C. 
  78.  
  79.    Normally, if you are indexing floppy disks, you will use "A:\", which is 
  80. the default value when you start DISK INDEXER.  For indexing a hard disk, 
  81. "C:\" is the normal value if you are starting at the root; you can also select 
  82. a subdirectory like "C:\GAMES\" if you only want to index parts of the disk. 
  83. You may enter subdirectory names with or without a terminating backslash; a 
  84. backslash (\) will be added automatically to the end of the string you type if 
  85. its last character is not already a backslash or colon. 
  86.  
  87.    Option 2 will toggle the Recursive Directory Search option.  If this option 
  88. is on, DISK INDEXER will automatically search for and index all subdirectories 
  89. of a directory it has just indexed.  This continues recursively, so that if 
  90. you start at the root directory, all directories of the disk will be indexed.  
  91. This option is primarily of use when you wish to index your whole hard disk, 
  92. but it can also be used on floppies with subdirectories, to make sure all 
  93. files are indexed. 
  94.  
  95.    Option 3 allows you to set a file mask.  This is a MS-DOS wildcard 
  96. expression, used to specify which files on your disks will be indexed. The 
  97. default is "*.*", which means all files. 
  98.  
  99.    You can change this to index only selected files; for instance, using the 
  100. mask "*.BAS" will limit the index to files with a .BAS extension. A mask of 
  101. "TEST*.*" will index only files whose names begin with "TEST". 
  102.  
  103.  
  104. ^C(F)ile type selection options
  105.  
  106.    This command allows more choices regarding which files are indexed.  In 
  107. this section, you can press the number keys 1 through 4 to toggle between 
  108. including and excluding several types of files. 
  109.  
  110.    Option 1 is zero-length files; these are files, like the delimiter files of 
  111. BIG BLUE DISK, that have only a directory entry, but no data.  These are 
  112. generally used only to make the directory listing more attractive; you 
  113. probably don't want them in your index.  Thus, you can turn this option off so 
  114. that these files are not included. 
  115.  
  116.    Options 2 and 3 refer to hidden and system files respectively.  These are 
  117. special file types which don't normally show in your directory.  The MS-DOS 
  118. program itself is contained in system files on your system disk.  Some utility 
  119. programs can convert data files into hidden files so that others can't see 
  120. where they are.  These sorts of files will not normally be indexed by DISK 
  121. INDEXER, but if you toggle these options, they will be included. 
  122.  
  123.    Option 4 lets you choose whether or not to index the file COMMAND.COM. This 
  124. file is on all bootable disks, so you may have many copies in your disk 
  125. collection.  Hence, you might wish to turn this off so that this file does not 
  126. appear in your index. 
  127.  
  128.    The default when you start DISK INDEXER is to include zero-length files and 
  129. COMMAND.COM, but exclude hidden and system files.  This means that all files 
  130. that are visible in a normal DIR listing will get indexed, and no others. 
  131.  
  132.  
  133. ^C(P)ick system for getting disk ID
  134.  
  135.    This section allows you to choose how DISK INDEXER finds the name of each 
  136. disk or subdirectory.  This information can be obtained in one of several 
  137. ways, selectable by pressing a number from 1 to 4, or using the up and down 
  138. arrows to move a pointer between these four items.  There is also a fifth 
  139. option which can be toggled independently of these.  The choices are as 
  140. follows: 
  141.  
  142. (1) Use the disk volume label, which MS-DOS adds when you format a disk.
  143.  
  144. (2) If you are indexing your collection of issues of BIG BLUE DISK,
  145. use the STATUS.DAT file, which contains the issue number information.
  146.  
  147. (3) For indexing hard disks (or floppies which contain subdirectories) use the 
  148. pathname of each directory. 
  149.  
  150. (4) You can be prompted to type a name for each disk or directory as it is 
  151. indexed.
  152.  
  153. (5) You may also choose to have the I.D. value confirmed before you proceed 
  154. with indexing; this will give you a chance to see what data is being used and 
  155. change it if you wish.  Or you can disable the confirmation, so the indexing 
  156. goes faster.  Press 5 to toggle this option.  If you do a recursive directory 
  157. search, you'll probably want to turn the confirmation option off; otherwise, 
  158. there will be a pause at each subdirectory.
  159.  
  160.  
  161. ^C(R)ead index data file from disk.
  162.  
  163.    When you select this option, you will be prompted for a filename.  This 
  164. should be the name of a file which you have previously saved with the W 
  165. command (described below).  All index data in this file will be loaded, 
  166. overwriting any index data already in memory. 
  167.  
  168.  
  169. ^C(W)rite index data to disk.
  170.  
  171.    This option will prompt you for a filename, then save the index data, so 
  172. that it can later be loaded with the R command described above, or merged with 
  173. the M command described below. 
  174.  
  175.  
  176. ^C(E)dit or delete index data.
  177.  
  178.    Once you have created a large index, you might decide that there are some 
  179. entries that shouldn't be there, or aren't quite the way you wanted; thus, an 
  180. edit feature lets you select one or more entries and manually change the data 
  181. in the selected records, or delete them entirely.  This editing can be 
  182. performed on the data in memory, or in a disk file previously created through 
  183. the W command or through merges. 
  184.  
  185.    There are six options on this sub-menu, as follow:
  186.              
  187.    Option 1 will toggle between the "Edit" and "Delete" functions. Edit lets 
  188. you make changes in the data in a record, while Delete removes the record 
  189. entirely. 
  190.  
  191.    Option 2 lets you input a search string to indicate what records to select.  
  192. A search string is any ASCII string.  How it is used depends on the status of 
  193. option 3 below. 
  194.  
  195.    Option 3 toggles between looking for the search string in the filename or 
  196. the I.D. (location) string of each record.  In either case, records will be 
  197. selected if the search string occurs at any point in the appropriate field.   
  198. For example, the string "RAT" would select "RATES.DAT", "BRAT.TXT", and 
  199. "MUSK.RAT".  (Note that this works differently from MS-DOS wildcard 
  200. expressions; the * and ? operators are not supported here.) 
  201.  
  202.    Option 4 toggles between pausing to confirm each selected record, or just 
  203. performing the requested action without a pause.  Enable this option if you 
  204. wish to be given a choice of whether to edit (or delete) each record 
  205. individually. 
  206.  
  207.    Option 5 toggles between performing the edit or delete directly in memory 
  208. or in a disk file. 
  209.  
  210.    Option 6 lets you input the name of the index file you want to edit, if you 
  211. have used option 5 to edit or delete in a disk file. 
  212.  
  213.    Option 7 will perform the edit or delete function.  In the case of an edit, 
  214. all fields of the entry will be displayed, and you can change any of them 
  215. except the filename by typing the appropriate number and entering a new value. 
  216.  
  217.  
  218. ^C(C)lear the index data in memory.
  219.  
  220.    This command causes all index data in memory to be cleared, so that you can 
  221. start fresh with a new index. 
  222.  
  223.  
  224. ^C(M)erge index data.
  225.  
  226.    DISK INDEXER will index up to 5000 files, provided you have sufficient 
  227. memory.  (640K systems handle 5000 files; 256K systems support a little over 
  228. 1300 files; other memory configurations should have limits somewhere in 
  229. between.)  You will be warned when the limits are close to being reached. 
  230.  
  231.    This should be sufficient for garden-variety indexing, but if you want to 
  232. make a really massive index of your entire disk collection, your 30-megabyte 
  233. hard disk, or all of the above, you might run out of room.  Thus, still 
  234. another option has been provided.  The Merge command will merge the data in 
  235. memory into a previously-saved index data file, or merge two index data files.  
  236. (It will also merge a disk file into memory, but this is of course subject to 
  237. the limitations on the number of entries in memory.)  Thus you can keep 
  238. indexing until you approach the 5000-file limit, save the data to disk; next 
  239. clear the data and start a new index with the rest of your disks; and finally 
  240. merge the two indexes together to create a fully-alphabetized index containing 
  241. everything.  In this way, you can produce indexes that are limited only by the 
  242. disk storage space. 
  243.  
  244.    You choose which type of merge to perform by pressing a number from 1 to 3, 
  245. or using the up and down arrow keys to move a pointer between the options, 
  246. Merge Memory to Disk File, Merge Disk File to Disk File, and Merge Disk File 
  247. to Memory. 
  248.  
  249.    4 lets you select the input file name, if applicable.  5 lets you select 
  250. the output file name, if applicable.  6 performs the merge. 
  251.  
  252.  
  253. ^C(O)utput an index report.
  254.  
  255.    Once you have completed an index, you can output a report of all or 
  256. selected files to your screen or printer.  Selecting this command brings up 
  257. the following options: 
  258.  
  259.    Option 1 toggles whether the report will be based on the index data in 
  260. memory, or a disk file. 
  261.  
  262.    Option 2 toggles whether the output is to the screen or the printer.
  263.  
  264.    Option 3 lets you select the filename to read, if the report is to be of a 
  265. disk file. 
  266.  
  267.    Option 4 lets you input a search string; this works in the same manner as 
  268. the search string for the Edit function. 
  269.  
  270.    Option 5 toggles between finding the search string in the filename or the 
  271. I.D. string. 
  272.  
  273.    Option 6 prints the report. 
  274.  
  275.  
  276. ^C(S)ave parameters to a file.
  277.  
  278.    Since there are a number of parameters controlling different options of 
  279. this program, and your preferred values might not agree with the defaults 
  280. specified by the programmer, there is an option to save the parameters to a 
  281. disk file.  When you later load the parameters from the saved file, all the 
  282. choices and options will be set to what they were when you saved them.  You 
  283. can specify a filename to save, so you can save several sets of parameters -- 
  284. perhaps one for indexing floppies and another for a hard disk. 
  285.  
  286.  
  287. ^C(L)oad parameters from a file.
  288.  
  289.    This command will load parameters which have been saved with the S command.
  290.  
  291.  
  292. ^C(V)iew directory of a disk.
  293.  
  294.    This command lets you see a list of the files on a disk.  This is helpful if 
  295. you want to find the name of the index or parameter data files you have saved, 
  296. or you wish to see what is on a disk before you index it.  You will be 
  297. prompted for a drive/path/mask specification in the standard MS-DOS syntax. 
  298. For example, "C:\STUFF\*.*" will give you all files in the subdirectory STUFF 
  299. of drive C, while "A:*.TXT" will show you all files with the extension ".TXT" 
  300. on the disk in drive A. 
  301.  
  302.  
  303. ^C(Q)uit.
  304.  
  305.    This command causes DISK INDEXER to exit, and return you to BIG BLUE DISK. 
  306.  
  307.    If you do disk swapping in the course of indexing disks and/or saving your 
  308. index data to your own disk, be sure to replace BIG BLUE DISK (and your MS-DOS 
  309. disk, if necessary) in the same drives they were in at the time you started 
  310. running DISK INDEXER, before you exit the program.  Otherwise, you might 
  311. encounter difficulty re-connecting to the BIG BLUE DISK menu. 
  312.  
  313.    To run this program outside BEST OF BIG BLUE DISK, type: ^1PASRUN INDEXER^0.
  314.  
  315. DISK FILES THIS PROGRAM USES:
  316. ^FINDEXER.CHN
  317. ^FPASRUN.COM
  318. ^FRETURN.CHN
  319.