home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / beehive / compress / ql40.arc / QL40.DOC < prev    next >
Text File  |  1991-08-11  |  13KB  |  306 lines
  1.  
  2.  
  3.  
  4.  
  5.                                  WHAT IS IT?
  6.  
  7.    QL  is one of the the most flexible and powerful file viewing  utilities
  8.    available for CP/M; it is not just another "typer".  It combines some of
  9.    the best features of the popular CP/M, ZCPR3, and MS-DOS  utilities LUX,
  10.    LT,  VLU, and LIST62 with its own unique features including hex  display
  11.    mode and a unique, fast access, file reference by number system.   Other
  12.    features include:
  13.  
  14.    o  Alphabetized  display  of all files in the current area;  "select  by
  15.       number" eliminates mistyped filenames.
  16.  
  17.    o  LBR support also features "select by number" for member names.
  18.  
  19.    o  Transparent decompression of squeezed and crunched files.
  20.  
  21.    o  Memory based design allows instant backwards or random access viewing
  22.  
  23.    o  Locate sections of interest quickly using string (or byte) search.
  24.  
  25.    o  Hex  display  mode allows inspection of non-ascii  files,  or  closer
  26.       inspection of 'ascii-ish' files.
  27.  
  28.    o  Optional extraction to disk of LBR member files, with decompression.
  29.  
  30.    o  Full  wheel  byte and BYE support allows program to be  securely  run
  31.       online in an RCP/M environment.
  32.  
  33.    o  Optional terminal attribute support greatly enhances display.
  34.  
  35.    o  ZCPR3 version eliminates terminal and other hardware dependencies.
  36.  
  37.    o  Instantly  configurable  /  customizable by anyone,  using  the  "Z1"
  38.       assembler (included), or your own favorite.
  39.  
  40.    o  If not satisfied, get rid of QL and keep the assembler as a gift.
  41.  
  42.  
  43.                                 QUICK USAGE
  44.  
  45.    1. Just type QL.
  46.  
  47.       A vertically oriented, alphabetized display off all filenames in  the
  48.       current drive/user will be displayed, with a number next to each one.
  49.  
  50.    2. Pick  a  number of a file you'd like to view.  If  it's  squeezed  or
  51.       crunched, it will be taken care of.  If it's a library file...
  52.  
  53.    [2b.]  ...you will be presented with a new screen with all  the  members
  54.       listed.   Again you get to pick a number.  (This is all  much  easier
  55.       than typing out the correct filename spelling).
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                               1
  62.  
  63.  
  64.  
  65.    3. Now you get to view the file, one screen at a time.  You can go  for-
  66.       ward or backward a page at a time, forward line by line, or  directly
  67.       to  a specific 'page' (ie screen) instantly.  The latter can be  done
  68.       by  just  typing a 'page' number, or by using the "Find"  command  to
  69.       scan for specific text.
  70.  
  71.    4. If  you  want,  type "?" for a new screen  summarizing  the  commands
  72.       available.  This screen also gives current settings of the  "toggles"
  73.       (which  may be changed) and a summary of the file- where it is,  it's
  74.       size in kilobytes and number of words and lines if appropriate.  Hit-
  75.       ting any key to returns you to viewing (right to the same spot).
  76.  
  77.    5. Typing  ^X (or ESC or Q) will always escape you back to the  previous
  78.       level.  For example, if appropriate, hitting ESC while viewing a file
  79.       will bring you back to the LBR membernames display.  Another ESC will
  80.       bring  you back to the original list of all filenames.  A  third  one
  81.       gets you back to CP/M.  Note that ^C (or ^K) will instantly bring you
  82.       directly back to CP/M from any point.
  83.  
  84.  
  85.                                   LIMITATION
  86.  
  87.    Due  to it's memory based design and its original intent to be a  'Quick
  88.    Look" utility, QL's main limitation is in the size of a file that can be
  89.    viewed  in it's entirety.  The program  will ACCEPT any size  file,  but
  90.    sections  of large files which are past the end of available memory  can
  91.    not be viewed.  See QL-OLD.DOC for more discussion on this.
  92.  
  93.    Note that Extract Mode, described below, does NOT have this limitation.
  94.  
  95.                                    NOTES
  96.  
  97.    1. The  original invocation of QL may contain a filename  specification,
  98.       ambiguous  or otherwise.  Thus "QL *.DOC" will limit the "on  screen"
  99.       selection display to only those files with the ".DOC" extension.   If
  100.       the file is fully specified, or if only one file matches, the  select
  101.       by  number process will be skipped, for obvious reasons.  Note  that,
  102.       like a filesweep utility,  just plain "QL" is equivalent to "QL *.*".
  103.       This makes QL very fast and easy to use.
  104.  
  105.    2. File Extraction (LBR files only).  At the "View a member:" prompt you
  106.       may enter "E", as indicated, which will put you in extract mode.  The
  107.       new prompt is "Extract a member:" and any members selected will auto-
  108.       matically  be extracted from the library to a disk file.   The  files
  109.       will be unsqueezed / uncrunched along the way, if appropriate.  Files
  110.       are written to the originally logged drive (indicated in the prompt),
  111.       even if the library resides on a different drive (eg if QL was  orig-
  112.       inally invoked
  113.  
  114.       "A> QL B:*.*"
  115.  
  116.       the  files will be written to the "A" drive.  The ZCPR  version  will
  117.       accept  a user number in the command line as well, and files will  be
  118.       written  to the originally logged drive and user.  QL will NOT  over-
  119.       write a pre-existing file without a prompt.
  120.  
  121.  
  122.                               2
  123.  
  124.  
  125.  
  126.  
  127.    3. If a library file is to be specified on the command line, you  should
  128.       NOT type the .LBR extension.  In this manner, QL will add the  exten-
  129.       sion and treat the file as a library, which is probably what you  ex-
  130.       pect.   If you DO fully specify the filename (no wildcards,  AND  the
  131.       extension  typed out), the file will be treated like a  miscellaneous
  132.       [binary] file.  The hex dump which will ensue will allow you to exam-
  133.       ine  the "guts" of the library's directory, if you are  so  inclined.
  134.       All other combinations (including anytime an LBR file is selected  by
  135.       number) will result in the file being opened as a library.
  136.  
  137.  
  138.                             COMMAND INFORMATION
  139.  
  140.    Following is a replica of a typical "help" screen, invoked by typing a
  141.    "?" while viewing a file.  More detail on some of the commands follows.
  142.     .....................................................................
  143.  
  144.      --- While viewing ---           --- Toggle Commands ---
  145.  
  146.    <cr>    Forward one page          A   Display ASCII / HEX:  ASCII
  147.    <sp>    Forward one line          T   Truncate long lines:    YES
  148.    <##>    Go to any page ##         C   Case sensitive find:     NO
  149.     B      Backward one page
  150.     F      Find text or hex byte
  151.     R      Repeat find
  152.     X      Exit viewing
  153.  
  154.      File: B10:QL      .DOC
  155.      Size: 2419 bytes (3k)
  156.    Approx: 53 lines, 396 words.
  157.  
  158.    Command, or <ret> to resume Viewing:
  159.  
  160.     .....................................................................
  161.  
  162.    Toggle commands:
  163.  
  164.    Currently  there are three 'toggle' functions (though more may be  added
  165.    in a subsequent release).  They are "Display Mode" (ASCII/HEX),  "Trunc-
  166.    ation" (ON/OFF), and "Case sensitive find" (ON/OFF).
  167.  
  168.    1. When  "Truncation"  is ON, lines longer than 80  characters  will  be
  169.       chopped off (a character in the last column identifies these  lines).
  170.       This  is the recommended mode of operation, as QL does not  currently
  171.       support left-right scrolling.  Furthermore, if the lines are  allowed
  172.       to wrap the 'pagination' will be not work correctly- lines may scroll
  173.       off your screen.  This area may be improved in a subsequent release.
  174.  
  175.    2. The "Case sensitive" toggle only involves the 'Find' function.   When
  176.       "OFF", no distinction is made between upper and lower case; otherwise
  177.       the match must be exact.
  178.  
  179.  
  180.  
  181.  
  182.  
  183.                               3
  184.  
  185.  
  186.  
  187.    3. "Display mode" is almost self explanatory; "ASCII" is the normal mode
  188.       for  viewing a text file.  The "HEX" mode display emulates a  typical
  189.       debugger  type  memory dump, with 16 hex bytes/line and  their  ascii
  190.       equivalents, if any,  on the right part of the screen.  QL will init-
  191.       ially  take an "educated guess" at the proper setting here  based  on
  192.       the content of the first few bytes, but it may be "faked out".  If  a
  193.       file comes up 'wrong', simply hit 'A' to alternate the display mode.
  194.  
  195.    Note: If  the toggles are activated while the help screen is  displayed,
  196.          the  value  will be flipped and the screen  will  be  redisplayed,
  197.          showing the new values.  The commands may also be executed direct-
  198.          ly,  right in the middle of viewing a file.  In this event a  word
  199.          or  two indicating the new mode is displayed briefly, and  viewing
  200.          may proceed immediately.
  201.  
  202.     ......
  203.  
  204.    "While viewing" commands:
  205.  
  206.    The  "While  viewing commands" shown in the left hand column  above  are
  207.    quite  self-explanatory.  Some "synonyms" (not shown) exist for some  of
  208.    the  commands, eg "Q", "X", "^X" or ESCape will all act  identically  as
  209.    "Exit".  A few extra details are supplied below.
  210.  
  211.    1. Just  typing 1 or 2 digits causes QL to jump directly to that  "page"
  212.       (ie "screen") number.
  213.  
  214.    2. The  "Find" command requires some clarification not indicated  above.
  215.       The  command results in the query "Find:", at which point  you  would
  216.       normally enter word(s) or a part of a word to scan for.  When  found,
  217.       the  corresponding page is displayed (with the occurrence(s)  of  the
  218.       string  higlighted if possible), and operation proceeds  from  there.
  219.       In HEX mode, it is possible to search for either ascii matches (right
  220.       hand  portion of display) or for a series of one or more  hex  bytes.
  221.       Using the latter mode requires that the hex bytes be preceded by  the
  222.       character "$".  If multiple bytes are being specified, do not use any
  223.       commas  or spaces between them.  For example,  to find the series  of
  224.       bytes 11H, 76H, 0ACH, you would respond to "Find:" by entering:
  225.  
  226.       $1176AC
  227.     .....
  228.    Memory dump:
  229.  
  230.    Not shown above is the memory dump option, which can be initiated  early
  231.    in  the program (at the first 'select by number' prompt).  You will  no-
  232.    tice that that prompt is worded:
  233.  
  234.    Select file #, <M>emory dump, or <ret> to exit:
  235.  
  236.    Entering  "M"  here will display the current system memory.   In  memory
  237.    dump mode, the addresses shown are the actual addresses.  When a file is
  238.    displayed  in HEX mode, the addresses are correct for a file  loaded  at
  239.    100H, as is normally the case.  Most commands are available during  Mem-
  240.    ory  dump, although some, notably switching to ascii, make little  sense
  241.    and will produce strange displays.
  242.  
  243.  
  244.                               4
  245.  
  246.  
  247.  
  248.  
  249.                          INSTALLATION / CUSTOMIZATION
  250.  
  251.    While  QL  will run right  'out of the box', it is worth the  extra  few
  252.    minutes  to  read the file QL-CFG.DOC.  Most people need only  read  the
  253.    first  paragraph  or two, and can then perform the "installation"  in  a
  254.    matter of minutes.
  255.  
  256.  
  257.                                  RCP/M USAGE
  258.  
  259.    Simply  set  your  wheel address where indicated in  the  QL40.AZM  file
  260.    (ZCPR3 users need not bother) , and QL will instantly become a very  vi-
  261.    able online utility.  This gives users new flexibilities: to examine HEX
  262.    files online; to go backwards when one types 'too far'; and to save time
  263.    by  using the FIND command to skip right to a section of interest  in  a
  264.    textfile.  Plus no more annoying typographical errors of filenames.
  265.  
  266.    QL will sense the presence of BYE, and not send video specific sequences
  267.    to remote terminals.  The wheel byte is used to provide security by  not
  268.    allowing  hex  displays of files with .COM extension or a  dump  of  the
  269.    system's memory.  Files with the SYS attribute are ignored as well.  Ob-
  270.    viously the LBR file extract mode is deactivated.  Any 'menu' references
  271.    to  deactivated  functions are eliminated from display.  Note  that  the
  272.    WHEEL and BYE checks are independent- SYSOPS may remotely examine system
  273.    memory, etc.
  274.  
  275.  
  276.                                                      - Steven Greenberg
  277.                                                        14  August  1988
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.                               5
  306.