home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d547 / view.lha / View / View.DOC < prev    next >
Text File  |  1991-09-19  |  14KB  |  317 lines
  1.  
  2.                            - View version 1.3 -
  3.  
  4.                   --------------------------------------- 
  5.                   -  © Copyright 1991 Jaba Development  - 
  6.                   -       written using DICE C by       - 
  7.                   -          Jan van den Baard          - 
  8.                   --------------------------------------- 
  9.  
  10.  
  11.   DISCLAIMER
  12.   ----------------------------------------------------------------------------
  13.   The author is not responsible for any damage caused by the use  or misuse of
  14.   this documentation and/or the program(s) it describes.  Any damage resulting
  15.   from the  use or misuse  of this  documentation  and/or  the  program(s)  it
  16.   describes is the sole responsibility of the user her/him self.
  17.   ----------------------------------------------------------------------------
  18.  
  19.   COPYRIGHT
  20.   ----------------------------------------------------------------------------
  21.   View, © Copyright 1991 Jaba Development.  All rights reserved.  This program
  22.   may  be  distributed   non-commercially  providing  that  the  source  code,
  23.   documentation, copyright notices  and executable remain  unchanged  and  are
  24.   included in the distribution. Also no more than a  !NOMINAL! copy fee may be
  25.   charged for the distribution.  This  program is  FREEWARE  so  no  financial
  26.   donations are required ( The only thing I would like is a postcard from your
  27.   home town!). Any form of commercial usage is not allowed  without my written
  28.   permission.
  29.   ----------------------------------------------------------------------------
  30.  
  31.  
  32.   Some of you might be familiar with  other versions of View.  These  versions
  33.   of View have been totally rewritten by me to run  only under OS 2.  The key-
  34.   commands have changed radically from  the older  versions of View.  All  the
  35.   key-commands MORE supports are supported by View  plus a lot of new commands
  36.   where added.
  37.  
  38.   View KeyMap commands :
  39.  
  40.     Space,Pg Dn ->
  41.  
  42.       This will go down one page of text (MORE).  If there are not  enough
  43.       lines left  in  the text  to fill  the  screen this function will go
  44.       down 'x' amount of lines until the last line is displayed.
  45.  
  46.     Backspace,Pg Up ->
  47.  
  48.       This  will go up  one page of text (LESS).  If there are not  enough
  49.       lines left  in  the text  to fill  the  screen this function will go
  50.       up 'x' amount of lines until the first line is displayed.
  51.  
  52.     Return,Dn,Nk Dn ->
  53.  
  54.       This will scroll the text up one line and display  the next  line of
  55.       text at the bottom of the screen.
  56.  
  57.     Enter,Up,Nk Up ->
  58.  
  59.       This will scroll the text down one line and display the next line of
  60.       text at the top of the screen.
  61.  
  62.     <,Nk Left ->
  63.  
  64.       This will display the first page of the text.
  65.  
  66.     >,Nk Right ->
  67.  
  68.       This will display the last page of the text.
  69.  
  70.     /,F ->
  71.  
  72.       This opens a little window in which  a string gadget is located.  In
  73.       this string  gadget you can type  a word or a  sentence you  want to
  74.       locate in the text.  Once you are done you should press  return  and
  75.       the  program  starts  to look  from the first line on the screen for
  76.       the specified string. If the  program finds the  string in  the text
  77.       it will be displayed inverse. The search is case sensitive.
  78.  
  79.     N/P ->
  80.  
  81.       This  will  look for the Next/Previous  occurrence  of the word last
  82.       found. The search will  begin from the  point where the program  had
  83.       found the string  the last  time you  have called one of the  search
  84.       routines. The search is case sensitive.
  85.  
  86.     .,S ->
  87.  
  88.       This does the same thing as /,F with the  exception that the  search
  89.       will be case insensitive.
  90.  
  91.     CTRL+N/CTRL+P ->
  92.  
  93.       This does the same thing as N/P with the  exception that the  search
  94.       will be case insensitive
  95.  
  96.     CTRL+L,R ->
  97.  
  98.       This will redisplay the text on the screen in the  (unlikely) event
  99.       that the display has been damaged for one or the other reason. This
  100.       has been featured to keep it all compatible to MORE.
  101.  
  102.     % ->
  103.  
  104.       This opens a  little window  with an integer  gadget in it.  In this
  105.       integer gadget you can type the  percentage (0 to 100)  of the  file
  106.       you want to jump to.
  107.  
  108.     E ->
  109.  
  110.       For  this to  work you  must use  SetEnv  to set-up  an  environment
  111.       variable called EDITOR. For example, if you normally use dme as your
  112.       editor and this  editor is  located in the C:  directory you  should
  113.       type  the  following  in the  shell:  SetEnv  EDITOR=C:Dme.  If  the
  114.       environment is  set up  correctly  the  program will run  the editor
  115.       with the  file currently in memory.  The program  looks through  the
  116.       DOS  resident list first to see if the editor is resident. If not it
  117.       will  try to load the editor from disk.  NOTE: The editor may NOT be
  118.       crunched !
  119.  
  120.     L ->
  121.  
  122.       This opens the ASL FileRequester for you to select  a file you  want
  123.       to read. When you are done select Load and,  if everything went  OK,
  124.       after the  loading is  done the  first  page of  the file  you  have
  125.       selected is displayed.
  126.  
  127.     J ->
  128.  
  129.       This is a feature not found in many of the other ASCII file viewers.
  130.       This will jump to the position where the program has found  a string
  131.       the last  time  one  of the  search  routines where  called.  It's a
  132.       feature I use a lot.
  133.  
  134.     B ->
  135.  
  136.       This puts View to sleep.  The program closes the screen and  sets up
  137.       an input-handler just  ahead of  intuition which  will  monitor  for
  138.       wake-up calls (See below). The text in memory will be lost.
  139.  
  140.     CTRL+B ->
  141.  
  142.       This does the same thing as B with the exception that the text  will
  143.       stay in  memory  and will be  available  when View  is signalled  to
  144.       wake-up again.
  145.  
  146.     LSHIFT+CTRL+D ->
  147.  
  148.       This will dump the page currently on the  screen to the  printer. It
  149.       uses the printer.device so make sure that it's set correctly.  While
  150.       the printing is in progress a little window is in  the screen's  top
  151.       left corner. Closing this window will  abort the printing.  Once you
  152.       have stopped the printing the printer  goes on until it's  buffer is
  153.       empty. You can continue  reading the file while  the printing  is in
  154.       progress. It is not possible to put View to sleep, quit or to load a
  155.       new file while the printing is in progress.
  156.  
  157.     LSHIFT+CTRL+P ->
  158.  
  159.       This will dump the complete text in memory to the printer. The  same
  160.       window as with LSHIFT+CTRL+D pops up to enable you to stop printing.
  161.  
  162.     H,HELP ->
  163.  
  164.       This puts some information about the author and  the available  key-
  165.       commands possible with this program.
  166.  
  167.     Q,CTRL+C,ESC ->
  168.  
  169.       This is a nasty one. Pressing any of these keys will quit View.
  170.  
  171.     Fn ->
  172.  
  173.       This enables you to mark blocks in the  text in memory.  This  block
  174.       marking goes in two fases. The first time you press  'F1' the  first
  175.       line on the screen will be the first line of text block #1. When you
  176.       press 'F1' again the last line on the screen will  be the last  line
  177.       of text block #1. Only when you have marked the first  and the  last
  178.       line of a text block the block will be marked. It's possible to mark
  179.       10 blocks in a text (F1..F10).
  180.  
  181.     SHIFT+Fn ->
  182.  
  183.       This will unmark text block #n making it free to  mark another  text
  184.       block.
  185.  
  186.     CTRL+Fn ->
  187.  
  188.       This will jump to the first line of text block #nm.
  189.  
  190.     LSHIFT+CTRL+Fn ->
  191.  
  192.       This will dump text block #n to the printer.  The printing window is
  193.       opened to enable you to stop the printing. You can continue to  read
  194.       the file while the printing is in progress.
  195.  
  196.     LALT+Fn ->
  197.  
  198.       This will open the ASL FileRequester in which you can select a  name
  199.       under which you can save text block #n.
  200.  
  201.   When View is sleeping :
  202.  
  203.       There are three wake-up calls the input-handler of  View will  catch
  204.       which are all introduced with :
  205.  
  206.            LEFT ALT + LEFT AMIGA 
  207.  
  208.         Pressing these keys in combination with :
  209.  
  210.            Q  will quit View while it is asleep.
  211.            V  will pop  up  the  main  screen  and  display  the  text  if
  212.               remembered or otherwise put up the ASL FileRequester for you
  213.               to load a file.
  214.            F  will erase the text, if remembered,  from memory.
  215.  
  216.   Starting View : 
  217.  
  218.     You can start View from  either the  CLI/Shell  or the Workbench. To start
  219.     View from the CLI/Shell you must type :
  220.  
  221.         View [path|filename]
  222.  
  223.     Where "filename" is an optional name of the file  you want to  read  or an
  224.     optional pathname in which the FileRequester will start to look for files.
  225.  
  226.     To start View from the Workbench you can either double-click it's icon  or
  227.     an icon of a file that has it's DefaultTool set to View.
  228.  
  229.   Requirements :
  230.  
  231.     View requires Kickstart 2.0 to run. Also a copy of the "nofrag.library" is
  232.     required to be in the LIBS: directory  of the  boot disk. If you also have
  233.     the  "powerpacker.library"  in the LIBS:  directory  View  is able to read
  234.     files crunched with PowerPacker. You will need the REGISTERED  version  of
  235.     DICE to  recompile  the  source code.  Also  you need  to make  registered
  236.     libraries of the "powerpacker_lib.fd" and the "nofrag_lib.fd" files  using
  237.     "fdtolib". "fdtolib" comes with both the registered and  freeware versions
  238.     of DICE. When you use View to read  PowerPacker crunched  files make  sure
  239.     that you  have  set-up 'T:' as a  logical device. If  not try to  add  the
  240.     following two lines in your startup-sequence :
  241.  
  242.             MakeDir RAM:T
  243.             Assign T: RAM:T
  244.  
  245.   Credits
  246.  
  247.     Credits must go to Matthew Dillon for his wonderfull  DICE C compiler  and
  248.     his  DME editor and DMouse and...and...and..., Thanks Matt!   By the  way,
  249.     you should register to DICE because it's the best deal  you'll ever  make!
  250.     Credits  also  must  go  to  Nico François  for his  PowerPacker  and  his
  251.     powerpacker.library. You should order a copy of "PowerPacker professional"
  252.  
  253.   TODO (perhaps...someday....when I feel like it.......)
  254.  
  255.     o  Making View automatically detach itself from the CLI. How about a auto-
  256.        detach "_main.c" Matthew ?
  257.  
  258.     o  Multiple texts. (Is this really necessary....(?))
  259.  
  260.     o  Putting View to sleep upon startup.
  261.  
  262.     o  Background process loading/displaying.
  263.  
  264.     o  Why don't you give me some ideas.....
  265.  
  266.   Notes :
  267.  
  268.     View  does not  scatter  memory because it  uses the  "nofrag.library"  to
  269.     allocate the memory for the text. It is not  possible to  put two or  more
  270.     copies of View to sleep at the same time.  All escape sequences  supported
  271.     by the console.device are supported by View. If the first  character  on a
  272.     line  is a  FormFeed  View will  translate it into F. The repeating of the
  273.     keys is handled in a way that View will never execute a function more than
  274.     once after you have released the keys. View automatically adapts itself to
  275.     the standard screen  resolution and  system font. View always displays one
  276.     column less than there would actually fit on the screen.  This  is because
  277.     the console.device uses a cursor, which is invisible in View,  that forces
  278.     the display to scroll when it hits the bottom-right corner of  the screen.
  279.     You should use LEFT_AMIGA+M/N to switch screens because  View it's  screen
  280.     has no depth gadget.
  281.  
  282.     View  makes  use of  the  "powerpacker.library" if available. This library
  283.     can be found on FISH 414 and is © Oct 1990 by Nico François.
  284.  
  285.   History :
  286.  
  287.     1.0               - Initial version. (let's see how it goes!)
  288.  
  289.     1.1               - The temporary  decrunched  file  did  not  get written
  290.                         to "T:". This has been fixed.
  291.  
  292.                         The Enforcer complained when View was started from the
  293.                         CLI or Workbench without any arguments. This  has been
  294.                         fixed.
  295.  
  296.                         View now has  a much improved  filename parser  which
  297.                         recognizes   and   parses   the   arguments  for  the
  298.                         ASL-FileRequester.
  299.  
  300.     1.2               - View now starts to look  for a string  from the  first
  301.                         line on the screen.  This  seems  to be  the  standard
  302.                         and it is less confusing.
  303.  
  304.                         View now offers the possibility to save the text blocks
  305.                         to a file.
  306.  
  307.     1.3               - View now supports ECS screen modes like SuperHires.
  308.  
  309.     Bug reports, flames, constructive criticism (I hope I spelled this right),
  310.     PD programs, ideas to the following address :
  311.  
  312.                                                   Jan van den Baard
  313.                                                   Bakkerstraat 176
  314.                                                   3082 HE, Rotterdam
  315.                                                   Netherlands
  316.  
  317.