home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilsf / longfiles / !LongFiles / !Help next >
Text File  |  1995-02-23  |  8KB  |  198 lines
  1. ######################################################################################
  2. ##                                                                                  ##
  3. ## --------------------------=======< NEWS FLASH >=======-------------------------- ##
  4. ##                                                                                  ##
  5. ## As of version (0.08), !LongFiles has become fully PD, on the condition that the  ##
  6. ##    copyright remains with the author, and this !Help file is included in full.   ##
  7. ##                                                                                  ##
  8. ## The author has no undertaking to provide support for !LongFiles, but may be able ##
  9. ##    to provide help if asked in a nice way, and if he has had a good day :-)      ##
  10. ##                                                                                  ##
  11. ##  LongFilenames is (C) Jason Tribbeck/7th ARM Systems 1994. All rights reserved.  ##
  12. ##                                                                                  ##
  13. ######################################################################################
  14.  
  15. !Help for !LongFiles (0.10)
  16. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  17. Fifth release
  18.  
  19. !LongFiles provides the user with 55-character filenames. It integrates in the desktop
  20. completely, but needs a tad more work before it will work fully in the command-line.
  21.  
  22. How it works
  23. ~~~~~~~~~~~~
  24. If any filenames longer than 10 characters are used, it will store them under a special
  25. filename. Several operating system vectors are claimed, which enable these translations
  26. to occur. The special names are :
  27.  
  28. (C)JPT-###, where ### is a unique ID code for that filename in that directory.
  29. !!!!!!!!Z!, used to store the files inside the directory. This file is hidden from the
  30. filer (and most CLI read-operations, such as catalogue, but it can be copied, renamed
  31. and so forth - DON'T RENAME IT - IT MAY NOT LIKE IT)
  32.  
  33. What works and what doesn't (updated for 0.09)
  34. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35. Currently, the following have been implemented :
  36.  
  37. All OS_Files
  38. All OS_Finds
  39. All OS_FSControls
  40. All OS_GBPB
  41. All the other filing system vectors are not touched.
  42.  
  43. Filenames are case-insensitive, so if you have the file A_Very_Long_Filename, it
  44. can be called by a_very_long_filename, or A_VERY_Long_fileNAME.
  45.  
  46. How to get it working
  47. ~~~~~~~~~~~~~~~~~~~~~
  48. If you double-click on !LongFiles, nothing happens. However, there is a *command
  49. that allows you to add others :
  50.  
  51. *AddLongFS <FilingSystemName>, such as SCSI, ADFS or IDEFS.
  52.  
  53. You can modify the !Run accordingly...
  54.  
  55. A word of warning
  56. ~~~~~~~~~~~~~~~~~
  57. Before you close down, you MUST either RMKill the module, or issue *SaveLongFSCache,
  58. otherwise you will loose the file renaming system. It does respond to some filer and
  59. service calls and saves its data then, but if you are doing some work in the CLI,
  60. then you'll have to do it manually before turning off.
  61.  
  62. Notes
  63. ~~~~~
  64. Under WindowManager 3.22 or greater, the filer will adjust the width of its icons
  65. automatically. I haven't tried it on earlier versions.
  66.  
  67. Also, the filer will truncate the application filenames to 12 characters for the sprites,
  68. so if you have an application !My_Newest_Application, then it will use the sprite name
  69. !My_Newest_A as the name for the sprite.
  70.  
  71. In version 0.04+, there is no limit to the total number of 'long' filenames you can have,
  72. but you can only have a total of 76 per directory (if you are using a filecore system).
  73. It only has space for 79 long filenames.
  74.  
  75. Short filenames (<=10) are handled by FileSwitch.
  76.  
  77. If anything goes wrong
  78. ~~~~~~~~~~~~~~~~~~~~~~
  79. If anything does go seriously wrong, kill the module, and rename the files that have
  80. (C)JPT_### in them. Also, delete the file !!!!!!!!Z!, if there are any.
  81.  
  82. It should work under **any** RISC OS, but I've only been able to test it on 3.1. I
  83. believe it will work under RISC OS 2, but catalogue/information probably won't work.
  84. RISC OS 3.5 should be fine.
  85.  
  86. I cannot accept liability for any damage caused by this program, or the use of it.
  87.  
  88. *Commands
  89. ~~~~~~~~~
  90. LongFilenames 0.10 has four *Commands. These are :
  91.  
  92. AddLongFS
  93. ~~~~~~~~~
  94. Syntax:
  95.  
  96. *AddLongFS <fsname>
  97.  
  98. This adds a filing system to LongFilenames' list. <fsname> is just the filing system
  99. name, with no spaces afterwards.
  100.  
  101. Example:
  102.  
  103. *AddLongFS ADFS
  104.  
  105. AddNoCacheLongFS
  106. ~~~~~~~~~~~~~~~~
  107. Syntax:
  108.  
  109. *AddNoCacheLongFS <fsname>
  110.  
  111. This is similar to *AddLongFS, except LongFilenames doesn't cache data from the filing
  112. system. All changes to FS blocks are written to the filing system immediately. This
  113. provides support for network-based filing systems. In version 0.08, however, it has not
  114. been tested on a network.
  115.  
  116. Example:
  117. *AddNoCacheLongFS Net
  118.  
  119. RemoveLongFS
  120. ~~~~~~~~~~~~
  121. Syntax:
  122.  
  123. *RemoveLongFS <fsname>
  124.  
  125. This is the opposite of *AddLongFS. LongFilenames will first save any cached blocks,
  126. and will then detach itself from the filing system.
  127.  
  128. Example:
  129.  
  130. *RemoveLongFS RAM
  131.  
  132. SaveLongFSCache
  133. ~~~~~~~~~~~~~~~
  134. Syntax:
  135.  
  136. *SaveLongFSCache
  137.  
  138. In order to speed up LongFilenames, LongFilenames keeps information in a cache. This
  139. call ensures that any modified cached blocks are saved back to the discs. It is only
  140. required if you are doing work in the CLI, as it is done automatically when the WIMP
  141. closes down.
  142.  
  143. Example:
  144.  
  145. *SaveLongFSCache
  146.  
  147. If you find bugs, or have any ideas
  148. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  149. Then contact me :
  150.  
  151. jarre@equinoxe.demon.co.uk
  152.  
  153. History
  154. ~~~~~~~
  155. 0.01 - Worked before FileSwitch, on all filing systems.
  156. 0.02 - Used one large file stored inside the application for files. Floppy problems.
  157. 0.03 - Changed '(C)JT-####' into '(C)JPT-###'.
  158. 0.04 - Has extra file ('!!!!!!!!Z!') for files, stored in directories which have long
  159.        filenames, otherwise it is deleted.
  160. 0.05 - Hidden '!!!!!!!!Z!' from filer, catalogue and *ex.
  161.          + Fixed bug in rename,
  162.          + added saving of cached blocks before and after delete (fixed delete bug)
  163. 0.06 - Added saving of cached blocks on :
  164.          Rename, Service_ShutDown, Service_FilerDying, Service_PreReset,
  165.          Service_WimpSaveDesktop
  166. 0.07 - First bugfix list
  167.          + Fixed renaming of files to themselves (previously 'lost' information in
  168.            cached blocks)
  169.          + Fixed (unreported bug) of rename function (clearing modified byte instead
  170.            of setting it - whooops!)
  171.          + Fixed renaming of 10-character files to >10-characters where the
  172.            characters had the same root as a file that exists
  173.          + Added saving (and flushing) of cache blocks after a rename operation
  174.          + Checks to see if filing system is already 'installed'
  175. 0.08 - Second bugfix list
  176.          + Extended from 23 character filenames to 55,
  177.          + Added *RemoveLongFS <fsname> command
  178.          + Converts from version 0.05..0.07 format !!!!!!!!Z! files - doesn't mark
  179.            them as modified.
  180.          + Added cache saves on OS_FSControl 16,OS_FSControl 22, OS_FSControl 23
  181.            (Removal of FS, Close all files, Shutdown FSs).
  182.          + Removed the RAM disc requirement.
  183.          + Added support for multi-user filing systems (e.g. networks), in the shape
  184.            of *AddNoCacheLongFS <fsname>.
  185.          + Added *Command list in !Help file.
  186. 0.09 - No bug fixes, just had some good ideas !
  187.          + Added wildcard searches.
  188.          + Tidied special field names (eg. net#0.254).
  189.          + Compressed saving of !!!!!!!!Z! file (now saves only what it needs).
  190.          + Removal of "Possible Future Ideas"
  191.          + Fixed high-bit characters (case) potential problems
  192. 0.10 - Third bugfix list
  193.          + Fixed renaming bug of differing case filenames
  194.  
  195. PS. yes, the sprite's supposed to look like that...
  196.  
  197. [Source info : Basic assembly, 58324 bytes, 1956 lines]
  198.