home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / CreativeComputers.iso / shareware / text / ppmore_2.2 / ppmore.doc < prev    next >
Text File  |  1994-11-17  |  12KB  |  284 lines
  1.  
  2.  
  3.  
  4.                             PPMore 2.2 User Manual
  5.  
  6.                                  Aug 23, 1992
  7.  
  8.  
  9.  
  10. Preface
  11. =======
  12.  
  13. The programs and files in this distribution are freely distributable, but are
  14. also copyright (c) Nico Franτois.  They may be freely distributed as long as
  15. no more than a nominal fee is charged to cover time and copying costs.
  16.    No commercial usage is permitted without written permission from the
  17. author.  Everything in this distribution must be kept together, in original
  18. unmodified form.
  19.    The above is generally known as freeware.
  20.  
  21.  
  22.    Coverdisks or diskmagazines need written permission of UGA to offer the
  23. Powerpacker utilities or Powerpacker/Reqtools libraries on their disk. For
  24. commercial use please read the copyright file on your original PP disk.
  25.  
  26.    If you have suggestions or remarks about this program, or if you find
  27. any bugs, please let me know.
  28.  
  29.    Write to the following address:
  30.  
  31.                                 Nico Franτois
  32.                                 Corbielaan 13
  33.                                 B-3060 Bertem
  34.                                 BELGIUM
  35.  
  36.    PPMore 2.0 requires AmigaDOS Release 2 (Kickstart & Workbench 2.0) to run.
  37.  
  38.  
  39. Contents
  40. ========
  41.  
  42. 1. An introduction
  43.  
  44. 2. Usage
  45.  
  46. 3. Control
  47.  
  48. 4. Using PPMore from other programs
  49.  
  50.  
  51. 1. An introduction
  52. ==================
  53.  
  54. This program was written to complement one of my other utilities,
  55. PowerPacker (a command and data cruncher).  It is used to read normal ascii
  56. text files or text files crunched with PowerPacker.  The program itself is
  57. about 13K long and when you know you save about 60% when you crunch a text
  58. file, you can see that this could save a lot of space on your disks.
  59.  
  60.    PPMore was written as a more replacement (as you could have guessed :-),
  61. so I tried to keep the keyboard commands the same as well as adding some new
  62. ones.  There are two main differences between PPMore and More, PPMore uses
  63. gadgets and it always loads the complete file in memory (More only loads part
  64. of the file and will load the rest when needed).  If you can live with these
  65. differences, you can replace More with PPMore anywhere you want.
  66.  
  67.    PPMore uses 'powerpacker.library' and 'reqtools.library', so make sure
  68. these are present in your Libs: directory.  Double-click 'Install_libs' for
  69. an automatic installation.
  70.  
  71.    If you haven't got PowerPacker you are of course missing one of the main
  72. features of this program.  PowerPacker is available as shareware (up to
  73. version 2.3b) or as a commercial program (version 4.0a).  Order a copy from
  74. UGA, P.O.Box 881, 3700 AW Zeist, The Netherlands.  The commercial version
  75. offers several enhancements like 40 to 50 times faster crunching, overlay
  76. support, an ARexx port, and much more.
  77.  
  78.  
  79. 2. Usage
  80. ========
  81.  
  82. PPMore can be used in several different ways.
  83.  
  84. - First of all via the CLI:
  85.  
  86.    If you enter 'PPMore ?' you will get a standard AmigaDOS template.  Enter
  87. 'PPMore ??' for more information.  You use PPMore like this:
  88.  
  89.    PPMore [<file|dir>] [TABS n] [PUBSCREEN <name|@addr|@*>]
  90.                        [MEMVIEW m,l,f[,n]]
  91.  
  92.    If you provide a file the program will load and display it.  Files
  93. crunched using PowerPacker 2.0 or higher will be automatically decrunched by
  94. PPMore.  If the file was encrypted you will be prompted for the password.
  95.  
  96.    Options:
  97.  
  98.       TABS n     Select tabsize, default is 8.  Also see the Settings menu.
  99.       PUBSCREEN  Specify the public screen (by name) where PPMore should open
  100.                  its main window.  Note that only real public screens will
  101.                  be recognized, not any screen.  If you do not specify this
  102.                  option the default public screen will be used (normally
  103.                  the Workbench).
  104.  
  105.    The MEMVIEW option and other uses of the PUBSCREEN option are explained in
  106. section 4.
  107.  
  108.    PPMore can be made resident so it doesn't have to be loaded every time
  109. you use it, use the C: Resident command for this.  You can't make PPMore
  110. resident when it is crunched!!  The file is supplied as an uncrunched command
  111. file with the pure bit set.
  112.    If you enter PPMore without options, you will be presented with a file
  113. requester.  Entering PPMore with a directory instead of a file as an argument
  114. will also get you a file requester, but it will be positioned in the directory
  115. you specified.
  116.  
  117.    Examples:
  118.  
  119.      o PPMore DOCS:PPMore.doc TABS 4
  120.  
  121.          Load and display 'DOCS:PPMore.doc' and use a tabsize of 4 spaces.
  122.  
  123.      o PPMore PUBSCREEN "Public Screen" TABS=6 AUTO:
  124.  
  125.          Put up file requester (in directory AUTO:) and open window on
  126.        the public screen named 'Public Screen' (if found).  Quotes are
  127.        used to pass a screentitle with spaces.  Use tabsize of 6.
  128.  
  129.      o PPMore ppmore.doc.pp PUBSCREEN Workbench
  130.  
  131.          Load and display 'ppmore.doc.pp' on the Workbench screen, no
  132.        matter what the default public screen is.
  133.  
  134. - Via the WorkBench:
  135.  
  136.    There are three different ways of using PPMore via the workbench: you
  137. can set the default tool of the (crunched) text file to 'PPMore', you can
  138. single click the PPMore icon and then double click the text file icon or you
  139. can double-click the PPMore icon and pick a file using the file requester.
  140.  
  141.    You set the default tool by single clicking the icon of the text file
  142. and selecting 'Info' from the workbench menu.  You will get a window with
  143. several gadgets in it, click in the string gadget where it says 'Default
  144. tool' and enter 'PPMore'.  PPMore should be in the command path for this to
  145. work, otherwise you must enter the full path so Workbench can find it.  Last
  146. of all select the 'Save' gadget.
  147.  
  148.    Following tooltype is recognized by PPMore (in the text file's icon, not
  149. PPMore's icon):
  150.  
  151.      TABS=n  : Set tabsize for file (default 8).
  152.  
  153.  
  154. NOTE: - PPMore will add '.pp' to the filename when the file wasn't found.
  155.         This is very useful in the WorkBench enviroment: you can make an
  156.         icon for 'text.doc' but name the file 'text.doc.pp'.  Now the
  157.         WorkBench will show an icon with 'text.doc' as name, but if you
  158.         doubleclick it 'text.doc.pp' will be displayed.  (As long as there
  159.         is no 'text.doc' file in the directory!)
  160.       - After reading a file you can press 'L' to load a new file, instead of
  161.         quitting and restarting.
  162.       - In the AmigaDOS template ignore the /M modifier on FILE, PPMore does
  163.         not accept multiple file names (it was needed to let PPMore still
  164.         support the old command line format for compatibility).
  165.  
  166.  
  167. 3. Control
  168. ==========
  169.  
  170.    PPMore can be controlled by keyboard or by intuition gadgets.  To get a
  171. summary of the keyboard commands press <HELP>, the function of the gadgets
  172. shouldn't be hard to understand.
  173.  
  174.    A few notes on printing:
  175.  
  176.    o The printer.device has to be in the DEVS: directory for PPMore to be
  177.      able to print, you should also have correct preferences settings for
  178.      your printer.  Make especially sure the number of lines is correct.
  179.  
  180.    o You can continue to read the text when PPMore is printing (this IS a
  181.      multitasking computer! :-), you *CAN* quit when printing is still in
  182.      progress, printing will continue and all memory will be freed once it
  183.      is finished.
  184.  
  185.    PPMore has a settings menu that allows you to change most of its settings.
  186. You can save these settings, snapshot or unsnapshot PPMore's window.
  187.  
  188.    The settings menu allows you to switch the following things on/off:
  189.  
  190.    o Scroll Text:  This determines if text is scrolled or paged upon doing
  191.      a page up or down.  Note that the shifted keys/gadgets temporarily
  192.      reverse this switch.  By this I mean that if Space does a paged page
  193.      down, pressing Shift Space will do a scrolled page down.
  194.  
  195.    o Wrap Lines:  Line wrap mode determines how lines that are too long will
  196.      be displayed.  If it is on long lines will continue on the next line, if
  197.      it is off they will be cut off.  If a line is cut off an inverse '>'
  198.      will appear on the right edge of the window.
  199.  
  200.    o Line Numbers:  If this is on PPMore will display line number in the
  201.      title of its window instead of a percentage.
  202.  
  203.    You can also change the tab size and the window's font.  Any fixed width
  204. font will work.  'Snapshot Window' will remember PPMore's window position.
  205. 'Unsnapshot Window' will forget the position and will go back to the default
  206. behaviour of opening a window as large as the visible screen size.
  207.  
  208.  
  209. 4. Using PPMore from other programs
  210. ===================================
  211.  
  212.    If you are not a programmer you can skip this section.
  213.  
  214.    PPMore has two special options to make it possible to use it from other
  215. programs.  This way you don't have to include a text displayer in your
  216. program, you just execute PPMore with one (or all) of the following options:
  217.  
  218.    MEMVIEW mem,len,flags[,name]
  219.  
  220.      If you specify this option PPMore will not load a file but instead it
  221.    will display a chunk of memory.  You specify the memory addres and
  222.    length in the command line as well as some flags.  The current version
  223.    only has one flag: PPMORE_FREEMEM = bit 0 of the flag-word = 0x1.
  224.      When this flag is set PPMore will free the memory after it has
  225.    finished (using exec.library/FreeMem()), if it isn't set PPMore will
  226.    just exit and leave the memory alone.  This way your program can start
  227.    PPMore with the PPMORE_FREEMEM flag set and exit before PPMore has ended.
  228.    PPMore will then free the memory instead of your program.
  229.      The address, length and flags must be presented as HEX longwords
  230.    seperated by a comma.  These options can be followed by another comma
  231.    and a string to give the memory chunk a name, if this string is omited
  232.    PPMore will use the name 'memory'.
  233.  
  234.    PUBSCREEN @addr  or  PUBSCREEN @*
  235.  
  236.      Apart from the use of the PUBSCREEN option explained in section 2, you
  237.    can supply a '@' followed by a screen address in HEX or a '*'.  PPMore
  238.    will then open the main window on this screen.  If you specify a '*' the
  239.    frontmost screen will be used.
  240.  
  241.    Examples:
  242.  
  243.      o PPMore MEMVIEW "1A000,1D4E,0,my chunk"
  244.  
  245.          PPMore will open a window 'Listing of my chunk', start
  246.        displaying at address 0x1A000 and stop at address 0x1BD4E.  The
  247.        memory will not be freed after PPMore exits.  Note the use of
  248.        quotes to get a title with spaces in.
  249.  
  250.      o PPMore PUBSCREEN @c2d8a0 MEMVIEW 1A000,1D4E,1,memname
  251.  
  252.          Same as previous but now PPMore will free the memory chunk and
  253.        open the main window on the custom screen with the screen structure
  254.        on address 0xc2d8a0.
  255.  
  256.      o PPMore PUBSCREEN @* myfile
  257.  
  258.          Load and display the file 'myfile' and open window on the front
  259.        screen.
  260.  
  261. NOTE: - If you use PPMore on another screen that is not a public screen
  262.         PPMore will not check if the screen closes!  PPMore should always
  263.         finish before this screen is closed! (There is no problem when you
  264.         open the window on a public screen)
  265.       - Watch out when using these options, it is very easy to crash the Amiga
  266.         if you don't know what you are doing!  Using the PUBSCREEN with
  267.         the name of a public screen is of course 100% safe.
  268.       - The '-S' and '-@' options of older versions of PPMore are still
  269.         supported for compatibility, but you should no longer use them.
  270.  
  271.  
  272.                       As always, I hope you find this program useful!
  273.  
  274.  
  275. ******************************************************************************
  276.  
  277. PPMore 2.2 written by Nico Franτois (Yes, Nico is my first name :-)
  278.            thanks to Holger Lubitz for the many bug reports :^) and all the
  279.                                    useful suggestions.
  280.  
  281. (c) 1992 Nico Franτois
  282.  
  283.  
  284.