home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / disk / filelogger-1.31.lha / FileLogger / FileLogger.doc < prev    next >
Text File  |  1993-12-21  |  59KB  |  1,201 lines
  1.  
  2. FileLogger V1.31 (c) 1993 Arun Kumar G.P.
  3.  
  4. Converted to text file from the AmigaGuide document by ag2txt
  5.  
  6.  
  7. FileLogger Doc
  8.  
  9.                               FILELOGGER V1.31
  10.                             (c) 1993 Arun Kumar G.P.
  11.  
  12.  
  13.                   _/          _/  _/_/_/_/    _/_/_/    _/_/_/
  14.                  _/          _/  _/        _/        _/
  15.        A        _/    _/    _/  _/_/_/    _/        _/          Production
  16.                  _/  _/  _/    _/        _/        _/
  17.                   _/  _/      _/_/_/_/    _/_/_/    _/_/_/
  18.  
  19.  
  20. This is the documentation for  'FileLogger V1.31', a disk/file cataloguer
  21. for the Amiga computer.
  22.  
  23.               Introduction                        
  24.               Execution & Startup                 
  25.               Main Window                         
  26.               Select Window                       
  27.               Sort Window                         
  28.               About                               
  29.               Compatibility, Acknowledgements etc 
  30.               History                             
  31.               To Do                               
  32.  
  33.  
  34. Introduction
  35.  
  36. Introduction :
  37. ==============
  38.  
  39.   Have you ever tried to find a particular utility/sound sample/picture
  40. once you have accumulated a substantial number of disks OR do you know
  41. what are all the files you have ?. You can't really write down all the file
  42. names on the label of the disk. Here is a utility to save your time and all
  43. the disk swapping. This program allows you to
  44.   - Log disks and selected file details from the disk into a Log.
  45.   - Give a filetype and remarks to each file which can be queried on later.
  46.   - Remarks will be read by default from the file comments (if present) of
  47.     a file on disk.
  48.   - Optionally it can guess the types (whether an Executable, Text,
  49.     PowerPacked Data, IFF Picture, IFF Sample or IFF Anim etc.) of the
  50.     files.  Over 30 file types are currently recognized. 
  51.   - Specify your own file types codes instead of the default given by the
  52.     program by maintaining it in a preferences file. (*)
  53.   - Search for a particular disk/file in the Log using wild card matches
  54.     on disk name, file name, file type or remarks.
  55.   - Do a multilevel sort on disk name, filename, filetype and remarks. (*)
  56.   - Print out the full log or the Selected/sorted part of it. (*)
  57.   - The number of files you can log is only limited by the memory. (!)
  58.  
  59. (*) : The unregistered version has these functions disabled.
  60. (!) : The unregistered version has a maximum limit of 500 logged files
  61.  
  62.    This program will be of great help to people who have no hard disks and
  63. and their entire software collection is on floppies. I got the idea of
  64. writing this program after a unfruitful search for a particular utility
  65. which I knew existed in one of my disks.
  66.  
  67.     There are 3 windows where all the action happens. The first window
  68.  (Main Window)  is where you can move around the log, print the entire log,
  69. edit the logged details, save the logged details and call the other 2
  70. windows. The second window  (Select window)  lets you select the drive/disk
  71. which has the files you want to insert into the log. The third window
  72.  (Sort Window)  lets you enter different search and sort criteria
  73. and select the matching files from your log.
  74.  
  75.  
  76. Execution
  77.  
  78. Execution  :
  79. ===========
  80.   The program can be executed from the WorkBench or from the CLI. It
  81. multitasks properly and runs on its own screen. You can pull down the
  82. screen or press Left Amiga + N to switch to the Workbench or CLI screen.
  83. It does not require any supporting files/libraries. The preferences file
  84. "Filelogger.prefs" is expected to be in the current directory or in the
  85. directory S:.
  86.  
  87.   From the CLI, it takes one argument (optional), which is the filename
  88. (with path) of the Log. From the Workbench you can either double click on
  89. the Filelogger icon (to start it without a log file) or holding shift key
  90. down, click once on the Filelogger icon and double click on the Log file
  91. icon (to start it with a Log file).
  92.  
  93.   The program looks for the file 'FileLogger.prefs' in the S: directory 
  94. first and if it can't find it, searches the current directory for it. If
  95. it doesn't find it at all, it prompts whether you want to save a default
  96. preferences file. If you accept, a default preferences file is saved in
  97. the S: directory. If it does find the preferences file, the menu
  98. preferences and the user file types are read in and will be used by it
  99. later.  However this feature is not present in the unregistered version.
  100.  
  101. NOTE : You can have as many blank lines as you want. Everything after a 
  102.       // is ignored as remarks. Do not edit any of the fields in the
  103.       left hand side of the equations. You can have spaces or tabs around
  104.       the = sign. The Menu preferences can only have values of Y or N.
  105.       The User Defined File Types follow next. The numbers on the left
  106.       side of the '=' are significant and you should not change them.  You
  107.       can only change the rhs of the equation to a code you want. A maximum
  108.       of 5 characters will be read from the file type code you give. The
  109.       uppercase equivalents of all lowercase file types will be used.
  110.  
  111.       Eg: a) If you want to shut off the Screen Flash everytime, you can
  112.              change the value of flag 'FLASH_SCREEN' to 'N' from 'Y'.
  113.           b) Say you want to change the file type code 'PICT' given by 
  114.              default by the program to all IFF Pictures to your own code
  115.              'ILBM'.  Only replace the 'PICT' by 'ILBM' without changing
  116.              the number to the left of it and when the program guesses a 
  117.              file type and comes across an IFF picture later, the code
  118.              'ILBM' will be used instead of 'PICT'.
  119.  
  120.   If the filename is given and if it is a valid FILELOGGER Log file, the
  121. pointer changes to a clock and you can see the number of disk and file 
  122. counter ticking as all the logged files and its details are read into the
  123. memory. Once all the Log file details are read into memory, the pointer
  124. changes back to the default and the last file of the last disk in the Log
  125. will be shown. If any error occurred, a Requester will come up and tell 
  126. you what went wrong. You may end up with partial files being read in if the
  127. Log file is corrupted somehow.  If the given file did not exist (i.e a new
  128. Log is being created), a message comes up and you can continue to add files
  129. into the Log and this filename will be used while saving the Log next time.
  130.  
  131.  
  132. Main Window
  133.  
  134. Main Window :
  135. =============
  136. (The Uppercase words have the comments about the fields/buttons)
  137.  
  138. +-------------------------------------------------------------------------+
  139. |                          F  I L E   L O G G E R                         |
  140. +-------------------------------------------------------------------------+
  141. | Remaining  Memory  --> KEEP AN EYE ON THIS                              |
  142. |                                                                         |
  143. | STRING GADGETS                                                          |
  144. |  Disk Name   --> MAX 30 SIZE, MANDATORY, CAN BE EDITED                  |
  145. |                                                                         |
  146. |  File Name   --> MAX 30 SIZE, MANDATORY, CAN BE EDITED                  |
  147. |  File Size   --> MAX 999999 VALUE, MANDATORY, CAN BE EDITED             |
  148. |  File Type   --> MAX 5 SIZE, OPTIONAL,  CAN BE EDITED                   |
  149. |  Remarks     --> MAX 512 SIZE, OPTIONAL,  CAN BE EDITED                 |
  150. |                                                                         |
  151. |                                                              +--------+ |
  152. |     ACTIVE ONLY WHEN EDITING, CLICK TO ACCEPT DETAILS   -->  | ACCEPT | |
  153. | No. of disks and files in the log   --> SHOWS THE LOG STATUS +--------+ |
  154. |                                                                         |
  155. |   BUTTONS FOR FILES     BUTTONS FOR DISKS             PRINT FULL LOG    |
  156. +---------------|----------------|---------------------