home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / r / reverser / !Reverser / !Help < prev    next >
Encoding:
Text File  |  1997-06-21  |  4.9 KB  |  200 lines
  1. Help for Reverser
  2. -----------------
  3.  
  4. Version 1.20 - 21st June 1997
  5. Shareware - Copyright 1996-1997 Peter Naulls
  6. pnaulls@wave.co.nz
  7.  
  8.  
  9. "So, What is it?"
  10.  
  11. !Reverser is a foreign filename formatter.
  12.  
  13.  
  14. "A what?"
  15.  
  16. It takes filenames from other platforms (e.g. DOS, Unix) and converts them
  17. into more RISC OS friendly filenames.
  18.  
  19.  
  20. "Like what?"
  21.  
  22. Well, there might be a Unix file called "program.c".  When this is moved
  23. to RISC OS, this becomes program/c, as RISC OS uses the fullstops as
  24. directory serparators.  For programs to be compiled using compilers such
  25. as gcc, the files need to be placed in "c" and "h" directories.  Not so bad
  26. it there are a few files, but if there are tens, or even hundreds of files,
  27. manually doing it will take quite a while.  Reverser does this all for you.
  28.  
  29.  
  30. "Anything else?"
  31.  
  32. Picture files brought to RISC OS often have esentially useless extensions. E.g.
  33. for picture/gif, Reverser will take off the "/gif" part. Reverser will 
  34. optionally take off trailing "/"s too, left over from file truncations.
  35.  
  36. Finally, Reverser can just set the type of files matching a given extension.
  37.  
  38.  
  39. "Cool, I could really use this.  How does it work?"
  40.  
  41. The program is launched in the normal way, by double clicking the icon.
  42. From the icon bar menu, off the Start entry, a save-as like box will appear.
  43. The icon can be dragged to a directory, where it will begin converting all the
  44. files it finds.
  45.  
  46. There are two options on the icon bar menu:
  47.  
  48. "Remove Trailing '/'" - If this is ticked, files without extensions, but
  49. with leftover '/'s will have them removed.
  50.  
  51. "Recurse" - Reverser will recurse into any subdirectories it finds if this
  52. is selected. 
  53.  
  54.  
  55. "So, what files will it rename?"
  56.  
  57. Look in the file !Reverser.Extensions.  This contains the configuration.
  58. Each line contains an extension, followed by an action. 
  59.  
  60. The first line contains:
  61.  
  62. c       rename  fff  c
  63.  
  64. Which means that files ending in "/c" will have the "/c" removed, and will
  65. be placed in a "c" directory.  e.g.  program/c -> c.program.  Lastly,
  66. the type of the file will be set to fff (textfile).
  67.  
  68. Further down we have:
  69.  
  70. jpg     chop   c85
  71.  
  72. Which means than files ending in "/jpg" will have it removed.
  73. e.g.   picture/jpg -> picture, and the type will be set to c85
  74. (jpeg).
  75.  
  76. At the bottom:
  77.  
  78. txt    settype fff
  79.  
  80. This means any files ending in "/txt" will have their type
  81. set to textfile.
  82.  
  83.  
  84. If you don't want files to have their type change, put in "none" for
  85. the filetype instead.
  86.  
  87.  
  88.  
  89. "Is there anything it won't do?"
  90.  
  91. The shareware version will not recurse subdirectories, whatever you do.
  92. Also, there is a good chance that in a directory with many entries to
  93. be renamed, the shareware version will skip over some files because of
  94. the directory cataloguing method used.  You will have to use Reverser
  95. several times to get all the files.  Note registered versions do not
  96. do this.
  97.  
  98. The shareware version will also not set filetypes.
  99.  
  100. Also, see limiations below.
  101.  
  102.  
  103. "What should I watch out for?"
  104.  
  105. The file extensions in the configuration file are case-sensitive,
  106. I might change this eventually, but it's not a big deal - simply
  107. put the uppercase one too.
  108.  
  109. Image files will not be renamed as Reverser sees these as directories.
  110. Quit the filesystem first (e.g.  zip files - quit SparkFS)
  111.  
  112. A filename will not be renamed if doing so would mean a filename
  113. clash.
  114.  
  115.  
  116. "Anything else?"
  117.  
  118. Reverser is shareware.  If you like it, and intend to use it, you
  119. must send me 5UKP, or equivalent in your currency to:
  120.  
  121. Peter Naulls
  122. 28a Galloway Street
  123. Hamilton
  124. NEW ZEALAND
  125.  
  126. As a guide, 5UKP = NZ$11 and 11 German Marks.  Anyone registered will
  127. receive free upgrades and support.
  128.  
  129. Any comments, suggestions, or general abuse to:
  130.  
  131. pnaulls@wave.co.nz
  132.  
  133.  
  134.  
  135.  
  136. History
  137. -------
  138.  
  139. Version 1.00 - 15th November 1996
  140.  
  141. Original version, it's taken me a while to get round to finishing, but here
  142. it is.
  143.  
  144.  
  145. Version 1.10 - 27th December 1996
  146.  
  147. New !Sprites22 thanks to James Shiell
  148. Renaming bug fixed - you cannot do a rename inside some image filing
  149. systems like SparkFS.  Reverser reverts to copy and delete if it cannot
  150. rename.
  151.  
  152. Version 1.11 - January(ish) 1997
  153.  
  154. The Reverser icon was a wee big wrong - now fixed
  155.  
  156. Version 1.20 - 21st June 1997
  157.  
  158. Added setting of filetypes.
  159. Removed limitation of number of extensions.
  160. Directory which renamed files are moved to does not have to be the same
  161.  as the extension.
  162.  
  163.  
  164. Known Bugs
  165. ----------
  166.  
  167. Reverser may lock occasionally if it cannot do something.  I have not
  168. bothered to trace this bug as yet.
  169.  
  170. Malformed Extensions file will cause unpredictable results - you have
  171. been warned.
  172.  
  173.  
  174. Limitations
  175. -----------
  176.  
  177. Shareware version will not recurse.
  178. Sharewave version will not always 'get' every file.
  179. Shareware version will not set filetypes.
  180. Very little error reporting if anything goes wrong.
  181.  
  182.  
  183. Wishlist
  184. --------
  185.  
  186. Checking for image files - e.g. DOS partitions and archives.
  187.  
  188.  
  189. Thanks to
  190. ---------
  191.  
  192. James Shiell (aka SevenUp)
  193. Michael-Dennis Biemans (aka XORcist)
  194.  
  195. And the rest of the #acorn crew. 
  196.  
  197.  
  198.  
  199.  
  200.