home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / fileutil / flopicat.arj / FLOPICAT.DOC < prev    next >
Encoding:
Text File  |  1990-12-07  |  10.2 KB  |  237 lines
  1.                  FlopiCat - the FLOPpy dIsc CATaloguer
  2.                  -------------------------------------
  3.                                    
  4.                                    
  5.                              by Rob Davis
  6.                                    
  7.                   Sysop, <<tWO>> the Watch Office BBS
  8.  
  9.  
  10.  
  11.                          Why FlopiCat anyway?
  12.  
  13. Like many computerists I have a large selection of software stored or
  14. archived on floppy discs in a cardboard box full of floppy boxes. 
  15. Whilst I knew reasonably accurately what was on the discs, a recent
  16. hunt through them revealed not only a lot of apparent file
  17. duplications but also some files missing which were supposed to be
  18. there, and some files there which I had either forgotten or didn't
  19. even know about.
  20.  
  21. A further search through the several hundred floppies did not produce
  22. a floppy disc cataloguer so I wrote FlopiCat.  FlopiCat scans the
  23. contents of a floppy disc, including all subdirectories, and stores
  24. each file's details in a master file on your hard disc.  Each floppy
  25. has a disc number which is also stored; and as each filename is shown,
  26. you can enter a description.
  27.  
  28. Naturally you can interrogate the database and find a file by filename
  29. or description.  It makes the cataloguing of a floppy disc collection
  30. very easy, and as the data file is a simple random-access type, you
  31. can easily import it into Dbase, Pc-File etc and work with it in a way
  32. which FlopiCat might not.
  33.  
  34. FlopiCat is written in QuickBASIC v4.5 with help from John Sutcliffe's
  35. SLIB library.  In fact without SLIB the program would never have been
  36. written; thank you John!
  37.  
  38.  
  39.                           System Requirements
  40.  
  41. FlopiCat requires an IBM-PC or clone running Ms-Dos v2.00 or later. 
  42. Whilst it is possible to run it on a twin floppy machine, a hard disc
  43. is strongly recommended.  If you run FlopiCat on a floppy drive, note
  44. that it MUST be run from Drive B:.  It will refuse to run from Drive
  45. A: because that is the drive it will try and read files from.
  46.  
  47. The program requires about 170k to run and works in text mode only, so
  48. it should operate on any monitor type.  I have tried it on CGA, EGA,
  49. VGA, and Hercules without problems.  A printer on LPT1 is also
  50. recommended.
  51.  
  52.  
  53.  
  54.                           Loading and Running
  55.  
  56. To run FlopiCat, copy it to a directory on your hard drive, preferably
  57. not the root.  FlopiCat stores its data in the default directory.  At
  58. the system prompt, enter:-
  59.  
  60. FLOPICAT     (for colour display)
  61. FLOPICAT m   (for monochrome display)
  62.  
  63. You can toggle between colour and mono whilst the program is running
  64. by pressing the hash key.  (On some keyboards, this may be the pound
  65. sterling key).  The 'm' option is to make it easier to run the program
  66. in mono from a batch file.  (To configure your own colours, see the
  67. section at the end of these notes.)
  68.  
  69. The first thing you need to know after loading the program is how to
  70. get out again.  Press [ESC] and FlopiCat asks 'are you sure' before
  71. returning you to the system prompt or whatever it was that your
  72. computer was doing before you loaded FlopiCat.
  73.  
  74. At the top of the screen is the header.  This tells you which version
  75. of FlopiCat you have got and in the right hand corner, how many
  76. records you have created, and whereabouts you are in the stack of
  77. records.  At first of course this will read zero.
  78.  
  79. At the bottom of the display is the status bar.  This tells you what
  80. you can do.  If you cannot see an option displayed on the status bar,
  81. you cannot use that particular option.  For example you cannot Print,
  82. Edit, Sort or Search the records when there aren't any!
  83.  
  84.  
  85.  
  86.                              Moving About
  87.  
  88. FlopiCat always displays as many records as it can either side of the
  89. current position in the stack of records.  This means that usually,
  90. the record under the highlight bar will be in the middle of the
  91. screen, and the display scrolls vertically in response to the keys you
  92. press.
  93.  
  94. Use the normal cursor and word processor keys Up / Down / PgUp / PgDn
  95. / Home / End to move up and down the record stack.  [Home] takes you
  96. to the top, [End] to the bottom.  [PgUp] and [PgDn] go 10 records at a
  97. jump; [Up] and [Down] one record.  If you are at the the top and you
  98. press [Up] you will go to the bottom, and vice versa.
  99.  
  100.  
  101.  
  102.                         Cataloguing A New Disc
  103.  
  104. Press [C] for [C]at.  You will be asked to put your floppy in drive A:
  105. and press [RETURN] to proceed, or [ESC] to abort.  If the drive or
  106. disc is faulty, FlopiCat will tell you and prompt you to check out the
  107. problem.
  108.  
  109. FlopiCat then reads each file in turn off the disc.  It ignores
  110. subdirectory names, although all the files, no matter how deeply they
  111. are embedded in subdirectories, will be found; even invisible, system
  112. or other files.
  113.  
  114. Firstly, it asks you for a disc number.  This can be anything between
  115. 0000 and 9999, but you have to use a numeric number such as '0123' you
  116. can't have 'AB12' as the disc number.  FlopiCat knows the most
  117. recently used disc number, and when you catalogue a new disc, it will
  118. suggest the next logical number as a default, ie if the last one was
  119. 0145 the next one will be 0146 unless you change it.
  120.  
  121. (It is up to you how you number your floppies; you may prefer a
  122. straight logical progession, although personally I use the first two
  123. number as a 'disc group' ie 01 for personal data, 02 for source code,
  124. 03 for wordprocessed stuff, etc etc. with the last 2 digits as the
  125. actual disc number.  This way I can see at a glance into which group a
  126. disc belongs, and a card inside my the cardboard carton I use as a
  127. floppy disc archive box shows me which group is which.  But this is up
  128. to you.)
  129.  
  130. Next the file details are read and shown on the screen; you can't edit
  131. these, but you can enter up to 39 characters of description.  This can
  132. consist of anything you choose to key in.  FlopiCat knows some of the
  133. more popular Ms-Dos filenames and will sometimes suggest a description
  134. as a default.  You are free to type over this if you like.
  135.  
  136. Flopicat also knows when it has read the volume label and describes
  137. this as such, although it will think that any file with a zero
  138. bytecount is the volume label.  It will also retain the most recent
  139. description which you entered as a default; this is unaffected by any
  140. 'automatic' guesses it may make.  If you accept the defaults it
  141. suggests, just press [ENTER] but otherwise key in your own
  142. description.
  143.  
  144. This process is repeated until the entire disc contents are
  145. catalogued, whereupon you are prompted to remove the disc and you
  146. return to the normal status bar display.
  147.  
  148. Note that you cannot escape from cataloguing a new disc until all the
  149. files are scanned.  This is deliberate, and prevents you from missing
  150. some files off a disc by mistake.
  151.  
  152.  
  153.  
  154.                         Searching for an Entry
  155.  
  156. You can interrogate the catalogue data by searching for either a
  157. filename or a description.  Press [F] for a filename search or [D] for
  158. a description search.  FlopiCat will find words-within-words, ie it
  159. will find CESS inside WordProcessor.  The searches are not case
  160. sensitive.  If FlopiCat finds the record you want, it displays it.  If
  161. it finds any more, it asks 'continue search ?   [y/n]' and if you
  162. press [N] the search stops.  FlopiCat searches from the 1st position
  163. in the record stack to thge last one.
  164.  
  165.  
  166.  
  167.                                 Sorting
  168.  
  169. FlopiCat can sort the date by Disc Number, Filename, or Description,
  170. as you wish.  When you press [S] for Sort, you are asked which way you
  171. want the data sorted.  [N] for Disc Number, [F] for Filename, [D] for
  172. Description.  Press the appropriate key, or [ESC] to abort.
  173.  
  174. I am afraid that with more than a couple of hundred records, the
  175. sorting is rather slow.  If FlopiCat can perform the sort in memory,
  176. it does so, and this is quite fast.  However, is the size of the data
  177. file is larger than the amount of free memory, FlopiCat does an on-
  178. disc sort.  If you have an 8mHz computer and upwards of 500 records, I
  179. suggest that you import the file into Pc-File or other database and
  180. sort it using that, afterwards exporting the data as a random (fixed
  181. length) file.  Here is the data dictionary :-
  182.  
  183.                        DiscNumber$    4   bytes
  184.                        FileSpec$     35   bytes
  185.                        Description$  39   bytes
  186.                        ------------------------
  187.                        record length 78   bytes
  188.  
  189. There is a blank configuration header for Pc-File bundled with this
  190. archive; this will import the data produced by FlopiCat and let you
  191. use Pc-File to sort it in whatever way you wish.  I will hopefully be
  192. able to improve the built-in sorting speed in later versions.
  193.  
  194.  
  195.  
  196.                                Dos Shell
  197.  
  198. A Dos Shell can be invoked by pressing Shift/6 or the Caret [^].  This
  199. temporarily exits FlopiCat and allows you normal access to Dos
  200. commands, or you may load and run other programs provided that you
  201. have enough memory left.  To re-enter Flopicat, exter EXIT at the Dos
  202. prompt.  This does not damage the data in any way, as the file is
  203. closed prior to the shell and reopened afterwards.
  204.  
  205. However, you must resume FlopiCat in the directory where it is stored. 
  206. If you change directory during the shell, change back to the one where
  207. FlopiCat is before you enter the EXIT command.
  208.  
  209.  
  210.  
  211.                         Customizing the Colours
  212.  
  213. To customise the colours, use a text editor to amend the FLOPICAT.CFG
  214. file which is included in the archive.  This configuration file
  215. contains the standard Microsoft colour codes, in the following order:
  216.  
  217. Black, Blue, Green, Cyan, Red, Magenta, Yellow, White
  218. LowBlack, LowBlue, LowGreen, LowCyan, LowRed, Low Magenta, LowYellow,
  219.     LowWhite
  220.  
  221. The default settings are:-
  222.  
  223. 8, 9, 10, 11, 12, 13, 14, 15
  224. 0, 1, 2, 3, 4, 5, 6, 7
  225.  
  226. Change these values as you wish and store the FLOPICAT.CFG file in the
  227. same directory where FlopiCat is to be run.  The program will read the
  228. configuration file if it exists; if it doesn't exist, the default
  229. colours are used anyway.
  230.  
  231.                                Thank You
  232.  
  233.     Thanks to all the people who have test driven this program and
  234.              responded with comments and useful criticism.
  235.                                    
  236.                Rob Davis, "Elsham" 113 LE9 6SA, England.
  237.