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