home *** CD-ROM | disk | FTP | other *** search
/ Amiga GigaPD 3 / Amiga_GigaPD_v3_3of3.iso / fred_fish / fish_601-700_lha / fish_658.lha / VIEW / View.DOC < prev    next >
Text File  |  1993-06-02  |  22KB  |  468 lines

  1.  
  2.                            - View version 2.0 -
  3.  
  4.                   ---------------------------------------- 
  5.                   - ⌐ Copyright 1991-92 Jaba Development - 
  6.                   -        written using DICE C by       - 
  7.                   -           Jan van den Baard          - 
  8.                   ---------------------------------------- 
  9.  
  10.                This program uses both the powerpacker.library
  11.                    and reqtools.library  (OS 2.0 version)
  12.             These two libraries are  (c) Copyright Nico Franτois
  13.           and the full distribution can be found on Fish Disk 575.
  14.                                      __  __        
  15.                                     / / /  \       
  16.                              __    / / / /\ \      
  17.                         _____\ \__/ /_/ /_/ /_____ 
  18.                        (__________________________)
  19.                                                    
  20.  
  21.  
  22.   DISCLAIMER
  23.   ----------------------------------------------------------------------------
  24.   The author is not responsible for any damage caused by the use  or misuse of
  25.   this documentation and/or the program(s) it describes.  Any damage resulting
  26.   from the  use or misuse  of this  documentation  and/or  the  program(s)  it
  27.   describes is the sole responsibility of the user her/him self.
  28.   ----------------------------------------------------------------------------
  29.  
  30.   COPYRIGHT
  31.   ----------------------------------------------------------------------------
  32.   View,  ⌐  Copyright  1991-92  Jaba Development.   All rights reserved.  This
  33.   program may  be  distributed   non-commercially providing  that  the  source
  34.   code, documentation, copyright notices and executable remain  unchanged  and
  35.   are included in the distribution. Also no more than a !NOMINAL! copy fee may
  36.   be charged for the distribution. This  program is FREEWARE  so no  financial
  37.   donations are required ( The only thing I would like is a postcard from your
  38.   home town!). Any form of commercial usage is not allowed  without my written
  39.   permission.
  40.   ----------------------------------------------------------------------------
  41.  
  42.   I have again re-written the biggest part of View. This was really  necessary
  43.   because it did not make use of 2.04 as much as it could. Also the  source of
  44.   View wasn't exactly modular and easy to  read.   Therefore I have re-written
  45.   most parts. I think it looks much better now and it's easier to  read.  View
  46.   is still MORE compatible.
  47.  
  48.  
  49.   View KeyMap commands :
  50.  
  51.     Space,Pg Dn ->
  52.  
  53.       This will go down one page of text (MORE).  If there are not  enough
  54.       lines left  in  the text  to fill  the  screen this function will go
  55.       down 'x' amount of lines until the last line is displayed.
  56.  
  57.     Backspace,Pg Up ->
  58.  
  59.       This  will go up  one page of text (LESS).  If there are not  enough
  60.       lines left  in  the text  to fill  the  screen this function will go
  61.       up 'x' amount of lines until the first line is displayed.
  62.  
  63.     Return,Dn,Nk Dn ->
  64.  
  65.       This will scroll the text up one line and display  the next  line of
  66.       text at the bottom of the screen.
  67.  
  68.     Enter,Up,Nk Up ->
  69.  
  70.       This will scroll the text down one line and display the next line of
  71.       text at the top of the screen.
  72.  
  73.     <,Nk Left ->
  74.  
  75.       This will display the first page of the text.
  76.  
  77.     >,Nk Right ->
  78.  
  79.       This will display the last page of the text.
  80.  
  81.     /,F ->
  82.  
  83.       This opens a little window in which  a string gadget is located.  In
  84.       this string  gadget you can type  a word or a  sentence you  want to
  85.       locate in the text.  Once you are done you should press  return  and
  86.       the  program  starts  to look  from the first line on the screen for
  87.       the specified string. If the  program finds the  string in  the text
  88.       it will be displayed inverse. The search is case  sensitive.   Note:
  89.       The found string will keep on being displayed highlighted  even when
  90.       you scroll the string of the screen and back on the screen again.
  91.  
  92.     N/P ->
  93.  
  94.       This  will  look for the Next/Previous  occurrence  of the word last
  95.       found. The search will  begin from the  point where the program  had
  96.       found the string  the last  time you  have called one of the  search
  97.       routines. The search is case sensitive.
  98.  
  99.     .,S ->
  100.  
  101.       This does the same thing as /,F with the  exception that the  search
  102.       will be case insensitive.
  103.  
  104.     CTRL+N/CTRL+P ->
  105.  
  106.       This does the same thing as N/P with the  exception that the  search
  107.       will be case insensitive
  108.  
  109.     CTRL+L,R ->
  110.  
  111.       This will redisplay the text on the screen in the  (unlikely) event
  112.       that the display has been damaged for one or the other reason. This
  113.       has been featured to keep it all compatible to MORE.
  114.  
  115.     % ->
  116.  
  117.       This opens a  little window  with an integer  gadget in it.  In this
  118.       integer gadget you can type the  percentage (0 to 100)  of the  file
  119.       you want to jump to.
  120.  
  121.     E ->
  122.  
  123.       For  this to  work you  must use  SetEnv  to set-up  an  environment
  124.       variable called EDITOR. For example, if you normally use dme as your
  125.       editor and this  editor is  located in the C:  directory you  should
  126.       type the following in the shell:  SetEnv  EDITOR=Dme.   The  routine
  127.       checks the shell it's path list to find  the  editor so you  do  not
  128.       have to type  the  full  pathname if  the  editor is  located  in  a
  129.       directory which is in the path list. If the  environment  is  set up
  130.       correctly the program will run the editor with  the  file  currently
  131.       in  memory.  NOTE: This option is only available  when View has been
  132.       started from the shell! This option  is not  available at all in the
  133.       auto-detach version of View!
  134.  
  135.     L ->
  136.  
  137.       This opens the  ReqTools  FileRequester  for  you to  select  a file
  138.       you  want to read. When you are done select Load and,  if everything
  139.       went OK, after the  loading is  done  the  first  page  of  the file
  140.       you  have selected is displayed.
  141.  
  142.     J ->
  143.  
  144.       This is a feature not found in many of the other ASCII file viewers.
  145.       This will jump to the position where the program has found  a string
  146.       the last  time  one  of the  search  routines where  called.  It's a
  147.       feature I use a lot.
  148.  
  149.     B ->
  150.  
  151.       This puts View to sleep.  The  program closes the  screen and  waits
  152.       until the user call's view by  pressing a hotkey.  See below for the
  153.       hotkeys. The text in memory will be lost.
  154.  
  155.     CTRL+B ->
  156.  
  157.       This does the same thing as B with the exception that the text  will
  158.       stay in  memory  and will be  available  when View  is signalled  to
  159.       wake-up again.
  160.  
  161.     LSHIFT+CTRL+D ->
  162.  
  163.       This will dump the page currently on the  screen to the  printer. It
  164.       uses the printer.device so make sure that it's set correctly.  While
  165.       the printing is in progress a little window is in  the screen's  top
  166.       left corner. Closing this window will  abort the printing.  Once you
  167.       have stopped the printing the printer  goes on until it's  buffer is
  168.       empty. You can continue  reading the file while  the printing  is in
  169.       progress. It is not possible to put View to sleep, quit or to load a
  170.       new file while the printing is in progress.
  171.  
  172.     LSHIFT+CTRL+P ->
  173.  
  174.       This will dump the complete text in memory to the printer. The  same
  175.       window as with LSHIFT+CTRL+D pops up to enable you to stop printing.
  176.  
  177.     H,HELP ->
  178.  
  179.       This puts some information about the author and  the available  key-
  180.       commands possible with this program.
  181.  
  182.     Q,CTRL+C,ESC,Nk 5 ->
  183.  
  184.       This is a nasty one. Pressing any of these keys will quit View.
  185.  
  186.     Fn ->
  187.  
  188.       This enables you to mark blocks in the  text in memory.  This  block
  189.       marking goes in two fases. The first time you press  'F1' the  first
  190.       line on the screen will be the first line of text block #1. When you
  191.       press 'F1' again the last line on the screen will  be the last  line
  192.       of text block #1. Only when you have marked the first  and the  last
  193.       line of a text block the block will be marked. It's possible to mark
  194.       10 blocks in a text (F1..F10).
  195.  
  196.     SHIFT+Fn ->
  197.  
  198.       This will unmark text block #n making it free to  mark another  text
  199.       block.
  200.  
  201.     CTRL+Fn ->
  202.  
  203.       This will jump to the first line of text block #nm.
  204.  
  205.     LSHIFT+CTRL+Fn ->
  206.  
  207.       This will dump text block #n to the printer.  The printing window is
  208.       opened to enable you to stop the printing. You can continue to  read
  209.       the file while the printing is in progress.
  210.  
  211.     LALT+Fn ->
  212.  
  213.       This will open the ReqTools FileRequester in which  you can select a
  214.       name under which you can save text block #n.
  215.  
  216.     CTRL+S ->
  217.  
  218.       This will open the ReqTools FileRequester  in which tou can select a
  219.       name under which you can save the whole text.   Please note that all
  220.       tabs in the file are written as spaces.
  221.  
  222.     M ->
  223.  
  224.       This will toggle the mouse pointer. Sometimes it's better to  switch
  225.       the mouse pointer off so that it  won't get in  your way.  The mouse
  226.       will switch on again when a requester pops up on the screen. Also it
  227.       will always show when the program is reading a  powerpacker crunched
  228.       file. This because you might load a crypted file  which puts  up the
  229.       requester for the password.
  230.  
  231.     C ->
  232.  
  233.       This will toggle the scroll mode. When the scroll mode is activated
  234.       the display will scroll to the next/previous page  when a PageUp or
  235.       or PageDown key is pressed.  When it isn't  activated  the  program
  236.       will display the next/previous page immediatly.
  237.  
  238.   When View is sleeping :
  239.  
  240.       There are three "user-configurable" hotkeys  which will  signal View
  241.       to do something.  These  hotkeys can  be set  by  passing  a hotkey-
  242.       string (See below ) as an argument to view.
  243.  
  244.       The following functions can be called with the use of hotkeys  while
  245.       view is asleep.
  246.  
  247.            QUIT   will quit View while it is asleep.
  248.            VIEW   will pop  up  the  main  screen  and  display  the  text
  249.                   if  remembered  or   otherwise   put  up   the  ReqTools
  250.                   FileRequester for you to load a file.   When   the  View
  251.                   screen is open but not  the  frontmost  screen  it  will
  252.                   pop the screen  to the front.
  253.            FLUSH  will erase the text, if remembered,  from memory.
  254.  
  255.   Ascii Check : 
  256.  
  257.     View uses a very simple routine that checks the first 100 (or less)  bytes
  258.     of the file you wish to load. The following character codes are  marked as
  259.     illegal (values are hexadecimal):
  260.  
  261.         From $01 to $08.
  262.         From $0E to $1A.
  263.         From $1C to $1F.
  264.         From $80 to $9A.
  265.  
  266.     When view encounters one of these values in the first 100 (or less)  bytes
  267.     of the file the file wont be loaded.
  268.  
  269.   Starting View : 
  270.  
  271.     You can start View from  either the  CLI/Shell  or the Workbench. To start
  272.     View from the CLI/Shell you can type :
  273.  
  274.         Run View [Name] [CX_PRIORITY=<pri>] [CX_POPUP=<YES|NO>] [VIEW=<hotkey>]
  275.                  [FLUSH=<hotkey>] [QUIT=<hotkey>]  [LACE] [SUPER]  [A2024TENHZ]
  276.                  [A2024FIFTEENHZ] [PRODUCTIVITY] [NOPOINTER] [TABS=<size>]
  277.  
  278.                  CX_PRIORITY/K/N, CX_POPUP/K, VIEW/K, FLUSH/K, QUIT/K,  LACE/S,
  279.                  SUPER/S,   A2024TENHZ/S,   A2024FIFTEENHZ/S,   PRODUCTIVITY/S,
  280.                  NOPOINTER/S,TABS/K/N
  281.  
  282.         With:   Name           : An optional name of the file you want to read
  283.                                  or  a  pathname  in   which   you   want  the
  284.                                  FileRequester to start looking for files.
  285.  
  286.                 CX_PRIORITY    : With this argument you can specify the broker
  287.                                  priority in the commodities queue.
  288.                                  Default : 0
  289.  
  290.                 CX_POPUP       : This enables you  to enable/disable View from
  291.                                  opening it's window when it is started.
  292.                                  Default : YES
  293.  
  294.                 VIEW           : With this  argument  you  can  set  your  own
  295.                                  specific hotkey to let View open it's window.
  296.                                  Default : lalt lcommand v
  297.  
  298.                 FLUSH          : With this  argument  you  can  set  your  own
  299.                                  specific hotkey to let View  flush  it's text
  300.                                  buffer.
  301.                                  Default : lalt lcommand f
  302.  
  303.                 QUIT           : With this  argument  you  can  set  your  own
  304.                                  specific  hotkey  to  quit  View  while  it's
  305.                                  asleep.
  306.                                  Default : lalt lcommand q
  307.  
  308.                 LACE           : When  this  argument  is  specified  View  is
  309.                                  forced to open an interlaced screen.
  310.  
  311.                 SUPER          : When  this  argument  is  specified  View  is
  312.                                  forced to open a superhires screen. When this
  313.                                  mode  is  not  available  the standard screen
  314.                                  resolution  is used.
  315.  
  316.                 A2024TENHZ     : When  this  argument  is  specified  View  is
  317.                                  forced to open a a2024 ten hertz screen. When
  318.                                  this  mode  is  not  available  the  standard
  319.                                  screen  resolution is used.
  320.  
  321.                 A2024FIFTEENHZ : When  this  argument  is  specified  View  is
  322.                                  forced to open a a2024 fifteen hertz  screen.
  323.                                  When this mode is not available  the standard
  324.                                  screen resolution  is used.
  325.  
  326.                 PRODUCTIVITY   : When  this  argument  is  specified  View  is
  327.                                  forced to open a  productivity  screen.  When
  328.                                  this  mode  is  not  available  the  standard
  329.                                  screen  resolution is used.
  330.  
  331.                 NOPOINTER      : When  you  specify  this  argument the  mouse
  332.                                  pointer will not be shown.
  333.  
  334.                 SCROLL         : When this argument is specified  the  display
  335.                                  will scroll each  time a  PageUp  or PageDown
  336.                                  key is selected.
  337.  
  338.                 TABS           : With this argument you can  set  the  size of
  339.                                  a tab-jump that View should use.  This cannot
  340.                                  be smaller than 2 or bigger than 16.
  341.                                  Default : 8
  342.  
  343.     NOTE: You don't have to Run or RunBack the  auto-detach  version of  view.
  344.  
  345.     You can specify the  last 13  arguments  through  the  ToolTypes array  of
  346.     the program  it's  icon  for  the  Workbench.  When  you  start  View from
  347.     the WBStartup startup drawer you must set the DONOTWAIT tooltype  also.
  348.  
  349.   HotKey Strings :
  350.  
  351.     With view you can specify your own hotkeys. The hotkey (Input  Description
  352.     String) string has the following template:
  353.  
  354.         [qualifier] [qualifier] [qua...] [highmap | ansi]
  355.  
  356.     NOTE: There is more possible with the Input  Description  String but  this
  357.           template makes the most sence for this aplication.
  358.  
  359.     qualifier: lshift, rshift, shift,  capslock, caps,  control,  lalt,  ralt,
  360.                alt,  lcommand,   rcommand,  numericpad,   repeat,   midbutton,
  361.                rbutton, leftbutton, relativemouse
  362.  
  363.     higmap   : comma, space, backspace, tab,  enter,  return,  esc,  del,  up,
  364.                down, right, left, help, f1..f10, 0..9, (, ), /, *, -, +
  365.  
  366.     ansi     : a single character which is translated using the system default
  367.                keymap.
  368.  
  369.   Requirements :
  370.  
  371.     View requires Kickstart 2.0 to run. Also a copy of the "nofrag.library" is
  372.     required to be in the LIBS: directory  of the  boot disk. If you also have
  373.     the  "powerpacker.library"  in the LIBS:  directory  View  is able to read
  374.     files crunched with PowerPacker.  Also the "reqtools.library" is  required
  375.     to be in your LIBS:. As of version 2.0 View uses the requesters from  that
  376.     that library. You will need the REGISTERED  version  of DICE  to recompile
  377.     the source code. When you use View to read PowerPacker crunched files make
  378.     sure that you have set-up 'T:' as a logical device.  If not try to add the
  379.     following two lines in your startup-sequence :
  380.  
  381.             MakeDir RAM:T
  382.             Assign T: RAM:T
  383.  
  384.   Credits
  385.  
  386.     Credits must go to Matthew Dillon for his wonderfull  DICE C compiler  and
  387.     his  DME editor and DMouse and...and...and..., Thanks Matt!   By the  way,
  388.     you should register to DICE because it's the best deal  you'll ever  make!
  389.     Credits  also  must  go  to  Nico Franτois  for his  PowerPacker  and  his
  390.     powerpacker.library &  reqtools.library.    You  should  order a  copy  of
  391.     "PowerPacker  professional".  And  credit  must  go  to Yves Perrenoud for
  392.     finding  the  ugly  "jump  to  last  found string" bug.  Thanks to Richard
  393.     Hartmann for finding  a bug  in the "Edit file" routine.
  394.  
  395.   Notes :
  396.  
  397.     View  does not fragment  memory because it  uses the  "nofrag.library"  to
  398.     allocate the memory for the text. All escape sequences  supported  by  the
  399.     console.device are supported by View. If the first  character on a line is
  400.     a  FormFeed  View  will  translate  it into F. The  repeating  of the keys
  401.     is  handled in  a way  that View  will never execute a function  more than
  402.     once after you have released the keys. View automatically adapts itself to
  403.     the standard screen  resolution, unless you specified another  resolution,
  404.     and  system font. You  should use LEFT_AMIGA+M/N to switch screens because
  405.     View it's  screen has  no  depth gadget. When you are a lucky owner  of an
  406.     68030 machine I suggest  you use the CpuBlit program  by Eddy Carrol which
  407.     will stop the ugly flickering when multy coloured text is scrolled.   From
  408.     version 1.6 on  up   this program  will come  in two  versions.   A normal
  409.     version  which  has the 'jump to editor'  feature  in  the  shell  and  an
  410.     auto-detach version  that will detach  itself from the shell automatically
  411.     which does not support  the  'jump to editor' feature.
  412.  
  413.   History :
  414.  
  415.     2.0               - Totally re-written the earlier versions......
  416.                         The following additions have been  made since
  417.                         the last official release (v1.5):
  418.  
  419.                         Now View  only reads ascii files.   All other
  420.                         files are simply ignored.
  421.  
  422.                         The  Editor option only works when  View  has
  423.                         been started  from the shell.  ViewD does not
  424.                         support this at all.
  425.  
  426.                         Added  the  posibility  to  let  view  open a
  427.                         screen in a preferred screen mode.
  428.  
  429.                         Added   the  possibility  to  switch  off the
  430.                         mouse pointer.
  431.  
  432.                         Added   the  possibility  to  switch  between
  433.                         "scrolling" the  page  or  just displaying it
  434.                         when  one of  the  Page   Up/Down   keys   is
  435.                         pressed.
  436.  
  437.                         Added the possibility to  set  the  preffered
  438.                         size of a tab-jump View must use.
  439.  
  440.                         Now View needs  the  reqtools.library.   This
  441.                         library  provides  _MUCH_  better  requesters
  442.                         than ASL does.
  443.  
  444.                         A lot of minor bugs fixed.    The  source has
  445.                         been  totally  re-arranged to  make it  a lot
  446.                         easier to read.
  447.  
  448.                         I have removed the small line editor  because
  449.                         it really didn't  have  anything  to do  with
  450.                         the program plus that it was to limited to do
  451.                         anything usefull with.
  452.  
  453.                         View is now  distributed  together  with  the
  454.                         powerpacker and reqtools  libraries.   Also a
  455.                         new version of the  nofrag.library (v2.2)  is
  456.                         distributed with View. This new version has a
  457.                         few bugs fixed and some mungwall hits removed
  458.  
  459.     Bug reports, flames, constructive criticism (I hope I spelled this right),
  460.     PD programs, ideas to the following address :
  461.  
  462.                                        Jan van den Baard
  463.                                        Bakkerstraat 176
  464.                                        3082 HE, Rotterdam
  465.                                        The Netherlands
  466.  
  467.                                        Fido 2:500/29 (Jan van.den.Baard)
  468.