home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / f / fileutils / !FileUtils / !Help < prev    next >
Text File  |  1994-03-31  |  21KB  |  538 lines
  1. FileUtils version 4.07 12/12/92
  2. by Ben Summers
  3.  
  4.  
  5.                              FileUtils version 4
  6.                              ~~~~~~~~~~~~~~~~~~~
  7.  
  8. *Command menu for files with find file, find space, change type windows,
  9. parameters, set dir and forget disc utilities.
  10.  
  11. Click here for conditions of use & distribution. 
  12.  
  13. Please note my address has changed. 
  14.  
  15. FileUtils now needs the latest version (3.75) of CLib. You should all have
  16. this by now, but if you haven't, write to me.
  17.  
  18. If you think of any more utilities which might be useful or use FileUtils a
  19. lot, please write and tell me.
  20.  
  21. Note on True count
  22.  
  23. The application directory should contain the following files:
  24.   !Boot       !Help       !Run        !RunImage
  25.   !Sprites    FUhotkey    Help        HelpReader
  26.   HelpText    Templates   StartHK
  27. and the directory SetUp, which should contain
  28.   ffChoices   FileData    Options
  29.  
  30. Revision history
  31. ~~~~~~~~~~~~~~~~
  32. Version 1.00
  33.   Original BASIC application.
  34.  
  35. Version 2.00 - 2.06
  36.   Optional file menu commands added, bug fixes.
  37.  
  38. Version 3.00
  39.   BASIC application rewritten in C.
  40.   Utilities added.
  41.  
  42. Version 3.01
  43.   Find file user interface changed after comments from Acorn.
  44.   Fix FileCore option removed after complaints from Acorn (dismount discs
  45.     when you have finished with them).
  46.   Interactive help is now fully supported.
  47.  
  48. Version 3.02
  49.   Return now starts the search in the Find file window.
  50.   Hotkeys now added.
  51.   Code improved.
  52.  
  53. Version 3.03
  54.   Find file improved.
  55.   Archive searching added.
  56.   Hotkeys now work 'outside' the application.
  57.   The options are now a submenu.
  58.  
  59. Version 3.04
  60.   Bugs corrected.
  61.  
  62. Version 4.00
  63.   More bugs corrected.
  64.   Context sensitive HelpReader system used.
  65.   Outside hotkeys removed.
  66.   Parameters utility added.
  67.   Set dir utility added.
  68.   Minor improvements to templates.
  69.   Improved FileData file.
  70.  
  71. Version 4.01
  72.   Changed find file progress window.
  73.   Find file now preserves parameters and paths between each use.
  74.  
  75. Version 4.02
  76.   Kill dialogue box now shows object name.
  77.   Short cuts added to iconbar menu.
  78.  
  79. Version 4.03
  80.   Save find file options and paths option added.
  81.   Re-implemented the outside hotkeys (but in a different way: )
  82.   Added Forget disc utility.
  83.   Support for new format archives.
  84.   Modified way filenames too long appear in file list window.
  85.  
  86. Version 4.04
  87.   Corrected new archive searching to cope with converted archives.
  88.   Modified find space to take account of wasted disc space.
  89.   Opening of archives in the file list window. 
  90.  
  91. Version 4.05
  92.   Fixed small bug with default paths.
  93.  
  94. Version 4.06
  95.   Clicking on FileUtils icon now brings up last used utility.
  96.   'Error in archive' message now shows archive name.
  97.   Directory structure changed slightly.
  98.   Added True count utility.
  99.   Added Set dir dialogue box for quicker setting of the current directory.
  100.  
  101. Version 4.07
  102.   Added saving of found list in find file
  103.  
  104.  
  105.                           How to use FileUtils
  106.                           ~~~~~~~~~~~~~~~~~~~~
  107.  
  108. @*filemenu
  109. File menus
  110. ~~~~~~~~~~
  111. Drag a file to the iconbar. A menu of * commands will pop up. Chose one, or
  112. click elsewhere to cancel it.
  113. At the top of the menu, there will be up to four optional items, depending
  114. on the options set up. They can be:
  115.  Change type ⇨  Leads to a submenu allowing you to change the files filetype.
  116.  Dump           Dump the file
  117.  Info           Get info on the file
  118.  Kill           Deletes the object (file or directory) even if it is
  119.   locked. This is useful for getting rid of applications or directories where
  120.   somebody has locked a file inside it (annoying isn't it?). As it is quite a
  121.   dangerous option, there is an option to confirm that you want to kill the
  122.   object before you do so.
  123.  
  124.     See the format of the FileData file for how to define the other
  125.     options.
  126.  
  127. Interactive help
  128. ~~~~~~~~~~~~~~~~
  129. To save space, the help text is only loaded in when it is needed, so when
  130. you first point at FileUtils, it will access the disc to get this text.
  131.   How to easily add interactive help to your C programs.
  132.  
  133. Hotkeys
  134. ~~~~~~~
  135. Each of the utilities has a keyboard shortcut. Shift-Ctrl function keys have
  136. been used to avoid clashes with other applications. See the info on each
  137. utility for its hotkey.
  138.  
  139. The hotkeys can be made to work outside the application so that if one of
  140. the hotkeys is used, FileUtils will be loaded and the relevent utility
  141. started. To make this work, you must add the following line to the desktop
  142. command file (the one in the command 'desktop -file <filename>' {page 390
  143. RISCOS2 user guide}) in your boot routine:
  144.  
  145. adfs::HardDisc4.$.Utilities.!FileUtils.StartHK
  146.  
  147. You will, of course, have to change the path to the directory FileUtils is
  148. in. This method is only really useable for hard disc users, but then, these
  149. hotkeys are probably only suitiable for them.
  150.  
  151.  
  152. The main menu
  153. ~~~~~~~~~~~~~
  154. Main menu (click Menu on the icon)
  155.  Info        ⇨  Leads to standard info dialogue box.
  156.  Options     ⇨  Leads to options submenu
  157.  Save options   Saves the current options to disc
  158.  Help           Loads this text
  159.  *Cmd menu      Just a reminder...
  160.  True count     Open the true count window
  161.  Forget disc    Opens the forget disc dialogue
  162.  Set dir        Toggles the set dir utility
  163.  Parameters     Opens the parameters window
  164.  Change type    Opens a change type window
  165.  Find space     Allows you to find a disc with enough room on it
  166.  Find file      Opens the find file window
  167.  Quit           Guess
  168.  
  169. One of the utilities will have a grey background on the menu instead of the
  170. normal white background. This is the utility that will be started when the
  171. FileUtils icon is clicked.
  172.  
  173.  
  174. Options  ⇨
  175. ~~~~~~~~~~
  176. This leads to a submenu which allows you to set which optional items appear
  177. on the file menus. Use the 'Save options' on the main menu to save these to
  178. disc.
  179.  
  180. True count
  181. ~~~~~~~~~~
  182.   Hotkey: Shift-Ctrl-F8
  183.  
  184. This utility allows you to see how much space an object really takes up on
  185. your disc. This is provided because the Count option on the Filer doesn't
  186. give the true amount of space used. All it does is total up all the lengths
  187. of the files. This gives a false impression of the space used up for two
  188. reasons. Firstly, a file can take up more than its lenght because it must
  189. fit into an exact number of sectors. These are about 512 bytes long. If a
  190. file is 513 bytes long, an extra sector has to be used to store the 513th
  191. byte, so in fact the file takes up 1024 (1K) up on the disc. The Count
  192. command does not take this into account. The second reason is directories.
  193. These are ignored by the Count command. However, each one takes up 2K on the
  194. disc. Because of this, the count command gives an inaccurate result.
  195.  
  196. For a demonstration of this, count all the files on a disc, preferably a
  197. hard disc. Next use the 'Free' option to find out how much has been used.
  198. Compare the two - count will give a smaller result.
  199.  
  200. True count will show how much space an object actually takes up on your
  201. disc. To use it, open the true count window using the iconbar menu or the
  202. hotkey. Next drag the object to this window. The size will be shown.
  203.  
  204. The window has two other icons, the Reset size and Add sizes icons. The
  205. reset size resets the size shown to 0K. The Add sizes icon is useful when
  206. you are dragging a directory full of objects to the window. With out this
  207. icon selected, each object would be counted, and the value displayed.
  208. However, the next object would over write this value. To stop this, select
  209. this icon. Now whenever an object is dragged to the window, it's size will
  210. be added to the size shown. Use the Reset size icon to put this back to
  211. zero. Use this icon when you drag more than one object from a directory at
  212. once onto the window.
  213.  
  214. Note on True count
  215.  
  216. Forget disc
  217. ~~~~~~~~~~~
  218.   Hotkey: Shift-Ctrl-F7
  219.  
  220. This utility allows you to forget a disc like dismount, but also unsets any
  221. system variables which reference it. This should stop any requests for a
  222. disc (which you sometimes get even after dismounting it from the disc drive
  223. icon menu). To use it, select it from the icon bar menu or use the hotkey.
  224. Click on the icon of the drive with the disc in that you want to forget, set
  225. the options and click on OK.
  226.  
  227. The options allow you to select which system variables to get