home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / ppm2fli / Docs / RISC-OS < prev    next >
Encoding:
Text File  |  1996-08-17  |  4.4 KB  |  112 lines
  1. ppm2fli and unflick
  2. Copyright Klaus Ehrenfried
  3. RISC OS ports by Lee Noar
  4.  
  5.  The rest of the documentation provided in this package is the original and
  6. therefore contains references to Unix specific details which should be
  7. ignored. This document is additional to the original and designed to show any
  8. differences that arise through the change of platform from Unix to RISC OS.
  9.  
  10.  To make these tools available from the command line, either double-click on
  11. !SetPaths to add them to your run path or move them into your run path, for
  12. example, by copying them to your library directory.
  13.  
  14. ppm2fli
  15. -------
  16. RISC OS port V0.01 (16th August 1996)
  17.  
  18.  This is a RISC OS port of the Unix utility ppm2fli. It's purpose is to
  19. create FLI/FLC animation files from individual frame files. The animation
  20. files can then be played with an application like !FliPlayer or !MovieFS
  21. (with !ARPlayer).
  22.  
  23. ppm2fli is used as follows:
  24.  
  25.  ppm2fli <options> <list-file> <animation-file>
  26.  
  27. The options are listed in the original documentation. The <list-file>
  28. parameter is the name of a file that contains a list of newline (character
  29. 10) separated filenames for the images. Under RISC OS, I have found that the
  30. easiest way to create such a file is to select all the files in the directory
  31. viewer and shift-drag them all to an empty text editor's window where the
  32. names of all the files will be inserted. The resulting list will be space
  33. separated, so call up the editor's search and replace dialogue box and
  34. replace all spaces with newline characters. For example, in !Zap, the
  35. dialogue box is produced by SHIFT-F4 where a space is entered in the 'search
  36. for' field and \n is entered in the 'replace with' field. When the list is
  37. formatted properly, it may be necessary to ensure that the files are listed
  38. in the correct order. This file is then saved, perhaps to the RAM disc, so
  39. that it can be shift-dragged to a task window when constructing the command.
  40.  
  41. Restrictions (or perhaps not)
  42. ------------
  43.  Currently filters, as defined by the +f option, are disabled. However, I do
  44. not think that this is a problem. Filters seem to be used for two main
  45. purposes:-
  46.  
  47. 1) if the input files are of the wrong type and need to be converted,
  48.  
  49. 2) if the input files are compressed and need to be decompressed first.
  50.  
  51. I see the main use for ppm2fli as an animation creator for the frames created
  52. by POV-Ray, which can create images of the correct type anyway. If
  53. conversion is necessary, then !ChangeFSI can be used to convert many types of
  54. file to the PPM file type (although this may need to be done via the command
  55. line).
  56.  
  57. As for compression, ZIP archives maintained by !SparkFS can be treated
  58. exactly like normal directories. A list-file of ZIPed images can be created
  59. in the same way as described above and !SparkFS will decompress them
  60. automatically as ppm2fli requests the files.
  61.  
  62. unflick
  63. -------
  64. RISC OS port V0.01 (17th August 1996)
  65.  
  66.  This is a RISC OS port of the Unix utility unflick. It's purpose is to
  67. extract individual frames from an FLI/FLC animation file.
  68.  
  69. unflick is used as follows:
  70.  
  71.  unflick <options> <animation> <base> <extension>
  72.  
  73. The options are described in the original documentation.
  74.  
  75. Output filenames
  76. ----------------
  77.  If the parameter <extension> is omitted, the names of the generated files
  78. are composed of the given <base> followed by a number field:
  79.  
  80.  base001,
  81.  base002,
  82.  base003,
  83.  etc.
  84.  
  85. You must ensure that the final filename does not exceed ten characters in
  86. length, unless the images are being output to an archive that allows long
  87. filenames.
  88.  If an <extension> is given, then the file names consist of the <base>
  89. followed by the number field, a back slash character and the given extension:
  90.  
  91.  base001/ext,
  92.  base002/ext,
  93.  base003/ext,
  94.  etc.
  95.  
  96. Again you must ensure that the resulting filename does not exceed ten
  97. characters, otherwise it will be truncated. I decided to leave the
  98. option of an extension in unflick to make the possible use of resulting files
  99. in DOS easier.
  100.  
  101. Output compression
  102. ------------------
  103.  Unfortunately, I had to disable the options -z and -zz. These allowed the
  104. use of compress or gzip to compress the output files. I was only able to try
  105. gzip and found that it crashed the machine when automatically invoked from
  106. unflick. It worked correctly when I used it to manually compress the files.
  107.  Automatic compression of output files can still be achieved by specifying a
  108. base name that exists within a !SparkFS ZIP archive.
  109.  
  110. Lee Noar
  111. <leenoar@argonet.co.uk>
  112.