home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 8 / CDASC08.ISO / VRAC / BSHOW121.ZIP / BSHOW.DOC < prev    next >
Text File  |  1993-08-08  |  24KB  |  541 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                                   BShow 1.21
  15.  
  16.                                       by
  17.  
  18.                                   Ben Sandee
  19.  
  20.                                    08-08-93
  21.  
  22.  
  23.  
  24.                                Table of Contents
  25.                                =================
  26.  
  27.  
  28.         License, disclaimer, etc.................................... 1
  29.         BShow Features.............................................. 2
  30.         BShow Operation............................................. 3
  31.         Command line parameters..................................... 4
  32.         Configuration File Options - Global......................... 5
  33.         Configuration File Options - Unique to each Utility......... 7
  34.         Menu options in BShow....................................... 9
  35.         Adding Compression Utility Interfaces.......................10
  36.         Credits and copyrights......................................12
  37.  
  38.                                     1
  39.  
  40.  
  41.                   LICENSE, DISCLAIMER & MISCELLANEOUS INFO
  42.                   ========================================
  43.  
  44.     You are free to use BShow in any way you see fit, provided you follow
  45.     the following rules:
  46.  
  47.             A) Distribute copies of BShow with it's original archive contents
  48.                intact.  This means NO ADDITIONAL FILES!  You may repack the
  49.                archive with any archiver you wish, provided the original
  50.                contents are not disturbed.
  51.  
  52.             B) You may not SELL BShow.  (w/o previous written consent of
  53.                the author.  You won't get my consent tho, so don't even 
  54.                bother... ;)
  55.  
  56.             C) You may DISTRIBUTE BShow on disk provided you obtain prior 
  57.                written consent AND charge no more than $3 per copy to cover 
  58.                media and production costs.  If you plan on charging more 
  59.                than $3 per copy, don't even waste my time with a letter 
  60.                of permission.
  61.  
  62.     The author of BShow may not be held responsible for ANY damage BShow
  63.     may do to your system or data loss caused by its use.  BShow has
  64.     been extensively tested on a number of systems and SHOULD work on
  65.     yours.  However, the author cannot guarantee that it will work on
  66.     your particular setup.
  67.  
  68.     The Author may be contacted for questions or requests via the above
  69.     mail address, or on the JW-PC DataFlex.HST BBS at (608)837-1923 at
  70.     1200/2400/9600/12200/14400/16800 HST/V.32bis, Fidonet 1:121/8 and
  71.     RBBS-net 8:972/2 or at 1200/2400/9600/12200/14400/16800/19200
  72.     ZYX/V.32bis, Fidonet 1:121/88 and RBBS-Net 8:972/3.  The author may
  73.     also be reached via echomail in the RBBS-PC Conference on either
  74.     RBBS-net or Fidonet.  The latest version of BShow may also be FREQ'd
  75.     via magic name BSHOW at either of the above net addresses.
  76.  
  77.     All products mentioned in this documents are property of their 
  78.     respective owners/companies.
  79.  
  80.                                     2
  81.  
  82.                               BShow Features
  83.                               ==============
  84.  
  85.     BShow is a file viewer that is somewhat revolutionary 
  86.     incorparating these features:
  87.  
  88.           - BShow will support virtually any compression utility!  A
  89.             simple change in the configuration file is all that is
  90.             necessary.
  91.  
  92.           - BShow is not limited to compressed files alone!  It will
  93.             view any file it is given, in one way or another.
  94.  
  95.           - BShow will display ASCII and binary files!  ASCII viewing is a
  96.             simple listing of the file, while binary mode offers a full
  97.             two-column hexadecimal dump.  With this feature, even
  98.             proprietary word processing formats may be read to some
  99.             degree!
  100.  
  101.           - String searches may be employed in either ASCII or
  102.             hexadecimal modes!  In hexadecimal mode, the ability to
  103.             search for either a hexadecimal string or a text string is
  104.             available.
  105.  
  106.           - BShow is shipped configured for ZIP, LZH, ARJ and PAK compressed
  107.             files.  But keep in mind, a new viewer is no longer
  108.             necessary whenever a new compression utility revision
  109.             becomes available!
  110.  
  111.           - BShow includes built-in support for viewing nested compressed
  112.             files!  It's as easy as viewing a normal file!
  113.  
  114.           - BShow features easy BBS integration, and was in fact
  115.             designed to be used on a BBS system!
  116.  
  117.           - BShow supports the use of a Fossil Driver
  118.         
  119.           - User definable work drives offer increased speed, with the
  120.             ability to use a RAM drive!
  121.                                     3
  122.  
  123.                                BShow Operation
  124.                                ===============
  125.  
  126.     BShow may be operated from either the DOS command line or a batch
  127.     file.  The examples in this document will assume BBS usage via a
  128.     batch file, but keep in mind that it can be operated from the DOS
  129.     command line with equal ease.  There is purposely an overlap between
  130.     the command line switches and the configuration file, so that the
  131.     user may decide what is desired to be flexible and passed on the
  132.     command line, and what is desired to be static and hardcoded in
  133.     the configuration file.
  134.  
  135.     In order to use BShow, the sysop will need the following files:
  136.  
  137.          BSHOW.EXE      The executable program. (Included)
  138.          BSHOW.CFG      A sample configuration file.
  139.          RBBSBATS.ZIP   Series of RBBS batch files to View compressed files
  140.          FORCE.BAT      FORCE batch file to View compressed files
  141.          PKZIP.EXE  -+
  142.          PKUNZIP.EXE |
  143.          LHA.EXE     +- Compression utilities as desired, user furnished.
  144.          ARJ.EXE     |
  145.          XYZ.ETC    -+
  146.          SPWN13.ZIP     Optional PD Desqview window spawning utility.
  147.                         (Included)
  148.  
  149.     Note SHROOM, or current version SHROM18G.ZIP, may give you all the
  150.     memory you need for ARJ, without DesqView, but it has not yet been
  151.     tested with BSHOW.  If you try it, let us know of the results. SHROOM
  152.     is a shareware product by Davis Augustine, of Cambridge, MA.
  153.  
  154.     Authentic BShow files will come packed in an -AV stamped ZIP file,
  155.     packaged by JW-PC Consulting.
  156.                                     4
  157.  
  158.                      Command Line Parameters for BShow
  159.                      =================================
  160.  
  161.     Conventions:      Required items labeled REQUIRED, defaults labeled
  162.                       DEFAULT; if parameter is skipped, default is taken.
  163.                       Square brackets surround user-supplied data, and
  164.                       should NOT be included in batch or cfg files!
  165.  
  166.     Filename.EXT    « REQUIRED.  BShow uses ext to determine compression
  167.                       format.
  168.  
  169.     /p[port]        « REQUIRED for remote operation.  If local BBS node
  170.                       passes 0 for port, baud is ignored and local
  171.                       operation is default.
  172.                       [0=LOCAL=DEFAULT]
  173.  
  174.     /wx:\workdir    « Uses work directory on drive x: (optional) and uses
  175.                       directory "WORKDIR", for processing.  You may specify
  176.                       a RAM drive for extra speed.  You will need enough
  177.                       space to hold the largest file within a compressed
  178.                       file, plus a couple kilobytes.
  179.                       [DEFAULT=CURRENT]
  180.  
  181.     /m[#]           « Maximum number of minutes in BShow.
  182.  
  183.                       Note:  The LESSER of either the command line OR the
  184.                              config file will be used by BShow.
  185.  
  186.                       [0=NO LIMIT=DEFAULT]
  187.  
  188.     /t[#]           « maximum number of seconds of idle time.
  189.                       [0=NO LIMIT=DEFAULT]
  190.  
  191.     /l[#]           « maximum number of lines total to be displayed per
  192.                       session.  (prevents user from doing massive ASCII
  193.                       downloads)
  194.                       [0=NO LIMIT=DEFAULT]
  195.  
  196.     /i[#]           « number of lines per page.
  197.                       [23=DEFAULT]
  198.  
  199.     /o[file.ext]    « points to configuration file.
  200.                       [BSHOW.CFG=DEFAULT]
  201.  
  202.     /f[ext]         « forces bshow to use config option for extension ext.
  203.  
  204.                                     5
  205.  
  206.  
  207.                          Configuration File Options
  208.                          ==========================
  209.  
  210.     See sample BSHOW.CFG in distribution package for specific examples and
  211.     suggested order of commands.  Brackets appearing in BShow.CFG should
  212.     be removed before running and sample data replaced with actual.
  213.  
  214.     Global options which apply to all of BShow:
  215.     -------------------------------------------
  216.  
  217.     / ; *           « if in first column, each designates a comment...
  218.  
  219.     del_dir=#       « where # is the del directory mode.  If it's zero,
  220.                       it leaves the work directory in place, otherwise,
  221.                       it deletes it.  Note that if a work directory
  222.                       is specified with full path, it may be left in
  223.                       place without worrying about having multiple
  224.                       directories created.
  225.                       0=OFF=DEFAULT=LEAVE.  NOT ZERO=ON=DELETE.
  226.  
  227.     directvideo=#   « force BIOS (0) or direct (1) screen writes
  228.  
  229.                       Note:  If BShow detects DESQview, it will default
  230.                              to BIOS screen writes, otherwise direct
  231.                              screen writes are the default.
  232.  
  233.     fossil=#        « selects fossil driver usage OFF (0) or ON (1)
  234.  
  235.     lines=#         « the number of lines per page.  This determines the
  236.                       number of lines between page breaks.
  237.  
  238.     max_blanks=#    « the maximum number of consecutive blank lines to
  239.                       display.  Documents often begin with several pages
  240.                       of blank lines, and this feature cuts down on
  241.                       display time.
  242.  
  243.     max_idle=#      « the maximum idle time in seconds to allow user
  244.  
  245.     max_line=#       « the maximum number of lines per file to display
  246.                        to a user.  Good to prevent users from "viewing"
  247.                        a 300K text file to save a download credit.
  248.  
  249.     max_time=#      « designates the maximum amount of time to allow a
  250.                       user to be in a BShow session.  The LESSER of
  251.                       either the command line OR the config file will
  252.                       be used by BShow.
  253.  
  254.                       example:     max_time=10
  255.  
  256.     nested=#        « limits the number of levels deep a user can go into
  257.                       nested archives.  Setting this to zero disables nested
  258.                       archive viewing.  To have no limit, set it to 30000.
  259.                       Then tell me if anyone reaches that.  :)
  260.  
  261.                                     6
  262.  
  263.     swap=#          « where # is the swapping mode.
  264.                       0=OFF=DEFAULT.  NON-ZERO=ON.
  265.  
  266.                       When BShow shells out to the unpacker/lister, it can
  267.                       either do one of two things:
  268.  
  269.                          1) It can shell to DOS by running a second copy of
  270.                             COMMAND.COM (leaving all of BShow in memory) and
  271.                             then run the unpacker/lister.
  272.  
  273.                          2) It can take the BShow code in memory, and
  274.                             copy it to EMS/XMS/HMA/Disk, freeing up that
  275.                             memory for use by the unpacker/lister.  When
  276.                             the unpack/lister is finished, BShow is
  277.                             reloaded into conventional DOS memory, and
  278.                             execution resumes.
  279.  
  280.                       The default is off because there have been certain
  281.                       compatibility problems between BShow and some
  282.                       ill-behaved programs.  BShow will also function
  283.                       faster with swapping off, so if possible, DON'T SWAP!
  284.  
  285.                       Additional note:  SWAPPING may also be included as a
  286.                       local parameter for a specific archive type.
  287.  
  288.     work_dir=       « same function as the command line parameter.
  289.  
  290.                                     7
  291.  
  292.               Format options unique to each compression utility
  293.               =================================================
  294.  
  295.     end             « ENDS the series of options started by the previous
  296.                       "format_xxx" command.
  297.  
  298.     format_xxx      « BEGINS compression-program-specific-section series of
  299.                       options used only if target file extension is ".xxx" .
  300.  
  301.                 example:   format_zip
  302.                            unpack=pkunzip %file% %filespec% > %listfile%"
  303.                            list=...
  304.                            end
  305.  
  306.     header1=        « the string to display once per screenful of data,
  307.                       while viewing the files.
  308.  
  309.     header2=        « the string to display once per screenful of data,
  310.                       right after header1.
  311.  
  312.     list=           « string containing the path and parameters used to
  313.                       run the lister.  This should give a list of the
  314.                       files in the archive.
  315.  
  316.                       You can put several different variables that are
  317.                       replaced by Bshow with parameters originally
  318.                       passed from the command line.  These include:
  319.  
  320.                       %file%       - the archive name
  321.                       %filespec%   - in unpack mode, this is the file to
  322.                                      unpack, in list mode, it's the
  323.                                      filespec for lists.
  324.                       %listfile%  - the listfile used by Bshow.
  325.  
  326.                       Examples:
  327.  
  328.         list=spawn /m:160 /w "lha.exe l %file% %filespec% > %listfile%"
  329.         unpack=spawn /m:160 /w "lha.exe e -y %file% %filespec% > nul"
  330.  
  331.                        or
  332.  
  333.         list=lha.exe l %file% %filespec% > %listfile%
  334.         unpack=lha.exe e %file% %filespec% > nul
  335.  
  336.                       Note the positioning of the quoted strings used
  337.                       when SPAWN is used for DESQview operation.
  338.  
  339.     offset1=        « number of characters to strip off the beginning
  340.                       of the string read from the list of the files in
  341.                       the archive.
  342.  
  343.                                     8
  344.  
  345.     offset2=        « number of characters to strip off the END of the
  346.                       string read from the list of the files in the
  347.                       archive.
  348.  
  349.                       Offset1 and 2 are used to strip certain characters
  350.                       off the string, to make it fit into 80 columns.
  351.  
  352.     offset3=        « which column the filename starts in each line read
  353.                       from the file listing.
  354.  
  355.     waitfor1=       « the string to watch for, to signal the beginning
  356.                       of the file list.
  357.  
  358.     waitfor2=       « the string to watch for, to signal the END of
  359.                       the file list.
  360.  
  361.     unpack=         « string containing the path and parameters used to
  362.                       run the unpacker.
  363.  
  364.     For examples see the included example files or BSHOW.CFG.
  365.                                     9
  366.  
  367.  
  368.                            Menu Options in BShow
  369.                            =====================
  370.  
  371.     From the Main prompt:
  372.  
  373.      [Main] <L,#,?=Help,[Enter]=Exit>: ?
  374.  
  375.       'L'        - relists the directory with the SAME filespec.
  376.       #          - the number corresponding to the file you wish to view.
  377.                    (NOTE! This includes nested archives!)
  378.       [name]     - the name of the file you wish to view.
  379.                    (NOTE! Same as above!)
  380.       [wildcard] - relists the directory with a NEW filepsec.
  381.       [enter]    - exits BShow.
  382.  
  383.  
  384.     From within the directory listing:
  385.  
  386.      [Dir] <A,C,L,M,N,Q,#,?=Help>:
  387.  
  388.       'M' or
  389.       [enter]    - Continues file listing with next page.
  390.       'N'        - Quits listing files, and goes directly to main prompt.
  391.       'L'        - Relists the directory from the beginning.
  392.       'C'        - Enters continuous text viewing mode, without these prompts
  393.                    Note that you may press any key to abort continuous mode.
  394.       #          - The number corresponding to the file you wish to view.
  395.                    (NOTE! This includes nested archives!)
  396.       [name]     - The name of the file you wish to view.
  397.                    (NOTE! Same as above!)
  398.       [wildcard] - Relists the directory with new filespecs.
  399.       'Q' or 'A' - Exits BShow RIGHT NOW!!
  400.  
  401.     From within a Text or Binary listing:
  402.  
  403.      [List - 32% done] - <A,B,C,M,N,S,Q,?=Help>: ?
  404.  
  405.      'M' or
  406.      [Enter]     - Lists next page of file.
  407.      'C'         - Enters continuous viewing mode.  This will eliminate all
  408.                    prompts.  Note that you can enter normal mode again by
  409.                    pressing any key.
  410.      'B'         - Backup one page, and list it (view previous page).
  411.      'S'         - Starts a string search in either text or binary modes.
  412.      'T'         - Toggles between normal view mode and hex dump mode.
  413.      'N'         - Returns to directory list mode.
  414.      'Q' or 'A'  - exits BShow RIGHT NOW!!
  415.                                     10
  416.  
  417.                    Adding Compression Utility Interfaces
  418.                    =====================================
  419.  
  420.     BShow has been designed so that as compression programs are created
  421.     or improved, they may be utilized by the sysop.
  422.  
  423.     This is a sample archive listing, generated by LHA 2.13 using the
  424.     "lha l test.lzh" command.  This is the straight listing, no comments.
  425.  
  426.     -=-=-=-=- LISTING STARTS BELOW THIS LINE -=-=-=-=-
  427.  
  428.     Listing of archive :  TEST.LZH
  429.  
  430.       Name          Original    Packed  Ratio   Date     Time   Attr Type  CRC
  431.     --------------  --------  -------- ------ -------- -------- ---- ----- ----
  432.       SOURCE.C          2779      1203  43.3% 91-09-29 14:47:42 a--w -lh5- 1D2E
  433.       SOURCE.OBJ        8066      2438  30.2% 91-09-29 03:07:40 a--w -lh5- 4B91
  434.       SOURCE.EXE        1368       447  32.7% 91-09-24 21:02:48 a--w -lh5- 659C
  435.       OTHER.FIL         4478      1285  28.7% 91-09-29 14:46:16 a--w -lh5- 0A02
  436.       MORE.FIL          5275      1460  27.7% 91-09-29 14:44:32 a--w -lh5- 18B5
  437.       JUNK.EXE          3312      1039  31.4% 91-09-05 09:47:44 a--w -lh5- 0378
  438.       MISC.COM          2152       812  37.7% 91-09-29 14:42:06 a--w -lh5- EE1A
  439.       HELPME.DOC        5780      3516  60.8% 91-09-29 14:47:48 a--w -lh5- C5DE
  440.       READ.ALL         12348      7358  59.6% 91-09-29 03:27:32 a--w -lh5- 323E
  441.       HANGON.TOM        2216      1417  63.9% 91-09-29 03:27:34 a--w -lh5- 5CB9
  442.       FORGET.ME         7139      4271  59.8% 91-09-29 14:47:26 a--w -lh5- D415
  443.       MORE.C            6414      3797  59.2% 91-09-29 14:44:40 a--w -lh5- 08C0
  444.       TEST.FIL          3219      2188  68.0% 91-09-29 14:42:36 a--w -lh5- 777F
  445.     --------------  --------  -------- ------ -------- --------
  446.         13 files       64546     31231  48.4% 91-09-29 15:25:20
  447.  
  448.     -=-=-=-=- LISTING ENDS ABOVE THIS LINE -=-=-=-=-
  449.  
  450.  
  451.     What follows is the same text file - with comments. They describe
  452.     what each parameter in the configuration does to process this file
  453.     listing, as well as all others generated by LHA.  Follow this procedure
  454.     with any similar compression program, and BShow should work with it.
  455.     "//" designates a comment line, and starts in what represents the first
  456.     column of the listing.
  457.                                     11
  458.  
  459.     -=-=-=-=- LISTING BEGINS BELOW THIS LINE -=-=-=-=-
  460.  
  461.     Listing of archive :  TEST.LZH
  462.  
  463.     //This next line is the format1= line.  First line of every page.
  464.       Name          Original    Packed  Ratio   Date     Time   Attr Type  CRC
  465.     //
  466.     // This next one is the format2= line, AS WELL AS, the waitfor1= line.
  467.     // BShow reads until it encounters this string, and then everything from
  468.     // then on are file listings.
  469.     //
  470.     --------------  --------  -------- ------ -------- -------- ---- ----- ----
  471.     // notice that the offset1=2 means which column the file names start in.
  472.     // In LHA, they start in column 2.
  473.       SOURCE.C          2779      1203  43.3% 91-09-29 14:47:42 a--w -lh5- 1D2E
  474.       SOURCE.OBJ        8066      2438  30.2% 91-09-29 03:07:40 a--w -lh5- 4B91
  475.       SOURCE.EXE        1368       447  32.7% 91-09-24 21:02:48 a--w -lh5- 659C
  476.       OTHER.FIL         4478      1285  28.7% 91-09-29 14:46:16 a--w -lh5- 0A02
  477.       MORE.FIL          5275      1460  27.7% 91-09-29 14:44:32 a--w -lh5- 18B5
  478.       JUNK.EXE          3312      1039  31.4% 91-09-05 09:47:44 a--w -lh5- 0378
  479.     //
  480.     // Two other parameters, the offset1, and offset2, delete spaces, or
  481.     // characters from the end of strings.  This is to clarify things.
  482.     // Offset2=1 will delete 1 character off the beginning of the line,
  483.     // just before displaying it. offset3=1 will chop one character off
  484.     // the end of the string.  If lines take up two lines, because they
  485.     // are too long, you can use these options to trim them down.
  486.     //
  487.       MISC.COM          2152       812  37.7% 91-09-29 14:42:06 a--w -lh5- EE1A
  488.       HELPME.DOC        5780      3516  60.8% 91-09-29 14:47:48 a--w -lh5- C5DE
  489.       READ.ALL         12348      7358  59.6% 91-09-29 03:27:32 a--w -lh5- 323E
  490.       HANGON.TOM        2216      1417  63.9% 91-09-29 03:27:34 a--w -lh5- 5CB9
  491.       FORGET.ME         7139      4271  59.8% 91-09-29 14:47:26 a--w -lh5- D415
  492.       MORE.C            6414      3797  59.2% 91-09-29 14:44:40 a--w -lh5- 08C0
  493.       TEST.FIL          3219      2188  68.0% 91-09-29 14:42:36 a--w -lh5- 777F
  494.     //
  495.     // This is the waitfor2= line.  If it doesn't find this string anywhere,
  496.     // it keeps reading, line by line, until it encounters EOF.
  497.     //
  498.     --------------  --------  -------- ------ -------- --------
  499.         13 files       64546     31231  48.4% 91-09-29 15:25:20
  500.  
  501.     -=-=-=-=- FILE LISTING ENDS ABOVE -=-=-=-=-
  502.  
  503.                                     12
  504.  
  505.                        Credits, Copyrights, and Thanks
  506.                        ===============================
  507.  
  508.     This documentation has been prepared by Jim Wargula, Sysop of JW-PC
  509.     DataFlex.HST RBBS, where Alpha and Beta testing of BShow, modem
  510.     distribution, and modem support are based.  Please feel free to comment
  511.     on any documentation errors or omissions.  The docs are slowly being
  512.     improved and ways of expanding them for more clear explanations will
  513.     be explored...
  514.  
  515.     This documentation has been edited by Tim Sandee and Ben Sandee.
  516.  
  517.     BShow is Copyright (c) Ben Sandee, 1991, 1993 and may not be distributed
  518.     as part of any other package or by any commercial enterprise without
  519.     the express knowledge and consent of the author.  BBS systems are
  520.     given permission to distribute BShow in the Shareware version.
  521.  
  522.     Utility programs called by BShow are copyrighted by their respective
  523.     authors and should be registered as required.
  524.  
  525.     Thanks to:
  526.  
  527.           Jim Wargula - alpha tester, beta tester, support,
  528.                         documentation.
  529.  
  530.           John Fox      \
  531.           Ken Geen       \
  532.           Roy Jacobs   ---- Beta testers, ideas, support.
  533.           Ron Mainguth   /
  534.           Mark Simmons  /
  535.  
  536.           Tim Sandee -  documentation, ideas.
  537.  
  538.           All the SysOps out there who make BBS'ing more enjoyable.
  539.  
  540.     Document revision 1.21, 08-08-93
  541.