home *** CD-ROM | disk | FTP | other *** search
/ Zodiac Super OZ / MEDIADEPOT.ISO / FILES / 03 / ZSV_101.ZIP / ZSVIEW.DOC < prev    next >
Text File  |  1996-05-14  |  22KB  |  721 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                                  
  18.  
  19.  
  20.                  ZSView - A viewer for ALLFILE.DIR
  21.                            
  22.                            
  23.                            
  24.                            
  25.                            
  26.                            
  27.                            
  28.                            
  29.                            
  30.                            
  31.                            
  32.                            
  33.                            
  34.                            
  35.                            
  36.                            
  37.                            
  38.                            
  39.                            
  40.                            
  41.                            
  42.                            
  43.                            
  44.                            
  45.                            
  46.                            
  47.                            
  48.                            
  49.                            
  50.                            
  51.                            
  52.                            
  53.                            
  54.                            
  55.                            
  56.                            
  57.                            
  58.                            (C) 1996   End Users, Inc.
  59.  
  60.                                                                           
  61.  
  62.  
  63.                            Table of Contents
  64.  
  65.      Overview.................................................... 2
  66.      Before you begin............................................ 3
  67.      ZSView...................................................... 4
  68.      Usage....................................................... 4
  69.      Options..................................................... 4
  70.      Main Index.................................................. 5
  71.      File Viewing................................................ 6
  72.      Sort Menu................................................... 6
  73.      Save........................................................ 7
  74.      Files Needed / Files Deleted................................ 8
  75.      Error Messages.............................................. 9
  76.      Additional Notes............................................10
  77.      Speed.......................................................10
  78.      Disclaimer..................................................10
  79.      Revision History............................................11
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                                    - 1 -                         ZSView.DOC
  121.  
  122.  
  123.      Overview:   
  124.          
  125.          ZSView is a dedicated viewer for the file listings contained in
  126.      ALLFILE.DIR.  ZSView will also handle the individual directories in
  127.      ALLFILES.ZIP as a whole, as if they were all contained in ALLFILE.DIR,
  128.      creating an index for all 97 directories.  ZSView will handle any 
  129.      individual directory up to about 2 Meg.
  130.          
  131.          ZSView can also sort the file listings in a directory by Name,
  132.      Date or Size.  And ZSView can handle the multiline file descriptions 
  133.      up to 50 lines per listing.
  134.  
  135.          ZSView is written in QB 4.0, so it will run on an XT (although 
  136.      the sorting routines may be quite slooow on large directories).
  137.          
  138.          Also included in the package is PRETREAT.  This program is 
  139.      run once before using either ZSView or ZS.  PRETREAT corrects
  140.      problems in ALLFILE.DIR or the file directories which would cause
  141.      trouble for the search and sort routines in ZSView or ZS.
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.                                    - 2 -                         ZSView.DOC
  181.  
  182.  
  183.      Before you begin:
  184.          If this is the first time you are running ZSView (or ZS)
  185.      then you must run PRETREAT.EXE before you run ZSView (or ZS).
  186.          PRETREAT corrects four problems in ALLFILE.DIR or the file
  187.      directories by use of these three options:
  188.  
  189.              PRETREAT   T X F
  190.  
  191.              Options:  T -  Tabs are converted to 7 spaces. (Although in
  192.                             the latest ALLFILE.DIR {4-2-96} there were
  193.                             no tabs used.)
  194.  
  195.                        X -  Useless lines with "@X80" contaminating the 
  196.                             filename area are removed.
  197.                             Simultaneously, any lines longer than 80
  198.                             characters are shortened to contain only
  199.                             the first 80.
  200.                             
  201.                        F -  That portion of the DIR98 listing in 
  202.                             ALLFILE.DIR (between the two 
  203.                             =================== lines) which doesn't obey
  204.                             the rule whereby multiline descriptions are 
  205.                             marked off with a vertical bar, "|", is
  206.                             changed to comply.  (This is not necessary 
  207.                             for the files in ALLFILES.ZIP -- no DIR98!.)
  208.                             The few blank lines left and the two 
  209.                             =================== lines cause an 
  210.                             inconsequential problem when the file is 
  211.                             sorted:  they all appear at the top or bottom
  212.                             depending upon the type of sort done.
  213.  
  214.          The options for PRETREAT may be run together or individually
  215.      as circumstances dictate.
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                                    - 3 -                         ZSView.DOC
  241.  
  242.  
  243.      ZSView:
  244.         
  245.          ZSView is written in QB 4.0 and runs in glorious 16 color 80 x 25 
  246.      text mode.  ZS can be either in the directory with the files being 
  247.      searched or on the path.
  248.  
  249.         
  250.         
  251.         
  252.      Usage:                         
  253.      
  254.          ZSView 
  255.      
  256.      That's it!  No options are needed.  ZSView will scan the current
  257.      directory to determine which set of directories is being viewed.
  258.      ZSView first looks for a file called ALLFILE.DIR.  When that's found,
  259.      ZSView then looks for the associated index file, ALLFILE.IDX.  If
  260.      this is the first time you're running ZSView (or if you've had to
  261.      delete the index previously) then an index file will be created.
  262.      Once that's done without error, you'll be placed into the Main Index,
  263.      the table of contents for ALLFILE.DIR.
  264.          If the hard drive directory you're in doesn't contain ALLFILE.DIR,
  265.      then ZSView will look for a file called DIR01.  If found, ZSView
  266.      assumes you are viewing the individual directories and then looks for
  267.      the associated index file ALLFILES.IDX.  If the index file isn't
  268.      found, ZSView will create it and then launch you into the Main Index.
  269.          If neither ALLFILE.DIR or DIR01 is found, you will be dumped back
  270.      to the DOS prompt with an error message about not being able to find
  271.      any files to view.  If you were trying to view the individual 
  272.      directories contained in ALLFILES.ZIP and were simply missing DIR01, 
  273.      then after you restore DIR01 you should delete ALLFILES.IDX and rerun
  274.      ZSView to recreate a new index.
  275.  
  276.  
  277.  
  278.  
  279.      Options:
  280.  
  281.          Actually, there is an option you can use.  If you wish ZSView to
  282.      start up in a specific directory, then include that number on the
  283.      command line:
  284.  
  285.          ZSView ##
  286.  
  287.      and ZSView will launch you into that directory for immediate viewing.
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.                                    - 4 -                         ZSView.DOC
  301.  
  302.  
  303.      Main Index:
  304.  
  305.           When ZSView begins (assuming the IDX file exists) it will place
  306.      you into the Main Index.  This is a table of contents for the
  307.      directories contained in ALLFILE.DIR or the individual directories
  308.      originally packed in ALLFILES.ZIP.
  309.  
  310.          A reverse video highlight bar will tell you which directory is
  311.      currently under consideration.  Hitting "Enter" will allow you to 
  312.      view the contents of that directory.
  313.          For other directories use the cursor keys to move about the Index.
  314.      You may call up a help menu for that by hitting "F1."
  315.  
  316.          If you find a blank line nestled between two directory names,
  317.      this indicates a faulty ALLFILE.DIR or a missing directory, DIR##,
  318.      in the hard drive directory where you unzipped ALLFILES.ZIP.  Should
  319.      you retrieve the missing directory or find an unblemished copy of
  320.      ALLFILE.DIR, delete the IDX file and let ZSView create a new one.
  321.  
  322.  
  323.  
  324.  
  325.  
  326.          There is a Find function for the Index which is activated by
  327.      hitting the "F" key ("F" for  "FIND").  You may look for a single-
  328.      line word or phrase up to 40 characters long.  If found, it will be
  329.      highlighted in yellow on red as well as having the directory
  330.      highlight bar move to that line.
  331.          You may repeat the Find forwards or backwards by hitting "F3" or
  332.      "F4", respectively.
  333.          
  334.          Just entering "F" and then exiting without entering a word to
  335.      find will clear the Find buffer and inactivate the "F3" and "F4" keys
  336.      until the next time a Find word is chosen.
  337.  
  338.          You exit ZSView by hitting the "Esc" key from the Main Index.
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                                    - 5 -                         ZSView.DOC
  361.  
  362.  
  363.      File Viewing:
  364.  
  365.          Hitting "Enter" from the Main Index will call up the directory
  366.      being highlighted at the cursor bar.  Movement about this file is 
  367.      similar to the Index with the exception that the "Home" and "End"
  368.      keys actually move you to the top and last full line of the file,
  369.      respectively.
  370.  
  371.          To help remind you, a help menu can be summoned by hitting the
  372.      "F1" key, as in the Main Index.
  373.  
  374.          Keys:                                                               
  375.          Up      - Move one line up                                         
  376.          Down    - Move one line down                                       
  377.          Pg Up   - Move one page up                                         
  378.          Pg Dn   - Move one page down                                       
  379.          Home    - Move to first line                                       
  380.          End     - Move to last full page                                   
  381.          F1      - Call this help message                                   
  382.          F3      - Repeat last Find in forward direction                    
  383.          F4      - Repeat last Find in backward direction                   
  384.          F       - Enter a phrase to Find (Limit 40 characters)             
  385.          ESC     - Quit File Viewing / Return to Main Index
  386.          Enter   - Quit File Viewing / Return to Main Index
  387.  
  388.  
  389.          The "FIND" function in File Viewing works the same way as it does
  390.      in the Main Index.
  391.  
  392.          To return to the Main Index hit either "Enter" again or "Esc."
  393.  
  394.          The Line number in the lower right corner refers to the top line.
  395.  
  396.  
  397.  
  398.  
  399.      Sort Menu:
  400.  
  401.          While in File Viewing, hitting "S" will call up the Sort menu bar
  402.      along the bottom row of the screen.  Your choices are to sort by 
  403.      (N)ame, (D)ate or (S)ize by hitting the indicated letter:
  404.  
  405.          N - Sort the file by Filename in alphabetical order (A-Z)
  406.  
  407.          D - Sort the file by Date in reverse order (Newest on top).
  408.              Within the same date, Sort is by Filename in A-Z order.
  409.  
  410.          S - Sort the file by file Size in reverse order (Largest file
  411.              on top).  For files of the same size, Sort is by Filename
  412.              in A-Z order.
  413.  
  414.  
  415.      
  416.  
  417.  
  418.  
  419.  
  420.                                    - 6 -                         ZSView.DOC
  421.  
  422.  
  423.      Save:
  424.  
  425.          You may save the file you are currently viewing by hitting "V" as
  426.      indicated on the bottom bar of the File Viewing screen.  You may do 
  427.      this before or after a sort has been performed.
  428.  
  429.          Based upon the sort action taken prior to hitting Save, ZSView
  430.      will choose an extension for the filename of the file to be saved.
  431.      As an example, if you were viewing DIR23 (in either ALLFILE.DIR or 
  432.      the directory itself unzipped from ALLFILES.ZIP) and had performed a
  433.      Name sort on the file, then, when you chose to save the results of
  434.      that sort, ZSView would automatically use the name DIR23.NAM for it.
  435.      (Similarly, a Date sort would use ".DAT" and a Size sort would use
  436.      ".SIZ" for the filename extension.)
  437.  
  438.           If the filename already existed, then an error message would
  439.      appear on screen and ask for a decision:
  440.  
  441.              O - Overwrite the file
  442.  
  443.              U - Use a different name of the type "SAVED.#" where # is a
  444.                  number from 1 to 999
  445.  
  446.              C - Cancel the Save and return to File Viewing
  447.  
  448.          Of course, if the file had not been sorted yet, then saving it
  449.      would mean trying to save it with no extension.  If the directory was
  450.      from ALLFILES.ZIP then the error message would appear, otherwise it
  451.      will be saved as is.  Files are saved with the original 9-line header.
  452.          If a name can't be found for the file (generally only if Saved.1
  453.      thru Saved.999 already exist in the working directory), an error 
  454.      message will appear advising you of that fact, the name currently
  455.      being used, and then you will be returned to the DOS prompt as the
  456.      program ends right there. However, the file will have been saved with
  457.      a name of the type "Temp_#" or "Temp_#.#", where # is a number from
  458.      1 to 999.
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.                                    - 7 -                         ZSView.DOC
  481.  
  482.  
  483.      Files Needed / Files Deleted:
  484.  
  485.          During its normal operation, ZSView needs to create several
  486.      temporary files.  They have the general filename "Temp_#", where
  487.      # is a number from 1 to 999.  Also files called "Temp_#.#" may be
  488.      created.  ZSView checks to see if such files exist and will not
  489.      overwrite them unless they are zero byte files. When ZSView exits
  490.      smoothly, those files should be deleted.  None of those files need
  491.      be present when ZSView starts up.  You may delete them if they appear
  492.      after a normal exit from ZSView.  (An abnormal exit, such as a reboot
  493.      might well leave behind those temporary files.  You may delete them.)
  494.         
  495.          NOTE:  The temporary files created in the use of PRETREAT may be
  496.      as large as (or slightly more than) ALLFILE.DIR.  Do not attempt
  497.      to run PRETREAT on a RAM disk unless you have a RAM disk which is
  498.      AT LEAST TWICE the size of ALLFILE.DIR (currently over 8 Meg).
  499.         
  500.          ZSView will save the results of a sort if you wish it to do so.
  501.      If ZSView can't use the directory name plus an extension which
  502.      corresponds to the type of sort (i.e., "NAM" , "DAT", or "SIZ"), then
  503.      it will offer to save the file as "SAVED.#", where # is a number
  504.      from 1 to 999.
  505.                 
  506.          A third class of file ZSView generates is a temporary file of the 
  507.      type "Temp_#.BAS."  Normally those files are deleted before ZSView
  508.      finishes.  If you see any files of that type and you have not
  509.      created them, they may be deleted without worry.
  510.  
  511.         
  512.          As noted in the beginning, the most important file ZSView needs
  513.      is the file to be viewed!  ZSView's priority for determining that
  514.      has already been explained.  Just remember that if any missing files
  515.      are restored, the IDX file should be deleted so a new one can be made.
  516.  
  517.          Also note that any zero-byte files with the filenames of
  518.      ALLFILE.DIR or DIR01 would be deleted.
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.                                    - 8 -                         ZSView.DOC
  541.  
  542.  
  543.      Error Messages:
  544.  
  545.          ZSView will generate a few error messages if it finds certain
  546.      problems.  The following ones will end the program immediately:
  547.  
  548.      "E1: Problem Creating Index.  Delete current Index and try again."
  549.       Do as it says!  If the problem reoccurs, there is probably some
  550.       irregularity in ALLFILE.DIR or one of the DIR##.  Try unzipping
  551.       a new one.
  552.  
  553.      "E3: Unable to create a temporary file name.  See manual for help."
  554.       As explained in the previous section, ZSView needs to make files
  555.       of the type "Temp_#", etc.  If there are 999 of these files (from
  556.       1 to 999) then this error message appears.  Rename or destroy all
  557.       those which serve no purpose.  Under normal circumstances, ZSView
  558.       should not leave any files of that type around after a normal exit.
  559.       However, see message "E11."
  560.  
  561.      "E9: Missing ALLFILES.DIR or DIR01"
  562.       ZSView was unable to determine which set to view.  Check to see if
  563.       you are in the proper directory.  If DIR01 was actually missing,
  564.       when it is replaced, delete ALLFILES.IDX and rerun ZSView to create
  565.       a new index.
  566.  
  567.      "E11: Cannot find a suitable way to rename " file name ". Do it
  568.       manually."
  569.       As explained above, if there are too many files of the type
  570.       "Saved.#", where # is a number from 1 to 999, then ZSView will
  571.       be unable to save the given file.  Look for a name of the type
  572.       "Temp_#.#" as the saved file so that it can be renamed as you see
  573.       fit.
  574.  
  575.  
  576.       The following errors will not end the program:
  577.  
  578.       "E4: " File name "is missing.  If found, delete current Index and
  579.        rerun."
  580.       In this condition, a directory which had been previously registered
  581.       in the IDX file has now disappeared.  You may continue to view the
  582.       other directories, but when that one is found, delete the IDX file
  583.       and rerun ZSView to create a new Index.
  584.  
  585.       "E14: File too big to work with.  Returning to Index."
  586.       ZSView can deal with files up to 32,767 lines.  It is possible that
  587.       eventually directory listings will surpass this figure.  In that
  588.       case, ZSView will return you to the Index to view the other listings
  589.       which are still of a reasonable size for it to handle.
  590.  
  591.  
  592.          It is possible that on some systems QB will generate an "OUT OF
  593.      STRING SPACE" error message.  If that happens, please inform us and
  594.      we will release a slightly slower version of ZSView which uses a
  595.      smaller buffer and should fix that problem.
  596.  
  597.  
  598.  
  599.  
  600.                                    - 9 -                         ZSView.DOC
  601.  
  602.  
  603.      Additional Notes:
  604.  
  605.          You might find gaps in the %Done green bar as it goes across the
  606.      screen.  This is most likely due to missing directory files, DIR##,
  607.      unzipped from ALLFILES.ZIP, or a corruption in ALLFILE.DIR.  Either
  608.      replace the missing directories or unzip a new copy of ALLFILE.DIR.
  609.      (Either way, don't forget to run PRETREAT and recreate the IDX file.)
  610.  
  611.          As mentioned, ZSView runs in 16-color, text mode.  It makes a few 
  612.      Basic DEF SEG calls to the B800 area where it expects to find normal
  613.      color video memory.  If you are using a non-standard video card or
  614.      have an extremely unusual upper memory arrangement, then ZSView will
  615.      not work properly and you should not use it.
  616.  
  617.          For the disk space deprived, ZSView may be compressed to around
  618.      52K by using PKLITE v1.5 with the -p option.
  619.  
  620.          If you find any bugs in using ZSView, we'd like to hear about
  621.      them.  Please leave a message here on the IF to Paul Zuber in Main
  622.      Board or e-mail to:   paul.zuber@factory.com
  623.  
  624.  
  625.  
  626.  
  627.      Speed:
  628.  
  629.          There are two times when speed might be an issue.  First, when
  630.      you have to run PRETREAT.  See the discussion in ZS.DOC on the
  631.      reasons for and against turning to a RAM disk.
  632.  
  633.          The other issue of speed concerns the sorting routines.  These
  634.      employ the well-known Quick-sort routine and are probably as fast
  635.      as they can be made for the moment without resorting to the use of
  636.      assembly language.  The real bottleneck in the sort routine is not
  637.      the sorting itself but rather rewriting the file to disk after the
  638.      sort has been done.  Due to the limitations of QB, there is no way
  639.      around that at the moment.
  640.  
  641.  
  642.  
  643.  
  644.      Disclaimer:
  645.  
  646.          Simply, this software is provided "as is" without any warranties 
  647.      or guaranties about its performance or suitability.   You, the user,
  648.      assume all risk for its use.
  649.         
  650.          This software is free for users of the INVENTION FACTORY BBS.
  651.      No fee may be charged for its distribution.
  652.  
  653.          All copyright software and trademarks mentioned herein are the 
  654.      property of their owners.
  655.  
  656.          All rights reserved.
  657.  
  658.  
  659.  
  660.                                    - 10 -                        ZSView.DOC
  661.  
  662.  
  663.      Revision History:
  664.  
  665.      Version 1.00  -  Inaugural release.
  666.  
  667.      Version 1.01 - Added line length check to PRETREAT.EXE to shorten
  668.      lines over 80 characters long to just the first 80.
  669.          Added command line option to jump to a specific directory upon
  670.      startup.
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.                                    - 11 -                        ZSView.DOC
  721.