home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / f / fileutils / !FileUtils / !Help < prev    next >
Encoding:
Text File  |  1994-03-31  |  20.6 KB  |  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 rid of. The
  228. 'Forget paths' option also checks the system variable 'Wimp$Scrap'.
  229.  
  230. Set dir
  231. ~~~~~~~
  232.   Hotkey: Shift-Ctrl-F6 (toggles utility on/off)
  233.  
  234. This utility allows you to set the current directory from the desktop. Just
  235. drag the Set dir icon from the left hand side of the iconbar onto the
  236. directory which you want to be set as the current directory. A dialogue box
  237. will pop up confirming that the current directory has been set.
  238.  
  239. If you want to use the Set dir utility just once, you may find that it is
  240. more convient to use the dialogue box hanging off the iconbar menu for the
  241. Set dir utility. Just drag the icon to the directory just like you would
  242. with the iconbar version.
  243.  
  244. Parameters
  245. ~~~~~~~~~~
  246.   Hotkey: Shift-Ctrl-F5
  247.  
  248. This option allows you to run or load a file or application with parameters.
  249. For example, you might want to load FileUtils from the command line with the
  250. FindFile window open (this is an example - I'm sure you would not want to
  251. load FileUtils from FileUtils!). To do this you would use the command
  252.   *Run !FileUtils -f
  253. However, you cannot do the same thing in the desktop. The parameters utility
  254. allows you to do this.
  255.  
  256. To use it, select it from the main menu or use the hotkey. Drag the file or
  257. application of the window, and it's name will appear before the parameters
  258. writeable icon. If you click on the white icon at the far left of the
  259. window, it will toggle the command type between *Run and *Load. Type the
  260. parameters into the writable icon. If you drag a file into the writeable
  261. icon, it's full filename will be inserted at the caret. To run the command,
  262. press [Return] or click OK. The command will be executed, and the parameters
  263. window will be cleared. Click OK with adjust to execute the command and
  264. preserve the windows contents.
  265.  
  266.  
  267. Change type
  268. ~~~~~~~~~~~
  269.   Hotkey: Shift-Ctrl-F4
  270.  
  271. This option opens a change type window. Before you can use it, you must
  272. first set up the filetype by clicking menu on the window, and choosing a
  273. filetype, or typing one it at the bottom of the menu. Then select all the
  274. files you want to set to that filetype, and drag them to the window. This is
  275. useful, for example, when you have just transferred files from another (non
  276. Archimedes) computer and they are all filetyped Data. Please note that this
  277. option is only worth it for lots of files - if you have just one, drag it to
  278. the icon on the iconbar, and choose a filetype from the Change type submenu
  279. of the file menu.
  280.  
  281. Find space
  282. ~~~~~~~~~~
  283.   Hotkey: Shift-Ctrl-F3
  284.  
  285. This option allows you to find a disc with some space on it (for when you
  286. want to find a disc to copy something onto). Fill in the box for how much
  287. space you need or drag the file, directory or application to the window to
  288. add that objects size to the number in the box. Set up the drive you want to
  289. search in, and click on OK. The disc in the drive will be checked, and then
  290. you will be prompted for more discs until a disc is found with enough space.
  291.  
  292.  
  293. Find file
  294. ~~~~~~~~~
  295.   Hotkey: Shift-Ctrl-F2
  296.     In the window: Ctrl-E: set exact searching
  297.                    Ctrl-C: set containing searching
  298.                    Ctrl-P: restore previous name
  299.                    Return: start search
  300.                    Escape: close window
  301.  
  302. This option opens the Find File window. Fill in the name, select the paths
  303. to search, and set the options. Click on OK to start. Searching is case
  304. insensitive and multi-tasking.
  305.  
  306. If you drag a file or application to the window, then the path of the
  307. directory it is in will be added to the list of paths. When a directory it
  308. dragged to the window, it will be added to the list of paths. If a path is
  309. not necessary (for example there is a path nearer the root directory in the
  310. list), it will not be added and the computer will bleep. If there is a path
  311. further away from the root directory in the list, then it will be removed.
  312. Click menu over the list to remove a path or clear all the paths. A
  313. horizontal scroll bar will be added to the list if necessary. Drag a file or
  314. application from the root directory of the disc to search the entire disc.
  315.  
  316. When you start the search, a window will open allowing you to stop the
  317. search, and giving you some infomation on how it is getting on.
  318.  
  319. If no files are found, the findfile window will reopen with all the options
  320. and paths set up.
  321.  
  322. If you selected the list files option then when a seach has finished, a list
  323. of files found will be opened. Double click with select on a item to open
  324. the directory viewer the item is in. Applications are shown in red,
  325. directorys in blue, and files in black. If a item is in an archive its
  326. filetype is shown in light blue, and when it is double clicked on the
  327. archive will be opened and the directory viewer will be displayed if ArcFS
  328. is loaded. If it is not, the directory viewer that the archive is in will be
  329. opened. Click menu on this window to save the find list.
  330.  
  331. If you selected many discs searching, you will be prompted to insert more
  332. discs until you click on Stop on the dialogue box which asks you for another
  333. disc. No check is made to see if the disc has been seen before by the
  334. search.
  335.  
  336. The paths you set are kept between each time you use the find file utility,
  337. and the options are the ones which were set last time you clicked on OK.
  338.  
  339. Use Interactive Help to get more information about the options.
  340.  
  341. If you find that you are searching on the same path every time you use this
  342. utility (for example the root directory of your hard disc), you can save the
  343. paths and some of the options to disc so that they will be the options and
  344. paths set up every time you run FileUtils. Click menu over the find file
  345. window and select 'Make defaults' to set these.
  346.  
  347. Searching in Archives
  348. ~~~~~~~~~~~~~~~~~~~~~
  349. FileUtils can search in any Spark archives it finds, new and old formats.
  350. Select the 'Search in archives' options to enable this.
  351.  
  352. To make your own archives, contact David Pilling for a copy of Spark or
  353. ArcFSr/w. I strongly recommend that you buy a copy of ArcFSr/w. It is a very
  354. neat bit of coding, and provides easy to use compression for a nominal
  355. price.
  356.  
  357.  
  358. Note on True count
  359. ~~~~~~~~~~~~~~~~~~
  360. True count askes RISC OS how much space each file takes up on a disc, and
  361. uses the size for directories give by it. However, in some cases, this
  362. figure is inaccurate. Usually, it is very close - I have never found the
  363. final result to be more than 2k out. Still, it is still much better than
  364. Count.
  365.  
  366. I am investiagating this problem. Perhaps users of FileUtils could report
  367. the sucess or otherwise of this utility on their systems. Please write and
  368. tell me the size True count thought it was, and the size it actually is.
  369. Also details of which filing system used and the machine and operating
  370. system version.
  371.  
  372. To find out how much space an object takes up, use the Free option from the
  373. Filer iconbar menus. Note the free space. Next copy the object, and note the
  374. free space again. Subtract the first result from the second one. If you are
  375. using RISC OS 2, the result will be in bytes. Divide this by 1024 to get the
  376. result in Kbytes. If you are using RISC OS 3, the multitasking Free utility
  377. will give the free space in Kbytes if there is less than around 2Mb free.
  378.  
  379. I included this utility in this version for two reasons. Firstly, this
  380. utility still is accurate. The problems I have had may be because of RISC OS
  381. 3.00 (included in the A5000). This version is at best a beta-test version of
  382. RISC OS, and the version supplied in the A4 portable (3.10) has just about
  383. all of the modules updated. This utility may work fine under RISC OS 2.00
  384. and 3.10. Feedback please!
  385.  
  386. Secondly, by including this version, and hopefully getting some reponse from
  387. users, I can find out what the problem is.
  388.  
  389.  
  390. The FileData file:
  391. ~~~~~~~~~~~~~~~~~~
  392. This file tells FileUtils what *commands to put in the file menus.
  393.  
  394. The format of this file is quite simple, but for those of you too lazy to
  395. work out what it is, here is a description of each line:
  396.  
  397. Each line describes a menu for one filetype, or is a comment. Comment lines
  398. begin with a '\'. The last line must be the XXX entry for filetypes not
  399. described before. The format of a menu is:
  400.  
  401. FileType number,Title of menu,First item to appear on the menu,*command,
  402. other entries of item and *commands,
  403.  
  404. The line must finish with a comma. The *command may have a '#' in it, which
  405. will be replaced with the full name of the file when the item is selected.
  406. Don't put extra spaces in. Please note there is no error checking on the
  407. FileData file.
  408.  
  409. If you make an interesting modification to the FileData file, please send me
  410. a copy of it.
  411.  
  412.  
  413. Stupid jokes
  414. ~~~~~~~~~~~~
  415. Q. What's the difference between an IBM salesman and a herring?
  416. A. One has scales, is slimy and smells funny. The other is a fish.
  417.  
  418. Q. What's the difference between an dead IBM salesman lying in the middle of
  419.    a road and a dead snake lying in the middle of the road?
  420. A. There are skid marks in front of the snake.
  421.  
  422. IBMs definition of an optional extra: Something essential which isn't
  423. supplied with the machine.
  424.  
  425. The Amiga.
  426.  
  427.  
  428. Twilight
  429. ~~~~~~~~
  430. Do you worry about images being burnt into your monitor?
  431. Do you use confidential data on your machine?
  432. Do you want pretty patterns to be displayed on your screen when you are not
  433. using it?
  434.  
  435. If the answer to any of these questions is yes, then you need to buy a copy
  436. of Twilight, my first commercial program. Basically what it does is blank
  437. your screen and display an effect on it when you are not using it. This
  438. saves your monitor from image burn in.
  439.  
  440. It also has a password feature to stop unauthorised users looking at you
  441. data while you are away from your computer, and a hotkey for instant
  442. blanking of your screen. This is useful for keeping prying eyes away from
  443. your data.
  444.  
  445. Twilight also has lots of effects, from memos to fish to shapes to
  446. rectangles. It will display just one, or a random selection.
  447.  
  448. Twilight costs £14.95 from:
  449.   The Really Good Software Company
  450.   39 Carisbrooke Road
  451.   Harpenden
  452.   AL5 5QS
  453.  
  454. This is the correct price and address. Some early versions of the Twilight
  455. demo have a more expensive price and a different address.
  456.  
  457. Please write to me if you would like a demo version.
  458.  
  459.  
  460. ****
  461. By the way, try light blue (colour 15) on black (colour 7) in Edit. Much
  462. nicer than black on white.
  463. ****
  464.  
  465.  
  466.  
  467. Credits
  468. ~~~~~~~
  469. Thanks are due to the following people for finding bugs and/or making
  470. suggestions about FileUtils:
  471.  
  472.    Ben Harris    Andrew Cawte    Brian Sherwood    Alex Crawford
  473.    Ian Ford
  474.  
  475. Also Mark Smith for his help with archive searching.
  476.  
  477.  
  478. FileUtils source code
  479. ~~~~~~~~~~~~~~~~~~~~~
  480. I may be prepared to release the source code of FileUtils to certain people.
  481. However, they would have to abide by the following conditions:
  482.  
  483.   1. The source code is not distributed - I would like to keep track of
  484.      where it gets to.
  485.   2. The source code is not modified, and a modified version of the source
  486.      code or a compiled version of FileUtils is not distributed.
  487.   3. Bits of the code are not used in other programs without my consent
  488.      and an acknowledgement of this in the documentation.
  489.  
  490. FileUtils is written in C using the RISC OS Library supplied with Acorn
  491. Desktop C. If you want to see it, please tell me why, and explicitly state
  492. that you will not break the conditions above.
  493.  
  494.  
  495. Conditions of use and distribution
  496. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  497. This application may be freely distributed for no commercial gain. A small
  498. charge may be made for media etc. The copyright of this application remains
  499. mine at all times. I would like to hear from any PD library which
  500. distributes FileUtils so I can provide a copy of the latest version.
  501.  
  502. If you find that you use this application often, I would appreciate a letter
  503. telling me so and perhaps a disc of PD. If you include return postage and a
  504. disc I will send you the latest version. You could even make suggestions for
  505. new features or improvements, and I might add them to FileUtils.
  506.  
  507.  
  508. The author:
  509. ~~~~~~~~~~~
  510. If you have any comments to make, bugs (what?) to report or new features to
  511. suggest, please write to me. My address is:
  512.  
  513.   Ben Summers
  514.   1 St Clements Hill
  515.   Norwich
  516.   NR3 4DE
  517.  
  518.   email: bsummers@cix.compulink.co.uk
  519.  
  520.  
  521. If you write, please send a SAE for a reply. If you send a disc with your
  522. letter, I will copy the latest version onto it, and send it back in your
  523. SAE. If you are sending a disc, wrap it so it doesn't get broken in the
  524. post, but not so that it can withstand nuclear attack.
  525.  
  526. If you find this program useful, please send me a token of your
  527. appreciation, for example a disc of PD programs (which I will send back if
  528. you send an SAE), as many hours of work have gone into writing this program.
  529.  
  530. Most of the modifications to FileUtils have been done because someone wrote
  531. to me and suggested it, so if you would like to see a new feature please
  532. write and suggest it.
  533.  
  534. Thanks to everyone who has sent me a letter and a disc - it's much
  535. appreciated.
  536.  
  537.  
  538.