home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / c / csdvarmo / ReadMe < prev   
Encoding:
Text File  |  1996-02-18  |  3.6 KB  |  75 lines
  1. CSDVar Module, V1.00 © Musus Umbra, 1996
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Do you sometimes wish that Risc OS had the 'Prompt $P' functionality of
  5. DOS?  Do you find it tricky remembering where you are in a directory
  6. tree when using the command line?  Ever wanted the unix 'pwd' command?
  7.  
  8. Then CSDVar is for you!
  9.  
  10. What is it?
  11. ~~~~~~~~~~~
  12. CSDVar is a (tiny) module that has 3 main functions:
  13.     (1) It provides a *command, 'pwd' that prints out the full pathname
  14.         of the current directory.
  15.     (2) It provides 1 SWI, CSDVar_ReadCSD (&CD0C0) that reads the full
  16.         pathname of the CSD and returns a pointer to it.
  17.     (3) It provides a system variable, CSD$Var that whenever inspected
  18.         will hold the full pathname of the CSD.  This is the main reason
  19.         I wrote the module, the rest is all just gloss.
  20.  
  21. How to use it
  22. ~~~~~~~~~~~~~
  23. Probably the best and simplest use is to load the module in your boot
  24. sequence, and then issue a
  25.     *SetMacro CLI$Prompt <CSD$Var> *
  26. command.  Now, whenever you'd normally be presented with a '*' prompt on the
  27. command line, you'll instead have the full pathname of the CSD displayed, and
  28. then the *.  I find this incredibly useful, since I'm always using taskwindows,
  29. or ducking out of the desktop (F12) to do some command line stuff, and I often
  30. need to keep track of where I am in the directory tree.
  31.  
  32. But I already have something that does that!
  33. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34. So did I, but the utility I was using had (at least) one fundamental problem,
  35. if the CSD's pathname couldn't be read, it caused an endless string of error
  36. messages, necessitating a reboot.  CSDVar doesn't do that, instead it will
  37. tell you what the error was instead of the CSD's pathname.  Try it on ADFS::0
  38. without a disc in the drive and you'll see what I mean.  The utility I was
  39. using would have spewed continuous 'Drive empty' messages at me until I'd
  40. appeased it by putting a disc in the drive.  CSDVar will just say 'Drive empty'
  41. once and be done with it.  Much better.
  42.  
  43.  
  44. Background
  45. ~~~~~~~~~~
  46. Basically, I'd been using a similar utility to set the CLI prompt to the
  47. name of the CSD, but I'd got increasingly upset with it.  The principal
  48. problem was that if the CSD couldn't be read for some reason (eg. I'd changed
  49. to IDEFS, but my IDE drive is disconnected now that I have a bigger, faster
  50. SCSI drive) and there was an error, I'd get an endless stream of (for
  51. instance) 'Bad Drive's appearing when I hit F12, and the only option would be
  52. a re-boot.  Now, why the Hell didn't whoever wrote the utility I was using
  53. simply trap the error and use that for the name of the CSD in the system
  54. prompt?  I don't know, but that's exactly what my module does.  Also, my module
  55. will allow you to 'unset' the system variable it provides - not fantastically
  56. useful, but if for some arcane reason you want to, you can.
  57.  
  58.  
  59. Disclaimer
  60. ~~~~~~~~~~
  61. Use of this software is completely at your own risk. The author can accept no
  62. responsibility for any damage/loss arising from the use, or inability to use
  63. this software. No warranty, express or implied, applies to this software.
  64. This is not PD: the Copyright in this software belongs at all times to the
  65. author. However, permission is granted for unrestricted distribution
  66. prodividing that *no* charge is made for the distribution [a charge may be made
  67. for handling/media] and that the whole of the software is supplied intact and
  68. unaltered. Permission is also granted for unrestricted use and alteration of
  69. the software [but if you fix a bug / add anything nice, let me know so I can
  70. patch the 'master' version].
  71.  
  72. Bug reports / comments / etc to:
  73. Musus Umbra c/o 23 Baronsway, Whitkirk, Leeds, LS15 7AW, England.
  74. (until Sept-ish '96: n0ae3@newton.ncl.ac.uk)
  75.