home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d7xx / d785 / filestorage.lha / FileStorage / FileStorage.doc < prev    next >
Text File  |  1992-12-23  |  12KB  |  301 lines

  1.  
  2.  
  3.                              File storage v1.2
  4.  
  5.                               by Joep Grooten
  6.  
  7.                        (c) Digital Intelligence 1992
  8.  
  9.  
  10.  
  11. What is file storage ?
  12.  
  13. File  Storage  is  a  file  librarian,  a database for files.  The database
  14. exists  of  a  number of index files (index files contain information about
  15. files  in the collection) and disks where File Storage puts your collection
  16. of files.  You can add files to the collection and File Storage will put it
  17. on  a  disk  for  you.   File  Storage 'remembers' how many free bytes each
  18. storage disk has and tries to fill the disks to the maximum.  For each file
  19. you  can  add  a 320 characters long description and set 16 different (user
  20. definable)  filetypes.   Searching  / adding / deleting / changing it's all
  21. there !
  22.  
  23.  
  24. INDEX
  25.  
  26. 1.0  Installation
  27. 1.1  Explanation of main screen gadgets
  28. 1.2  Preferences
  29. 1.3  Print menu
  30. 1.4  About
  31. 1.5  Quit
  32. 1.6  Total free bytes
  33. 1.7  Total Info
  34. 1.8  Date search
  35. 1.9  No description search
  36. 2.0  Filetype search
  37. 2.1  Check disks
  38. 2.2  Distribution
  39.  
  40.  
  41. 1.0  Installation
  42. In   the   package   of   filestorage   you'll   find   'FileStorage'   and
  43. 'FileStorage.small'.   'FileStorage.small'  is  a  limited  version  of the
  44. normal  File  Storage.   It's limited in it's use (only 5 disks).  The file
  45. 'FileStorage'  is  ment  for  registered users.  If you have registered for
  46. FileStorage  use the program 'Unlock' to unlock 'FileStorage'.  Just double
  47. click  it's  icon  or type 'Unlock' in the CLI.  Unlock will prompt you for
  48. your name and key (the key you received when you registered) If you type in
  49. your  name  and key correctly (key must be in UPPERCASE !) Unlock will make
  50. the program FileStorage usable.
  51.  
  52. When you startup FileStorage for the first time you'll see a requester that
  53. will tell you the preferences can't be found.  Just click 'Okay' and you'll
  54. enter  the  Preferences menu.  Change the preferences to your own needs and
  55. click 'Save Prefs'
  56.  
  57. Data directory : Disk/Directory where to keep the datafiles for FileStorage
  58. Disk Name      : Name to use for floppy disks to store your files
  59.                  example : 'Storage-#'  (FileStorage puts numbers behind it
  60.                  starting at zero)
  61. Safety Bytes   : Number of bytes to keep free on each disk. Just to be sure
  62.                  it fits.
  63. Printer output : Name of the device to send printer output to
  64. Prt prefix     : This string will be printed BEFORE the filename
  65. Prt suffix     : This string will  be printed  AFTER  the filename (You can
  66.                  use  Prt  prefix  and  postfix  to  print  filenames in  a
  67.                  different font for example)
  68. Edit file types: Will be explained later in this documentation.
  69.  
  70. After  you  clicked  'Save  Prefs'  a requester will appear 'Can't open...'
  71. Click   'Yes'   and  the  index  file  for  filestorage  will  be  created.
  72. FileStorage now is ready to use.
  73.  
  74.  
  75. 1.1  EXPLANATION OF MAIN SCREEN GADGETS
  76.  
  77. * [Addfile(s)] Adds one or more files to your collection.  For each program
  78. it  searches  for  a  disk  where  it  will fit.  Added files appear in the
  79. listview  gadget at the bottom of the screen.  To select more than one file
  80. keep shift pressed and click on files you want to add.
  81.  
  82. *  [Search for text] Searches the entire collection for a piece of text (it
  83. searches  both  filenames  and descriptions) Usage of wildcards is allowed.
  84. When  the  search  string  is  found, the entry will appear in the listview
  85. gadget. Search is NOT case sensitive.
  86.  
  87. *  [Add  file(s) no copy] Adds a file to the collection without copying it.
  88. This  is  handy  when  a file is already on a storage disk, but you haven't
  89. cataloged  it  yet.   Insert  the disk containing the file in a disk-drive.
  90. You'll  have to know the number of the disk the file is on.  Make that disk
  91. the current disk (see disk info box).  You can make a disk the current disk
  92. by  jumping to the disk or use the disk up/dn gadgets.  After you jumped to
  93. the  right  disk, you can add the file (by pressing the add files (no copy)
  94. gadget)  The  file  info will be added to the collection data, but the file
  95. will not be copied again.
  96.  
  97. * [UP] Shows the next entry of the current disk
  98.  
  99. * [DN] Shows the previous entry of the current disk
  100.  
  101. * [Disk up] Make next disk the current disk
  102.  
  103. * [Disk dn] Make previous disk the current disk
  104.  
  105. * [Jump to disk] Asks for a disk nr to make the current disk
  106.  
  107. *  [Disk  locked]  When  you  click  this gadget, a checkflag appears.  The
  108. current  disk is now locked.  No more files can be added to or deleted from
  109. this  disk.   This  option  is useful if you have disks that are so old you
  110. don't  want  to write to them again.  Press the Disk locked gadget again to
  111. unlock a disk.
  112.  
  113. *  [Create new disk file] If you press this gadget, a requester will appear
  114. with  the message :  'Next disk will be 'DISKNAME xx' Do you want to create
  115. it  ?'  If  you  press  the  YES  gadget, an index file for disk xx of your
  116. collection  will  be  created.  You'll have to format the disk yourself and
  117. use  the  diskname  you  saw in the requester.  After you clicked YES, File
  118. Storage asks you to insert this disk to read the free bytes.  If everything
  119. went okay, this disk is ready to be used by File Storage.
  120.  
  121. * [Clear scroll list] Clears all the names in the listview gadget (NO FILES
  122. ARE DELETED BY THIS ACTION !!!)
  123.  
  124. * [Delete file] Deletes the current visible file.
  125.  
  126. * [Type] Set filetype (multiple selections are possible)
  127.  
  128. Below  [UP]  and  [DN] is an information line that displays some info about
  129. the current file.  Example :
  130.  
  131. 16-oct-92 [3][002] LhA_e138.run (13865)
  132.  
  133. The  first item is the date the file was added to the collection.  Next [3]
  134. is  the  disk  the file is on.  The next nr [002] is the file nr.  Then the
  135. filename is displayed, and between brackets is the file length.  Under this
  136. line  are  4  gadgets  containing  the  file  description.   You can change
  137. descriptions  at  all  times.   When  you  go  to  another disk or quit the
  138. program, file descriptions are automatically saved.
  139.  
  140. You can click on the data to change it.
  141.  
  142.  
  143. 1.2 PREFERENCES
  144. To  go  to  the  preferences  menu  use the pull down menu or the short-cut
  145. Amiga-P.
  146.  
  147. Data directory : Directory where to keep the datafiles for FileStorage
  148. Disk Name      : Name  to  use for  floppy  disks  to  store  your programs
  149.                  example : 'Storage-#' (FileStorage puts numbers behind it,
  150.                  starting at 0)
  151. Safety Bytes   : Number of bytes to keep free on each disk.
  152. Printer output : Name of the device to send printer output to
  153. Prt prefix     : This string will be printed BEFORE the filename
  154. Prt suffix     : This string  will  be printed AFTER  the filename (You can
  155.                  use  Prt  prefix  and  postfix  to  print  filenames  in a
  156.                  different font for example)
  157. Edit file types: In edit file types you can change the names of the 16 file
  158.                  types.   When  you  add  a file, set the filetype for that
  159.                  file.  Later you can search for certain types of files.
  160.  
  161. [Save prefs] Saves the preferences and uses it
  162. [Use prefs]  Uses the preferences (doesn't save)
  163. [Cancel]     Quit to main menu and don't use the new changes
  164.  
  165.  
  166. 1.3 PRINT MENU
  167. To go to the print menu use the pull down menu or the short-cut Amiga-M.
  168.  
  169. [Print current disk]  Prints all the files on the current active disk
  170. [Print items in list] Prints all the items in the listview gadget
  171. [Print current item]  Prints the current visible file
  172. [Print all disks]     Prints all files of all disks
  173. [Cancel]              Quit to main menu
  174.  
  175.  
  176. 1.4 ABOUT (pull down menu)
  177. This gives you some information about the program.
  178.  
  179.  
  180. 1.5 QUIT (pull down menu)
  181. Quits the program. Everything will be saved.
  182.  
  183.  
  184. 1.6 TOTAL FREE BYTES (pull down menu)
  185. Shows the total number of free bytes of all unlocked disks.
  186.  
  187.  
  188. 1.7 TOTAL INFO (pull down menu)
  189. Shows nr of disks used, nr of files, nr of bytes used, nr of bytes free (of
  190. unlocked disks) nr of free bytes (all disks).
  191.  
  192.  
  193. 1.8 DATE SEARCH (pull down menu)
  194. Date  search  allows  you  to  search  for files with a certain date, files
  195. before / after a date.  Search files from ..  to ..  and list all the files
  196. (old  to  new  /  new  to  old)  Found  files  will  be  displayed  in  the
  197. listviewgadget of the main screen.
  198.  
  199.  
  200. 1.9  NO DESCRIPTION SEARCH (pull down menu)
  201. Search  for files without a description.  Handy for tracking down files you
  202. forgot to give a description.
  203.  
  204.  
  205. 2.0 FILE TYPE SEARCH (pull down menu)
  206. File  type  search allows 2 different ways of searching.  1) 'File may have
  207. extra types'.  If a file has more types than you searched for it will still
  208. appear  in the listview gadget.  2) 'File may not have extra types'.  Found
  209. files must match the type you searched for.
  210.  
  211.  
  212. 2.1 CHECK DISKS (pull down menu)
  213. Check disks checks if all files are still present and looks for uncataloged
  214. files.   'Check  one disk' checks just one disk of your collection.  'Check
  215. all  disks'  (what  else)  checks all disks of your collection.  'See error
  216. list' shows the last error list generated by check one/all disk(s).
  217.  
  218.  
  219. 2.2 Distribution
  220. """"""""""""""""
  221.  
  222. File  Storage  may be freely distributed as long as the package is still in
  223. it's  original  form.   All files included in the package are copyright (c)
  224. Digital  Intelligence.   You may use the small version as long as you like.
  225. If  you  want to use the normal version (up to 1000 disks !) you'll have to
  226. register by sending 20 Dutch guilders (approx.  12 US dollars) to :
  227.  
  228.  
  229.   Digital Intelligence
  230.   J.J. Allanstraat 222
  231.   1551RR Westzaan
  232.   Holland
  233.  
  234.  
  235. Please  send  Eurocheques  (HFL) or Dutch guilders (preffered) ONLY.  Other
  236. forms  of  payment  can't  be  accepted.   After you have registered you'll
  237. receive  a  disk containing the latest version of File Storage plus the key
  238. to  unlock  future  versions  of  File Storage.  After this you must obtain
  239. future  versions  of File Storage yourself (for example by downloading them
  240. from BBS's)
  241.  
  242.  
  243. HISTORY
  244. """""""
  245.  
  246. 29-sep-92 : First 'release' (to Ewout Kramer only :-)
  247.  
  248. 30-sep-92 : Lot's of complaints from Ewout :
  249.             * Data always to DH1:
  250.             * Disk names couldn't be changed
  251.             * Couldn't create new datafiles for disks
  252.  
  253.             Added  preferences  menu  +  print  menu.
  254.  
  255. 31-sep-92 : Multiple   file  select  implemented  (added  files  appear  in
  256.             listview gadget)
  257.  
  258. 01-oct-92 : Searching for a string that is found in all files over 13 disks
  259.             takes 11 secs.  Trying to improve that.
  260.  
  261. 01-oct-92 : Searching  is  now 3 times faster.  Searching for a string that
  262.             is found in ALL files over 13 disks takes 4 seconds.  Searching
  263.             for a string that is only found once or twice takes less then a
  264.             second.
  265.  
  266. 13-oct-92 : Jump to disk no longer jumps to unused disks.  After create new
  267.             diskfile automatic jump to new disk.  AddFile first checks if a
  268.             file  is  already  on  disk.   Added pattern matching to search
  269.             function.
  270.  
  271. 14-oct-92 : Free  bytes  display  now displays all free bytes (and not free
  272.             bytes minus safetybytes)
  273.  
  274. 15-oct-92 : Added menu 'Total free bytes' and 'Total info'
  275.  
  276. 16-oct-92 : Added  file  dates (I had to change the data structure, so this
  277.             will be version v1.1) Turned 'Information line ' into a gadget.
  278.             Now  you  can  change  the  file information (date/name/re-read
  279.             size)
  280.  
  281. 17-oct-92 : No  more  'free disk bytes :  -1' when free disk bytes can't be
  282.             read, old value is used.
  283.  
  284. 22-oct-92 : Finished  the  'print  items in list' in print menu (completely
  285.             forgot  to  finish  it ;-) Changed the printer menu.  Now files
  286.             can be 'printed' to a file too !  Added date search menu.  Date
  287.             of  file is now also displayed in listview gadget.  Added Check
  288.             disks  menu.   Check  disks  checks if files are missing or not
  289.             cataloged.
  290.  
  291. 27-oct-92 : Added  'No  description  search'.   It allows you to search for
  292.             files  without  a  description.  Added file types.  You can now
  293.             define  16 different filetypes.  Again I had to change the data
  294.             structure.   I  added  one  word  (16  bits)  so I could use 16
  295.             filetypes, this version will be v1.2
  296.  
  297. 28-oct-92 : Added 'Filetype Search'
  298.  
  299. 11-nov-92 : Removed 'bug' When cancel after addfiles, FileStorage asked for
  300.             disk 0
  301.