home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 576.lha / PPShow_2.0 / PPShow.doc.pp / PPShow.doc
Encoding:
Text File  |  1991-12-06  |  13.4 KB  |  318 lines
  1.  
  2.  
  3.                             PPShow 2.0 User Manual
  4.  
  5.                                  Sep 22, 1991
  6.  
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12. The programs and files in this distribution are freely distributable, but are
  13. also copyright (c) Nico François.  They may be freely distributed as long as
  14. no more than a nominal fee is charged to cover time and copying costs.
  15.    No commercial usage is permitted without written permission from the
  16. author.  Everything in this distribution must be kept together, in original
  17. unmodified form.
  18.    The above is generally known as freeware.
  19.  
  20.    If you have suggestions or remarks about this program, or if you find
  21. any bugs, please let me know.
  22.  
  23.    Write to the following address:
  24.  
  25.                                 Nico François
  26.                                 Corbielaan 13
  27.                                 B-3060 Bertem
  28.                                 BELGIUM
  29.  
  30.    PPShow 2.0 requires AmigaDOS Release 2 (Kickstart & Workbench 2.0) to run.
  31.  
  32.  
  33. Contents
  34. ========
  35.  
  36. 1. An introduction
  37.  
  38. 2. Usage
  39.  
  40. 3. Features
  41.  
  42. 4. Note on crunching
  43.  
  44.  
  45. 1. An introduction
  46. ==================
  47.  
  48.    PPShow was written to complement one of my other utilities, PowerPacker
  49. (a command and data cruncher).  It is used to show normal IFF ILBM files or
  50. ILBM files crunched with PowerPacker.  The decrunching is done automatically
  51. so the user doesn't have to know if a file is crunched or not.
  52.  
  53.    PPShow uses 'powerpacker.library' and 'reqtools.library', so make sure
  54. these are present in your Libs: directory.  Double-click 'Install_libs' for
  55. an automatic installation.
  56.  
  57.    If you haven't got PowerPacker you are of course missing one of the main
  58. features of this program.  PowerPacker is available as shareware (up to
  59. version 2.3b) or as a commercial program (version 4.0a).  The commercial
  60. version offers several enhancements like 40 to 50 times faster crunching,
  61. overlay support, an ARexx port, and much more.
  62.  
  63.  
  64. 2. Usage
  65. ========
  66.  
  67.    PPShow can be used in several different ways.
  68.  
  69. - First of all via the CLI:
  70.  
  71.    If you enter 'PPShow ?' you will get a standard AmigaDOS usage template,
  72. enter 'PPShow ??' for more information.  You use PPShow like this:
  73.  
  74.    PPShow {<file|dir>} [LO] [HI] [SHI] [PROD] [L=LACE] [NL=NOLACE] [HAM]
  75.                        [TIME s] [NOCYCLE] [NO=NOOVERSCAN] [A2024 [15Hz]]
  76.                        [PAL] [NTSC] [VGA] [LOOP]
  77.  
  78.    The program will by default load the specified ILBM file and display it.
  79. If the file was crunched using PowerPacker 2.0 or higher PPShow will first
  80. decrunch it for you.  If the file was encrypted you will be prompted for the
  81. password.  You may specify more than one file on the command line and you may
  82. even use wildcards, PPShow will show all files one at a time, double buffering
  83. the display.
  84.  
  85.    If you enter PPShow without options, you will be presented with a
  86. filerequester.  Entering PPShow with a directory instead of a file as an
  87. argument will also get you a requester, but it will be positioned in the
  88. directory you specified.
  89.  
  90.    There are several command line options:
  91.  
  92.      LO         : Force screen to open in LORES        mode.
  93.      HI         :   ''    ''    ''   ''   HIRES         ''
  94.      SHI        :   ''    ''    ''   ''   SUPERHIRES    ''
  95.      PROD       :   ''    ''    ''   ''   PRODUCTIVITY  ''
  96.      LACE       : Force interlace on.
  97.      NOLACE     : Force interlace off.
  98.      HAM        : This switch is used to select HAM mode when no CAMG chunk
  99.                   is found.  If you don't specify this switch PPShow will
  100.                   assume a 6 plane screen is extra-halfbrite. Note that this
  101.                   switch does not force HAM mode, it merely instruct PPShow
  102.                   to use HAM mode in case of doubt.
  103.      TIME s     : Display pictures for 's' seconds.
  104.      NOCYCLE    : Do not start cycling automatically.
  105.      NOOVERSCAN : Disable overscan.
  106.      LOOP       : Display all pictures in a loop, press CTRL-D to abort.
  107.      PAL        : Use 'pal.monitor'.
  108.      NTSC       : Use 'ntsc.monitor'.
  109.      VGA        : Use 'multiscan.monitor'. Please note that when using VGA,
  110.                   LO puts the screen in EXTRALORES, HI in LORES and SHI in
  111.                   PRODUCTIVITY (same as PROD).
  112.      A2024      : Use 'a2024.monitor'.
  113.      15Hz       : Put A2024 monitor into 15Hz, rather than 10Hz.
  114.  
  115.    PPShow can be made resident so it doesn't have to be loaded every time
  116. you use it, use the c: Resident command for this.  You can't make PPShow
  117. resident when it is crunched!!  The file is supplied as an uncrunched command
  118. file with the pure bit set.  PPShow is reentrant as well, so you can run it
  119. from several CLI's at the same time.  (Not that this is very useful, but it's
  120. possible :-)
  121.  
  122.    Examples:
  123.  
  124.     o PPShow dh0:pics/HAMpicWithoutCAMG.pic HAM
  125.  
  126.     o PPShow dir/#?.pic TIME 5 LOOP
  127.  
  128.        Show all files in directory 'dir' with a '.pic' suffix for 5 seconds
  129.        and loop until user presses CTRL-D.
  130.  
  131.     o PPShow PICS:~(#?.info) NOOVERSCAN
  132.  
  133.        Show all files on 'PICS:' NOT ending in '.info'. Disable overscan.
  134.  
  135.  
  136. - Via the WorkBench:
  137.  
  138.    There are three different ways of using PPShow via the workbench: you
  139. can set the default tool of the (crunched) ILBM file to 'PPShow', you can
  140. single click the PPShow icon and then extend-select one or more picture icons
  141. (use shift click, double-clicking the last one) or you can double-click the
  142. PPShow icon and specify a filename using the filerequester.
  143.    You set the default tool by single clicking the icon of the picture and
  144. selecting 'Information' from the 'Icons' menu.  You will get a window with
  145. several gadgets in it, click in the string gadget where it says 'Default tool'
  146. and enter ':ppshow'.  PPShow should be in the root directory of your disk for
  147. this to work, if e.g.  it's in the system directory you should enter
  148. ':system/ppshow'.  Last of all select the 'Save' gadget.
  149.  
  150.    Following tooltypes are recognized by PPShow (in the pictures' icon, not
  151. PPShow's icon):
  152.  
  153.      HAM        : See CLI option.
  154.      TIME=s     : Display picture for 's' seconds.
  155.      NOCYCLE    : Do not start cycling automatically.
  156.      NOOVERSCAN : Disable overscan.
  157.  
  158.  
  159. NOTE: - Follow these steps to make a simple slideshow that runs by double-
  160.         clicking an icon:  Make a script file containing something like the
  161.         following line: 'PPShow #?.pic TIME 10 LOOP'.  Set this script's
  162.         default tool to 'c:IconX' and enter 'WINDOW=CON://///AUTO' in its
  163.         tooltypes.  Put the script in a directory containing pictures (all
  164.         ending in '.pic'!).  If you now double-click this scripts icon the
  165.         slideshow will start, press ESC or CTRL-D to end.
  166.       - PPShow will add '.pp' to the filename when the file wasn't found.
  167.         This is very useful in the Workbench enviroment: you can make an
  168.         icon for 'house.pic' but name the file 'house.pic.pp'.  Now the
  169.         WorkBench will show an icon with 'house.pic' as name, but if you
  170.         doubleclick it 'house.pic.pp' will be displayed. (As long as there
  171.         is no 'house.pic' file in the directory!)
  172.       - Drag as many monitor icons to the WbStartup drawer as your monitor
  173.         allows.  For example: if you have a multiscan monitor drag pal, ntsc
  174.         and multiscan.monitor to your WbStartup drawer.  If you do this you
  175.         will have maximum ease of use of PPShow.
  176.  
  177.  
  178. 3. Features
  179. ===========
  180.  
  181.    - Abort PPShow by pressing 'Q', CTRL-C or the right mouse button.  Press
  182.      CTRL-D to abort everything and to break a script.  The screen can be
  183.      dragged by pressing LEFT-AMIGA, holding down the left mouse button and
  184.      moving the mouse (you may have to press something else than LEFT-AMIGA,
  185.      depending on your 'IControl' preferences settings).
  186.  
  187.    - PPShow offers full overscan and monitor support: PAL, NTSC, VGA, A2024.
  188.  
  189.    - PPShow can be used as a simple slideshow tool.  It supports wildcards
  190.      to simplify this.
  191.  
  192.    - Deluxe Paint color cycling is supported, press <TAB> to (de)activate.
  193.      Up to 8 cycles are supported (DPaint III currently only supports 6).
  194.  
  195.    - The pesky little mouse will be removed while displaying.  Press 'M' to
  196.      toggle the mouse pointer on/off.
  197.  
  198.    - Press 'L' to load another picture, you will be presented with the
  199.      filerequester.
  200.  
  201.  
  202. 4. Note on crunching
  203. ====================
  204.  
  205.    A lot of IFF ILBM files are already crunched with the standard ByteRun1
  206. compression.  PowerPacker will crunch these files even further (most of the
  207. time) but will not crunch them as well as uncrunched ILBM files.  So save IFF
  208. files uncrunched (if you can, e.g. with PixMate) before crunching them, this
  209. way you will get the best crunching results.
  210.  
  211.  
  212.                         As always, I hope you find this program useful!
  213.  
  214.  
  215.                               PROGRAM HISTORY:
  216.  
  217. *****************************************************************************
  218. VERSION 1.0
  219.  
  220.      First release.
  221.  
  222. *****************************************************************************
  223. VERSION 1.1
  224.  
  225.      Decrunching is about 40% faster (accidently used slow decruncher in 1.0)
  226.      Screen now pops to front when picture is ready to be viewed, not before.
  227.      Filerequester used when arp.library is available.
  228.      'L' command added to load other pictures without restarting PPShow.
  229.  
  230. *****************************************************************************
  231. VERSION 1.1a
  232.  
  233.      The Guru isn't with me lately, after using a slow decruncher in 1.0
  234.        by accident I now used a fast but faulty decruncher in 1.1. It
  235.        sometimes didn't decrunch correctly, this has now been fixed. The
  236.        decruncher is still 40% faster than the 1.0 one. (and it's 2 bytes
  237.        shorter :^D )
  238.  
  239. *****************************************************************************
  240. VERSION 1.2
  241.  
  242.      Rewrote cycling routine in assembly, so less overhead when cycling.
  243.      Uses the all new powerpacker.library => shorter code.
  244.      Starting PPShow from the CLI with a directory as an argument now puts
  245.        up the requester positioned in that directory. Extremely useful once
  246.        you get used to this :^)
  247.      If you are running Workbench 2.0 PPShow will use the asl.library
  248.        instead of the arp.library (for the filerequester).
  249.      Fixed serious bug: memory wasn't freed when an IFF error occured.
  250.      No longer tries to display small brushes (intuition doesn't like very
  251.        small screens :( )
  252.  
  253. *****************************************************************************
  254. VERSION 2.0
  255.  
  256.      PPShow requires Kickstart 2.0 to run.  Sorry to all the 1.2 and 1.3
  257.        users, just consider this program as another reason to upgrade :-)
  258.  
  259.      Filerequester from arp.library is no longer supported.
  260.      PPShow now uses reqtools.library (also by moi) for its requesters.
  261.        Among other things this means a much better filerequester than
  262.        before (with a buffer).  Asl is no longer used, sorry Commodore :-)
  263.      Printing of screen removed, has anybody ever used this ? :-)
  264.      Improved command line format, follows AmigaDOS standard. (old option
  265.        '-h' is no longer supported!).
  266.      IFF decrunching rewritten in assembly: much faster and shorter.
  267.      Shows pictures saved in DPaint with stencil on. In other words: supports
  268.        IFF picture masking.
  269.      No longer quits when you press any key, you have to press 'Q', CTRL-C,
  270.        or right mouse button; CTRL-D aborts PPShow and breaks scripts.
  271.      Color cycling is now automatically switched on (except for brushes).
  272.      Mouse pointer visibility can be toggled.
  273.      Possibility to automatically stop displaying after a specified number
  274.        of seconds.
  275.      Many new command line options: change display resolution, switch off
  276.        overscan, disable auto-cycling, etc.
  277.      Several options may be set using Workbench tooltypes.
  278.      From Workbench, if you single-click PPShow and shift double-click a
  279.        drawer icon, PPShow will open up the filerequester in that drawer.
  280.      If you use 'PPShow <file>' or extend-select <file> from Workbench and
  281.        you invoke the filerequester, it will be positioned in the directory
  282.        <file> is in.
  283.      The filerequester will appear on the picture screen if possible.
  284.      Canceling the filerequester no longer quits PPShow.
  285.      The filerequester will filter out the .info files.
  286.      Can be used as a simple slideshow program: supports wildcards and
  287.        multiple files on command line, also possible to loop the slideshow.
  288.        Picture switching is double buffered.  Multiple extended selection
  289.        from Workbench is also supported.
  290.      Overscan now done using Kickstart 2.0 display clips.
  291.      Supports all new ECS display modes (ECS Denise only) and all monitors.
  292.      Will switch to PAL or NTSC monitor automatically (ECS Agnus only).
  293.      PPShow will now show very large screens without problem, AUTOSCROLL is
  294.        switched on so the screen automatically scrolls when you move the
  295.        mouse pointer off the edge.
  296.      Screen no longer has an invisible dragbar.  Use meta-dragging (left
  297.        Amiga key + mouse) to drag the screen.
  298.      Directories are expanded to their full pathnames on startup.
  299.      PPShow now returns a returncode of 20 in case of an error or if ended
  300.        by CTRL-D.
  301.      Error reporting improved: when started from CLI, errors are printed
  302.        on the console; when started from Workbench, a requester is used.
  303.      All these great new features and PPShow grew only about 1K in size :-)
  304.  
  305. *****************************************************************************
  306.  
  307. PPShow 2.0 written by Nico François (Yes, Nico is my first name :-)
  308.  
  309.  
  310. "Sometimes people can be oh so dense" - The Pixies
  311.  
  312.  
  313. (c) 1991 Nico François
  314.  
  315.                                    //
  316.                        Thanks to \X/ Amiga for being the best computer ever!
  317.  
  318.