home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / mac / util / filelist.sit / FileList.Doc next >
Encoding:
Text File  |  1990-05-18  |  8.7 KB  |  289 lines  |  [TEXT/PEDT]
  1. ===========================================================================
  2. "FileList"                                 Macintosh Volume And File Lister
  3. ===========================================================================
  4.  
  5.                         Version 1.3 (18-May-1990)
  6.  
  7.  
  8. ___________________________________________________________________________
  9. ABOUT FILELIST
  10.  
  11. First of all, this program is free (but NOT public domain), including the
  12. sources. So don't pay anybody for it. Make sure to include this
  13. documentation when you give the program away.
  14.  
  15. "FileList" is a file and disk organizer. It reads entire volumes and saves
  16. volume and file information. There is an option that enables StuffIt
  17. archives to be opened and to be treated like a folder: all files in the
  18. archive (including encrypted entries) will be listed.
  19.  
  20. The collected information can be displayed, sorted by multiple criteria,
  21. searched for, saved as text files (to be printed later on, or to be
  22. imported into databases). Entire volumes can be deleted or renamed. There
  23. is an automatic disk insert/eject mode, meaning any inserted disk (be it a
  24. floppy or a CD-ROM disk) gets scanned then ejected, or any mounted volume
  25. can be added by selecting from a list of on-line volumes.
  26.  
  27. "FileList" is useful for managing large collections of floppy disks, or can
  28. be used to quickly locate files on a big disk, e.g. CD-ROM.
  29.  
  30. This is version 1.3 and replaces 1.2 which has been around since 21-Aug-88
  31. and was very popular. Here is what "MacUser" December 1989 said about it:
  32. "FileList is a basic but very effective file lister. Insert a disk, and its
  33. contents are quickly listed with volume and folder paths, size, dates,
  34. creator and type. The resultant file can be printed, edited, or exported as
  35. text. The data transfers well to databases. FileList is currently the best
  36. of this type of program available."
  37.  
  38. The following main features were added to version 1.3:
  39.  
  40. * Search for files or volumes using multiple criteria.
  41. * Rename volumes.
  42. * Scanning of StuffIt archives.
  43. * Extended keyboard support.
  44. * This documentation.
  45.  
  46. "FileList" should run on any Macintosh Plus or newer Macintosh. HFS
  47. (Hierarchical File System) is required, but MFS (Macintosh File System)
  48. disks are supported. I used System 6.05 with MultiFinder 6.1b9 on a
  49. Macintosh Plus and Macintosh IIcx to develop and test the program. The
  50. program was developed with THINK C 4.02 and the source code is available.
  51.  
  52.  
  53. ___________________________________________________________________________
  54. WINDOWS
  55.  
  56. There are always two windows: a volume window and a file window. The title
  57. of each window shows how many entries are in the each list. The windows can
  58. be moved around, resized and zoomed. Clicking in the close box sends the
  59. window to the back, showing the other window. The window positions and
  60. sizes can be saved with the options (see options below).
  61.  
  62. Each volume or file entry is on one line. A line can be selected by
  63. clicking on it. Clicking on a selected line deselects the line again. The
  64. "Copy" menu item (or function key F3) copies the selected line to the
  65. clipboard as text.
  66.  
  67. The scroll bars can be used to move around in the list as expected. The
  68. following keyboard keys can be used to navigate:
  69.  
  70. home            Scroll to beginning of list
  71. end             Scroll to end of list
  72. page up         Scroll one page up
  73. page down       Scroll one page down
  74. cursor keys     Scroll one line up/down or column left/right
  75.                 (use the option key to scroll one page left/right)
  76. return, enter   Move to selection
  77.  
  78.  
  79. ___________________________________________________________________________
  80. MENUS
  81.  
  82. *** File Menu ***
  83.  
  84. New
  85.     Clear current list. Create new empty volume and file list.
  86.  
  87. Open...
  88.     Open existing list from existing FileList file.
  89.  
  90. Close
  91.     Same as clicking in the close box of the active window.
  92.  
  93. Save
  94.     Save list into FileList file.
  95.  
  96. Save As...
  97.     Save list into FileList file under new name.
  98.  
  99. Save Text...
  100.     Export list of active window (volumes or files) into text file.
  101.     (Note that text files cannot be opened again by FileList!)
  102.  
  103. Default Windows
  104.     Resize and reposition windows to default settings.
  105.     (Default settings can be set with the Options... dialog)
  106.  
  107. Options...
  108.     Options dialog.
  109.  
  110. Quit
  111.     Quit the application.
  112.  
  113.  
  114. *** Edit Menu ***
  115.  
  116. Undo
  117.     Not used.
  118.  
  119. Cut
  120.     Not used.
  121.  
  122. Copy
  123.     Copy selected line to clipboard.
  124.  
  125. Paste
  126.     Not used.
  127.  
  128. Clear
  129.     If the option key is also pressed this clears both the volume and file
  130.     index tables.
  131.  
  132. Find...
  133.     Find dialog.
  134.  
  135. Find Again
  136.     Find next item.
  137.  
  138. Move To Selection
  139.     Bring selected item into view (same as return or enter key).
  140.  
  141.  
  142. *** Volume Menu ***
  143.  
  144. Automatic
  145.     Select/deselect automatic insert/eject mode.
  146.     (Can also be selected by using the Options... dialog)
  147.  
  148. Add...
  149.     Show on-line (mounted) volumes. Select those to add to list.
  150.  
  151. Delete
  152.     Delete selected volume from the list, and all its files.
  153.     (Note that this deletes the volume in the list, not on the disk!)
  154.  
  155. Rename...
  156.     Rename selected volume.
  157.     (Note that this renames the volume in the list, not on the disk!)
  158.  
  159.  
  160. *** View/Files ****
  161.  
  162. by name
  163. by size
  164. by type
  165. by creator
  166. by created
  167. by modified
  168. by volume
  169. by path
  170.  
  171.  
  172. *** View/Volumes ***
  173.  
  174. by name
  175. by free
  176. by total
  177. by files
  178. by created
  179. by modified
  180.  
  181.  
  182. ___________________________________________________________________________
  183. OPTIONS
  184.  
  185. This dialog presents the following options:
  186.  
  187. * Automatic disk insert/eject
  188.     Anytime a disk is inserted, it is scanned, added to the list, then
  189.     ejected. This works with any movable medium: floppy disks, CD-ROM
  190.     disks, ...
  191.  
  192. * Recognize StuffIt archives
  193.     Anytime a StuffIt archive is found it is treated like a folder, i.e.
  194.     all its files, folders, sub-folders, ... are listed.
  195.  
  196. * Use tabs between fields
  197.     When exporting the list to a text file, tabs are put between fields,
  198.     instead of spaces. This is used to import the data into databases.
  199.  
  200. * Date format
  201.     Select the data format you want. The format selected will be used to
  202.     show the dates on the screen and to export to text files.
  203.  
  204. * Set default window settings
  205.     The current window positions and sizes become the default values.
  206.  
  207. You can press the following buttons:
  208.  
  209. * Ok
  210.     Options take effect but are not saved.
  211.  
  212. * Save
  213.     Options take effect and are saved in a settings file in the System
  214.     folder.
  215.  
  216. * Cancel
  217.     Nothing happens.
  218.  
  219. If you press the option key while choosing the options menu item the
  220. following memory options can be set, but become active only on the next
  221. program start:
  222.  
  223. * Heap size
  224.     The heap size that should remain after "FileList" has allocated all
  225.     it's tables. You should leave at least 30000 Bytes for the heap.
  226.  
  227. * Volumes percentage
  228.     The percentage of how many volume records (any volume, folder and file
  229.     is considered a record) are expected. Clicking on the associated text
  230.     automatically calculates and displays the current volume percentage.
  231.  
  232. * Files percentage
  233.     The percentage of how many file records (any volume, folder and file is
  234.     considered a record) are expected. Clicking on the associated text
  235.     automatically calculates and displays the current file percentage.
  236.  
  237. * Average name size
  238.     Average name size (of volumes, folders and files) expected. Clicking on
  239.     the text automatically calculates and displays the current average name
  240.     size.
  241.  
  242. These values are used by "FileList" to allocate its tables. Everything must
  243. fit into available memory. You can use the "About FileList..." menu item in
  244. the Apple menu to see how memory is allocated. To get more memory under
  245. MultiFinder for longer lists use the Finder's "Get Info" command. E.g. to
  246. be able to list all files on my "EduCorp CD-ROM 4.0" disk containing 14550
  247. files I must set the partition size to 1000 K.
  248.  
  249.  
  250. ___________________________________________________________________________
  251. FIND
  252.  
  253. The find dialog corresponds to the selected window: Files or volumes. For
  254. both you can search by giving part of the name. Enter a string and set one
  255. of the following radio buttons:
  256.  
  257. * Equals
  258.     The search string must be exactly equal to the name.
  259.  
  260. * Starts
  261.     The name must start with the search string.
  262.  
  263. * Includes
  264.     The name must include the search string.
  265.  
  266. * Ends
  267.     The name must end with the search string.
  268.  
  269. That's all for volumes. For files there are two more criteria: file type
  270. and file creator. If the type or the creator is not filled out it is not
  271. used, otherwise it must exactly match (4 characters). One can also use an
  272. empty name string and only find files based on the type and creator, or
  273. type alone, or creator alone, or any possible combination thereof.
  274.  
  275.  
  276. ___________________________________________________________________________
  277. COMMENTS
  278.  
  279. Send any comments to:
  280.  
  281. CompuServe  : 73720,2200
  282. Internet    : 73720.2200@compuserve.com
  283. Packet Radio: LX1YZ @ LX0PAC
  284.  
  285. Erny Tontlinger
  286. 33 route d'Arlon
  287. L-8410 Steinfort
  288. Luxembourg
  289.