home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d542 / ppmore.lha / PPMore / PPMore.doc < prev    next >
Text File  |  1991-09-19  |  16KB  |  357 lines
  1.  
  2.  
  3.                             PPMore 1.8 User Manual
  4.  
  5.                                  May 11, 1991
  6.  
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12.      The programs and files in this distribution are freely distributable,
  13. but are also Copyright (c) Nico François.  They may be freely distributed as
  14. long as 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.  
  31. Contents
  32. ========
  33.  
  34. 1. An introduction
  35.  
  36. 2. Usage
  37.  
  38. 3. Control
  39.  
  40. 4. Using PPMore from other programs
  41.  
  42.  
  43. 1. An introduction
  44. ==================
  45.  
  46.      This program was written to complement one of my other utilities,
  47. PowerPacker (a command and data cruncher).  It is used to read normal ascii
  48. text files or text files crunched with PowerPacker.  The program itself is
  49. about 10K long and when you know you save about 60% when you crunch a text
  50. file, you can see that this could save a lot of space on your disks.
  51.      PPMore was written as a more replacement (as you could have guessed :-),
  52. so I tried to keep the keyboard commands the same as well as adding some new.
  53. There are two main differences between PPMore and More, PPMore uses gadgets
  54. and it always loads the complete file in memory (More only loads part of the
  55. file and will load the rest when needed).  If you can live with these
  56. differences, you can replace More with PPMore anywhere you want.
  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 3.0a).  Order a copy for
  60. $17.50 (Europe) or $20 (outside Europe) from UGA, P.O.Box 881, 3700 AW Zeist,
  61. The Netherlands (only Eurochecks in Dutch Guilders or cash).  The commercial
  62. version offers several enhancements like 40 to 50 times faster crunching and
  63. overlay crunching.
  64.  
  65.  
  66. 2. Usage
  67. ========
  68.  
  69.      PPMore can be used in four different ways.
  70.  
  71. - First of all via the CLI:
  72.  
  73.      If you enter PPMore without arguments you will get a usage template.
  74. You use PPMore like this:
  75.  
  76.      PPMore [<options>] [<file|dir>]
  77.  
  78.      The program will then load the ascii file and display it.  If the file
  79. was crunched using PowerPacker 2.0 or higher PPMore will first decrunch it
  80. for you.  If the file was encrypted you will be prompted for the password.
  81.      The '-w' option switches on line wrap mode.  Line wrap mode determines
  82. how long lines will be displayed.  If it is on (default) long lines will
  83. continue on the next line, if it is off they will be cut off.  Press 'w' to
  84. toggle it on/off.  If a line is cut off a complemented '>' will appear on the
  85. right edge of the display.
  86.      The other options are explained in section 4.
  87.  
  88.      PPMore can be made resident so it doesn't have to be loaded every time
  89. you use it, use the ARP ARes command or the c: Resident command for this.
  90. You can't make PPMore resident when it is crunched !!  The file is supplied
  91. as an uncrunched command file with the pure bit set.
  92.      If you enter PPMore without options, you will be presented with either a
  93. file prompt or a filerequester (if arp.library or asl.library is available).
  94. Entering PPMore with a directory instead of a file as an argument will also
  95. get you a requester, but it will be positioned in the directory you specified.
  96.      Enter 'PPMore ?' for a little usage message.
  97.  
  98. - Via the WorkBench:
  99.  
  100.      There are three different ways of using PPMore via the workbench: you
  101. can set the default tool of the (crunched) text file to 'PPMore', you can
  102. single click the PPMore icon and then double click the text file icon or you
  103. can double-click the PPMore icon and enter the filename in the string gadget
  104. (or the ARP filerequester) you will be presented with.
  105.      You set the default tool by single clicking the icon of the text file
  106. and selecting 'Info' from the workbench menu.  You will get a window with
  107. several gadgets in it, click in the string gadget where it says 'Default
  108. tool' and enter ':ppmore'.  PPMore should be in the root directory of your
  109. disk for this to work, if e.g. it's in the system directory you should enter
  110. ':system/ppmore'.  Last of all select the 'Save' gadget.
  111.  
  112. NOTE: - PPMore will add '.pp' to the filename when the file wasn't found.
  113.         This is very useful in the WorkBench enviroment: you can make an
  114.         icon for 'text.doc' but name the file 'text.doc.pp'.  Now the
  115.         WorkBench will show an icon with 'text.doc' as name, but if you
  116.         doubleclick it 'text.doc.pp' will be displayed.  (As long as there
  117.         is no 'text.doc' file in the directory !)
  118.       - Once you are in PPMore press 'L' to load a new file, this is
  119.         especially useful if the arp.library is available.
  120.  
  121.  
  122. 3. Control
  123. ==========
  124.  
  125.      PPMore can be controlled by keyboard or by intuition gadgets.  To get a
  126. summary of the keyboard commands press <HELP>, the function of the gadgets
  127. shouldn't be hard to understand.
  128.  
  129.      A few notes on printing:
  130.  
  131. - The printer.device has to be in the devs: directory for PPMore to be able
  132.   to print, you should also have a correct system-configuration for your
  133.   printer.
  134.  
  135. - You can continue to read the text when PPMore is printing (this IS a
  136.   multitasking computer ! :-), you can't quit when printing is still in
  137.   progress !
  138.  
  139.  
  140. 4. Using PPMore from other programs
  141. ===================================
  142.  
  143.      If you are not a programmer you can skip this section.
  144.  
  145.      PPMore has two power options to make it possible to use it from other
  146. programs.  This way you don't have to include a text displayer in your
  147. programs, you just execute PPMore with one (or all) of the following options:
  148.  
  149.      -@mem,len,flags[,name]
  150.  
  151.        If you specify this option PPMore will not load a file but instead it
  152.      will display a chunk of memory.  You specify the memory addres and
  153.      length in the command line as well as some flags.  The current version
  154.      only has one flag: PPMORE_FREEMEM = bit 0 of the flag-word = 0x1.
  155.        When this flag is set PPMore will free the memory after it has
  156.      finished, if it isn't set PPMore will just exit and leave the memory
  157.      alone.  This way your program can start PPMore with the PPMORE_FREEMEM
  158.      flag set and exit before PPMore has ended.  PPMore will then free the
  159.      memory instead of your program.
  160.           The address, length and flags must be presented as HEX longwords
  161.      seperated by a comma.  These options can be followed by another comma
  162.      and a string to give the memory chunk a name, if this string is omited
  163.      PPMore will use the name 'memory'.  This string ends with the end of the
  164.      command line so it can contain spaces.
  165.  
  166.      -Sscreen or -S*
  167.  
  168.        With this option you can use PPMore on another screen.  You must
  169.      provide a screen address in HEX.  PPMore will the open the main window
  170.      on this screen.  If you specify a '*' instead of a screen address the
  171.      frontmost screen will be used.
  172.  
  173.      Examples:
  174.  
  175.        o  PPMore -@1A000,1D4E,0,my chunk
  176.  
  177.             PPMore will open a window 'Listing of my chunk', start
  178.           displaying at address 0x1A000 and stop at address 0x1BD4E.  The
  179.           memory will not be freed after PPMore exits.
  180.  
  181.        o  PPMore -Sc2d8a0 -@1A000,1D4E,1,my chunk
  182.  
  183.             Same as previous but now PPMore will free the memory chunk and
  184.           open the main window on the custom screen with the screen structure
  185.           on address 0xc2d8a0.
  186.  
  187.        o  PPMore -S* myfile
  188.  
  189.             Load and display the file 'myfile' and open window on the front
  190.           screen.
  191.  
  192. NOTE: - The options are case sensitive.
  193.       - The @ option must always be the last option on the command line.
  194.       - If you open PPMore on another screen PPMore will not check if the
  195.         screen closes !!  PPMore should always finish before this screen is
  196.         closed !
  197.       - I advise you to use the ARP 1.3 SyncRun and/or ASyncRun instead of
  198.         the AmigaDOS Execute function to execute PPMore from your programs
  199.         because the ARP functions also work when your program has been
  200.         started from WorkBench.  I suppose Kickstart 2.0 will offer some
  201.         better ways of executing programs.
  202.       - Watch out when using these options, it is very easy to crash the Amiga
  203.         if you don't know what you are doing !!!
  204.  
  205.  
  206.                       As always, I hope you find this program useful !
  207.  
  208.  
  209.                               PROGRAM HISTORY:
  210.  
  211. *****************************************************************************
  212. VERSION 1.0
  213.  
  214.      First release.
  215.  
  216. *****************************************************************************
  217. VERSION 1.1
  218.  
  219.      '.pp' suffix added to filename when file not found, very useful in
  220.        WorkBench enviroment.
  221.      PPMore now also loads encrypted files. (PowerPacker 2.3a or higher)
  222.  
  223. *****************************************************************************
  224. VERSION 1.2
  225.  
  226.      Rewritten some routines in assembler, results in a slightly faster
  227.        and smaller PPMore.
  228.      Keyboard input improved. Autorepeat of keys is ignored so you can keep
  229.        on pressing <page down> without typing it 20 times ahead !
  230.      Gadget input also improved, now handles repeat.
  231.      PPMore now prompts for a filename when double-clicked from WorkBench.
  232.  
  233. *****************************************************************************
  234. VERSION 1.3
  235.  
  236.      PPMore can now be made resident and is reentrant. (provided PPMore is
  237.        not crunched)
  238.      Improved error reporting, the main window only opens when PPMore is
  239.        going to display the file.
  240.      File is checked to see if it is an ASCII (text) file.
  241.      Two new power-options for use of PPMore from other programs:
  242.        -@ to display memory, -S to open window on a custom screen.
  243.      Fast assembler search function added.
  244.      Display position is displayed in titlebar (percentage).
  245.      Goto n% function added, replaced 'Refresh' gadget with this function.
  246.      Decrunching is 15% faster.
  247.      'Exit PPMore' only selected when button is released on top of gadget.
  248.      NO bugs removed because none where found. :-)
  249.      Only about 700 bytes larger than version 1.2 !
  250.  
  251. *****************************************************************************
  252. VERSION 1.4
  253.  
  254.      Bug fixed: PPMore 1.3 was not 100% pure, version 1.4 is !
  255.      ASCII check less strict (e.g. now allows files to contain a '©')
  256.      Another 300 bytes shorter than version 1.3 :-)
  257.  
  258. *****************************************************************************
  259. VERSION 1.5
  260.  
  261.      Bug fixed: search/goto window always opened on WorkBench screen.
  262.      Find previous also implemented.
  263.      Load a new file from within PPMore.
  264.      PPMore uses ARP file requester if arp.library is available.
  265.      Line count, as well as goto line.
  266.      Display position as percentage or line number.
  267.      Keypad = movement. (for PC-lovers, yek :-( )
  268.      PPMore now supports all keymaps !! I think especially german and french
  269.        Amiga users will be grateful for this.
  270.      Less than 600 bytes longer than version 1.4 (I love this :-D)
  271.  
  272. *****************************************************************************
  273. VERSION 1.5a
  274.  
  275.      Decrunching is 40% faster, this was a stupid mistake in 1.3 to 1.5,
  276.        I accidently used a slower instead of a faster decrunch routine :-(
  277.  
  278. *****************************************************************************
  279. VERSION 1.5b
  280.  
  281.      The Guru isn't with me lately, after using a slow decruncher in 1.3-1.5
  282.        by accident I now used a fast but faulty decruncher in 1.5a. It
  283.        sometimes didn't decrunch correctly, this has now been fixed. The
  284.        decruncher is still 40% faster than the 1.3-1.5 one. (and it's 2 bytes
  285.        shorter :^D )
  286.  
  287. *****************************************************************************
  288. VERSION 1.6
  289.  
  290.      Bugs in search fixed, didn't work correctly when used in large files and
  291.        sometimes didn't work at all :-(
  292.      Error output goes to the console when you start PPMore from the CLI,
  293.        WorkBench error reporting still in small window as before.
  294.      The ASCII check was made less strict (again).  I got a lot of complaints
  295.        from German users trying to display german documents, this should now
  296.        no longer be a problem.
  297.      If you deactivated the window when PPMore was loading PPMore would hang
  298.        until you resized its window, this has been fixed.  (Actually, I
  299.        worked around this problem, I think it was an Intuition bug :-)
  300.      PgUp, PgDn and the shifted arrow keys now do an immediate page up/down
  301.        without scrolling, SPACE and BS still scroll up/down.
  302.      Changed some things so PPMore runs better on Kickstart 2.0, next
  303.        version of PPMore will probably be a Kick 2.0 only version so I can
  304.        make use of all the new goodies of the new OS :^)
  305.  
  306. *****************************************************************************
  307. VERSION 1.6a
  308.  
  309.      Small update on special request.  Now possible to dump just the visible
  310.        page to the printer instead of the entire file.
  311.  
  312. *****************************************************************************
  313. VERSION 1.7
  314.  
  315.      No Kickstart 2.0 only version yet.  Changed some stuff so PPMore looks
  316.        best on Kick 2.0 and still runs on Kick 1.3.
  317.      Uses the all new powerpacker.library => shorter code :^D
  318.      Starting PPMore from the CLI with a directory as an argument now puts
  319.        up the requester positioned in that directory. Extremely useful once
  320.        you get used to this :^)
  321.      Small bug fixed in search routine, it sometimes missed an occurence.
  322.      PPMore filters out form-feeds and replaces them with <FORM FEED>.
  323.      If you are running Workbench 2.0 PPMore will use the asl.library
  324.        instead of the arp.library (for the filerequester).
  325.      Now fully supports system & screen fonts different than topaz 8.
  326.      Automatic refresh when you resize the window (only on Kick 2.0,
  327.        couldn't be done on 1.3 because of bug in console.device)
  328.      Used different technique to find workbench screen size, using
  329.        NormalDisplayRows no longer seemed to work on 2.0 ?!?!?
  330.  
  331.      REVISION 1.71
  332.      ~~~~~~~~~~~~~
  333.      Percentage background color is now white again on Kickstart 1.3.
  334.      Removed read in low memory when the close gadget was used.  Thanks to
  335.        the enforcer I was able to fix this VERY obscure bug :-)
  336.  
  337. *****************************************************************************
  338. VERSION 1.8
  339.  
  340.      Nicer new-look 3D gadgets in window border for Kickstart 1.3.
  341.      Line wrap on/off implemented.  If switched off causes all lines to be
  342.        cut off at the right edge of the window.
  343.      Seemed that the asl requester no longer worked on the latest
  344.        Kickstart 2.0 (release V37). Fixed.
  345.  
  346. *****************************************************************************
  347.  
  348. PPMore 1.8 written by Nico François (Yes, Nico is my first name :-)
  349.             thanks to Holger Lubitz for the many bug reports :^) and all the
  350.                                     useful suggestions.
  351.  
  352. (c) 1991 Nico François / PowerPeak
  353.  
  354.                                    //
  355.                        Thanks to \X/ Amiga for being the best computer ever !
  356.  
  357.