home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d570 / view.lha / View / View.DOC < prev    next >
Text File  |  1991-11-21  |  18KB  |  397 lines

  1.  
  2.                            - View version 1.5 -
  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  waits
  137.       until the user call's view by  pressing a hotkey.  See below for the
  138.       hotkeys. 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.     CTRL+S ->
  202.  
  203.       This will open the ASL FileRequester in which tou can select a  name
  204.       under which you can save the whole text.
  205.  
  206.     SHIFT+E ->
  207.  
  208.       This will open a little window in which a string  gadget is located.
  209.       In this string gadget you see the  FIRST line  on the  screen  which
  210.       you can edit. When you  press return  the  line will be  replaced by
  211.       your  changes.  If you  press the  close gadget  of the  window  the
  212.       operation is canceled. This might come in handy if you spot an error
  213.       in your text and you want to  change it quickly.  It is  possible to
  214.       edit escape sequences in the string gadget.
  215.  
  216.   When View is sleeping :
  217.  
  218.       There are three "user-configurable" hotkeys  which will  signal View
  219.       to do something.  These  hotkeys can  be set  by  passing  a hotkey-
  220.       string (See below ) as an argument to view.
  221.  
  222.  
  223.       The following functions can be called with the use of hotkeys  while
  224.       view is asleep.
  225.  
  226.            QUIT   will quit View while it is asleep.
  227.            VIEW   will pop  up  the  main  screen  and  display  the  text
  228.                   if remembered or otherwise put up the  ASL FileRequester
  229.                   for you to load a file.
  230.            FLUSH  will erase the text, if remembered,  from memory.
  231.  
  232.   Starting View : 
  233.  
  234.     You can start View from  either the  CLI/Shell  or the Workbench. To start
  235.     View from the CLI/Shell you can type :
  236.  
  237.         Run View [Name]  [PRIORITY=<pri>] [POPWINDOW=<YES|NO>] [VIEW=<hotkey>]
  238.                  [FLUSH=<hotkey>] [QUIT=<hotkey>]
  239.  
  240.         With:   Name        : An optional name of the file you want to read or
  241.                               a pathname in which you  want the  FileRequester
  242.                               to start looking for files.
  243.  
  244.                 PRIORITY    : With this argument you can  specify  the  broker
  245.                               priority in the commodities queue.
  246.                               Default : 0
  247.  
  248.                 POPWINDOW   : This enables you  to  enable/disable  View  from
  249.                               opening it's window when it is started.
  250.                               Default : YES
  251.  
  252.                 VIEW        : With this argument you can set your own specific
  253.                               hotkey to let View open it's window.
  254.                               Default : lalt lcommand v
  255.  
  256.                 FLUSH       : With this argument you can set your own specific
  257.                               hotkey to let View flush it's text buffer.
  258.                               Default : lalt lcommand f
  259.  
  260.                 QUIT        : With this argument you can set your own specific
  261.                               hotkey to quit View while it's asleep.
  262.                               Default : lalt lcommand q
  263.  
  264.     You can specify the last five arguments through the ToolTypes array of the
  265.     program  it's  icon  for  the  Workbench.  When  you  start  View from the
  266.     WBStartup startup drawer you must set the DONOTWAIT tooltype also.
  267.  
  268.   HotKey Strings :
  269.  
  270.     With view you can specify your own hotkeys. The hotkey (Input  Description
  271.     String) string has the following template:
  272.  
  273.         [qualifier] [qualifier] [qua...] [highmap | ansi]
  274.  
  275.     NOTE: There is more possible with the Input  Description  String but  this
  276.           template makes the most sence for this aplication.
  277.  
  278.     qualifier: lshift, rshift, shift,  capslock, caps,  control,  lalt,  ralt,
  279.                alt,  lcommand,   rcommand,  numericpad,   repeat,   midbutton,
  280.                rbutton, leftbutton, relativemouse
  281.  
  282.     higmap   : comma, space, backspace, tab,  enter,  return,  esc,  del,  up,
  283.                down, right, left, help, f1..f10, 0..9, (, ), /, *, -, +
  284.  
  285.     ansi     : a single character which is translated using the system default
  286.                keymap.
  287.  
  288.   Requirements :
  289.  
  290.     View requires Kickstart 2.0 to run. Also a copy of the "nofrag.library" is
  291.     required to be in the LIBS: directory  of the  boot disk. If you also have
  292.     the  "powerpacker.library"  in the LIBS:  directory  View  is able to read
  293.     files crunched with PowerPacker. You will need the REGISTERED  version  of
  294.     DICE  to  recompile   the  source  code.   Also  you  need  to  make  link
  295.     libraries of the "powerpacker_lib.fd" and the "nofrag_lib.fd" files  using
  296.     "fdtolib". "fdtolib" comes with both the registered and  freeware versions
  297.     of DICE. When you use View to read  PowerPacker crunched  files make  sure
  298.     that you  have  set-up 'T:' as a  logical device. If  not try to  add  the
  299.     following two lines in your startup-sequence :
  300.  
  301.             MakeDir RAM:T
  302.             Assign T: RAM:T
  303.  
  304.   Credits
  305.  
  306.     Credits must go to Matthew Dillon for his wonderfull  DICE C compiler  and
  307.     his  DME editor and DMouse and...and...and..., Thanks Matt!   By the  way,
  308.     you should register to DICE because it's the best deal  you'll ever  make!
  309.     Credits  also  must  go  to  Nico François  for his  PowerPacker  and  his
  310.     powerpacker.library. You should order a copy of "PowerPacker professional"
  311.     And credit must go to Yves Perrenoud for finding the  ugly  "jump to  last
  312.     found string bug".
  313.  
  314.   TODO (perhaps...someday....when I feel like it.......)
  315.  
  316.     o  Making View automatically detach itself from the CLI. How about a auto-
  317.        detach "_main.c" Matthew ?
  318.  
  319.     o  Multiple texts. (Is this really necessary....(?))
  320.  
  321.     o  Background process loading/displaying.
  322.  
  323.     o  Why don't you give me some ideas.....
  324.  
  325.   Notes :
  326.  
  327.     View  does not fragment  memory because it  uses the  "nofrag.library"  to
  328.     allocate the memory for the text. All escape sequences  supported  by  the
  329.     console.device are supported by View. If the first  character on a line is
  330.     a  FormFeed  View  will  translate  it into F. The  repeating  of the keys
  331.     is  handled in  a way  that View  will never execute a function  more than
  332.     once after you have released the keys. View automatically adapts itself to
  333.     the standard screen  resolution and  system font. View always displays one
  334.     column less than there would actually fit on the screen.  This  is because
  335.     the console.device uses a cursor, which is invisible in View,  that forces
  336.     the display to scroll when it hits the bottom-right corner of  the screen.
  337.     You should use LEFT_AMIGA+M/N to switch screens because  View it's  screen
  338.     has  no depth gadget. When you are a  lucky owner  of an  68030  machine I
  339.     suggest  you use the CpuBlit program by  Eddy Carrol  which will  stop the
  340.     ugly flickering when multy coloured text is scrolled.
  341.  
  342.     View  makes  use of  the  "powerpacker.library" if available. This library
  343.     can be found on FISH 414 and is © Oct 1990 by Nico François.
  344.  
  345.   History :
  346.  
  347.     1.0               - Initial version. (let's see how it goes!)
  348.  
  349.     1.1               - The temporary  decrunched  file  did  not  get written
  350.                         to "T:". This has been fixed.
  351.  
  352.                         The Enforcer complained when View was started from the
  353.                         CLI or Workbench without any arguments. This  has been
  354.                         fixed.
  355.  
  356.                         View now has  a much improved  filename parser  which
  357.                         recognizes   and   parses   the   arguments  for  the
  358.                         ASL-FileRequester.
  359.  
  360.     1.2               - View now starts to look  for a string  from the  first
  361.                         line on the screen.  This  seems  to be  the  standard
  362.                         and it is less confusing.
  363.  
  364.                         View  now  offers the  possibility  to save  the  text
  365.                         blocks to a file.
  366.  
  367.     1.3               - View now supports ECS screen modes like SuperHires.
  368.  
  369.     1.4               - Filerequesters now include a  pattern  gadget.  (Don't
  370.                         you just love OS-2.....)
  371.  
  372.                         Added the possibility to save the whole text.
  373.  
  374.                         Added a little line editor. It can't do  very much but
  375.                         it's sufficient to fix errors in your text's.
  376.  
  377.     1.5               - Replaced  the   input-handler  by  a  "user-definable"
  378.                         commodity broker.
  379.  
  380.                         Removed the routine that controled the  repeat keys. I
  381.                         just read the intuition autodoc and guess what.. there
  382.                         is a tag that does the same thing!
  383.  
  384.                         Bug  fixed! --> 'jumping to last  found string'  when
  385.                         there wasn't any string  found  would  screw  up  the
  386.                         program trying to display data that does not exist.
  387.  
  388.     Bug reports, flames, constructive criticism (I hope I spelled this right),
  389.     PD programs, ideas to the following address :
  390.  
  391.                                        Jan van den Baard
  392.                                        Bakkerstraat 176
  393.                                        3082 HE, Rotterdam
  394.                                        Netherlands
  395.  
  396.                                        Fido 2:500/29 (Jan van.den.Baard)
  397.