home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbs / aview65b.zip / AVIEWCOM.DOC < prev    next >
Text File  |  1994-01-26  |  42KB  |  903 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.           
  11.      _________________________________________________________________
  12.  
  13.                     AViewCom.Exe    Version 6.5b     01/25/94
  14.  
  15.                       Archive View to Console and Comm port
  16.  
  17.                  Copyright (C) 1989-1994 by Cygnus Data Systems
  18.                                 Daniel A. Durbin
  19.           
  20.      _________________________________________________________________
  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.  
  59.  
  60.  
  61.  
  62.  
  63.      AViewCom v6.5                                                       1
  64.  
  65.      Contents
  66.      --------
  67.                INSTALLATION . . . . . . . . . . . . . . . .  2
  68.                FILES. . . . . . . . . . . . . . . . . . . .  2
  69.                DISPLAY FILES. . . . . . . . . . . . . . . .  2
  70.                READING DOOR.SYS . . . . . . . . . . . . . .  3
  71.                ENVIRONMENT VARIABLES. . . . . . . . . . . .  3
  72.                DIRECTORIES. . . . . . . . . . . . . . . . .  3
  73.                MULTI-NODE SYSTEMS . . . . . . . . . . . . .  4
  74.                MULTITASKING SYSTEMS . . . . . . . . . . . .  4
  75.                RUNNING AVIEWCOM . . . . . . . . . . . . . .  4
  76.                SysOp COMMANDS . . . . . . . . . . . . . . .  5
  77.                ONLINE COMMANDS. . . . . . . . . . . . . . .  6
  78.                SYNTAX . . . . . . . . . . . . . . . . . . .  7
  79.                SETUP. . . . . . . . . . . . . . . . . . . . 10
  80.                COMM PORTS . . . . . . . . . . . . . . . . . 10
  81.                EXTRACTOR. . . . . . . . . . . . . . . . . . 10
  82.                ANSI COLOR . . . . . . . . . . . . . . . . . 10
  83.                PROTOCOL DEFINITION FILE . . . . . . . . . . 11
  84.                CONFIGURATION FILE . . . . . . . . . . . . . 12
  85.                PRIORITY . . . . . . . . . . . . . . . . . . 12
  86.                Update User's Information. . . . . . . . . . 12
  87.                Installing your Registration Number. . . . . 13
  88.                EXIT CODE. . . . . . . . . . . . . . . . . . 13
  89.                CREDITS & ACKNOWLEDGEMENTS . . . . . . . . . 13
  90.                DISCLAIMER . . . . . . . . . . . . . . . . . 14
  91.                BUGS and LIMITATIONS . . . . . . . . . . . . 14
  92.                FUTURE . . . . . . . . . . . . . . . . . . . 14
  93.  
  94.      DESCRIPTION
  95.      -----------
  96.      AViewCom allows BBS callers to view archive contents while online,
  97.      read ASCII files within archives, and download any file from within an
  98.      archive.  The ability to download files from within the archive is
  99.      useful when a caller wants to read a document file prior to
  100.      downloading the entire archive, or to retrieve one file that may have
  101.      been corrupted during a previous transfer.  Callers may also create a
  102.      temporary archive containing any number of files from the original
  103.      archive.  Aviewcom supports arj, arc, pak, zip, zoo, lzh, lha, and
  104.      some exe and com archives.
  105.  
  106.      AViewCom is written specifically with WildCat BBS in mind since
  107.      WildCat has a [V]iew Archive file function in the files menu which
  108.      makes a call to an external arcview program and passes the caller's
  109.      specified filename to VIEWCOMP.BAT as a DOS parameter %1.  However,
  110.      AViewCom may be used with other BBS's which do not pass a filename as
  111.      a DOS parameter.  In this case, AViewCom may be run as a DOOR program. 
  112.      In the batch file, simply replace the [filename] parameter with an
  113.      asterisk ('*').  AViewCom will then prompt the caller for the full
  114.      pathname to the archive file.  A configuration file may be used to
  115.      specify directories to be searched for the file, so that only the
  116.      filename without the path need be specified.
  117.  
  118.  
  119.      AViewCom v6.5
  120.      AViewCom v6.5                                                       2
  121.  
  122.      INSTALLATION
  123.      ------------
  124.      Make a subdirectory on your hard disk such as C:\WC30\AVIEWCOM and
  125.      extract the distribution archive into that subdirectory.  Modify the
  126.      VIEWCOMP.BAT file to fit your configuration.  Review the AVIEWCOM.CNF
  127.      file and its uses and delete it if not needed.  If you're not running
  128.      WildCat, then modify it to include the sub-directories where you keep
  129.      the archives posted on your BBS.  Review the AVIEWCOM.PRO file and
  130.      modify it as necessary.  Make sure that all required archive utilities
  131.      (e.g. PKUNZIP, PKZIP, ARJ, LHA, PAK) and your file transfer protocols
  132.      (DSZ) are in a subdirectory which is included in your path statement
  133.      (e.g. C:\UTIL or C:\WC30\PROTOCOL and C:\WC30\UTIL).
  134.  
  135.      FILES
  136.      -----
  137.      Included:
  138.  
  139.           AVIEWCOM.CNF   A sample configuration file
  140.           AVIEWCOM.DOC   This file
  141.           AVIEWCOM.EXE   The ArcView program
  142.           AVIEWCOM.HLP   Displayed when caller requests [H]elp
  143.           AVIEWCOM.HST   History of revisions
  144.           AVIEWCOM.BYE   Displayed after ALT-G hot-key logoff
  145.           AVIEWCOM.PRO   External Protocol Definition File
  146.           DIGIFONE.TXT   A Telephone Answering System Ad
  147.           VIEWCOMP.BAT   A sample batch file for WildCat
  148.           WHATSUP.DOC    Information on the latest haps
  149.           ORDER.FRM      Order Form
  150.  
  151.      Not Included:
  152.  
  153.           AVIEWCOM.SCR   Welcome screen for ANSI callers
  154.           AVIEWCOM.BBS   Welcome screen for MONO callers
  155.           AVIEWmmm.LOG   Activity log for AVIEWCOM.EXE
  156.           AVIEWLST.nnn   Temporary archive filename list
  157.           AVIEWnnn.???   Temporary archive used during downloading
  158.           AVIEWCOM.DAT   Created and erased by AVIEWCOM.EXE
  159.           AVIEWCOM.STD   Created when shelling to external programs
  160.           USERINFO.DAT   Created by WildCat - update by AVIEWCOM.EXE
  161.           DOOR.SYS       Created by WildCat - read by AVIEWCOM.EXE
  162.  
  163.      The file AVIEWCOM.CNF is primarily intended for Non-Wildcat systems. 
  164.      If you are entering all your options on the command line, then please
  165.      delete this file to prevent AViewCom from reading options from it.
  166.  
  167.      DISPLAY FILES
  168.      -------------
  169.      You may use your editor to create the welcome screen files. AViewCom
  170.      will display the appropriate file depending on their color setting. 
  171.      If they have color selected but the .SCR file does not exist, the .BBS
  172.      file will be displayed instead.  AViewCom will expect to find these
  173.      files in its "home directory" which is where  AVIEWCOM.EXE resides.
  174.  
  175.      These files are not required, but if they exists, will be displayed.
  176.           AVIEWCOM.HLP   Displayed when the caller requests [H]elp
  177.           AVIEWCOM.SCR   Welcome screen, ANSI color version
  178.           AVIEWCOM.BBS   Welcome screen, monochrome version
  179.      AViewCom v6.5
  180.      AViewCom v6.5                                                       3
  181.  
  182.      READING DOOR.SYS
  183.      ----------------
  184.      AViewCom will read DOOR.SYS and USERINFO.DAT (registered version
  185.      only), which MUST be in the current directory.  AViewCom will search
  186.      the current directory for DOOR.SYS and USERINFO.DAT.  If you CD to any
  187.      other directory, you will need to copy these files to that directory
  188.      before calling AViewCom. The shareware version will not read the
  189.      DOOR.SYS file.  You should however be able to use AViewCom normally. 
  190.      If you are using a non-standard comm port, you may use the -i and -b
  191.      parameters to specify the comm port irq and base address.
  192.  
  193.      ENVIRONMENT VARIABLES
  194.      ---------------------
  195.      AViewCom needs more information than is provided in the DOOR.SYS and
  196.      USERINFO.DAT files.  It reads from the environment:
  197.  
  198.           WCPORTID=CommPort        (Comm Port Number)
  199.           WCBASEID=CommBase        (Comm Port Base Address)
  200.           WCIRQID=CommIRQ          (Comm Port IRQ Number)
  201.  
  202.      Information that is not available from DOOR.SYS, USERINFO.DAT, and the
  203.      environment include:
  204.  
  205.           WCRATIO=UD Ratio Limit        (Sec Level U/D Ratio Limit)
  206.  
  207.      This is number of downloads divided by number of uploads.  For
  208.      example, WCRATIO=20 would mean limit to 20 downloads for every upload.
  209.  
  210.      DIRECTORIES
  211.      -----------
  212.      Because of the number of files AViewCom uses, it is suggested that
  213.      AViewCom reside in its own directory, although this is optional. 
  214.      While in its own directory, it should be run from the main WildCat
  215.      directory, or from the node subdirectory for multi-node installations.
  216.      This is done by simply adding the full pathname to AViewCom in the
  217.      VIEWCOMP.BAT file.  For example:
  218.  
  219.           C:\WC30\AVIEWCOM\AVIEWCOM %1 COM1 -W
  220.  
  221.      AViewCom is smart and knows which directory it is being run from and
  222.      will look in that directory for its operating files.
  223.  
  224.      When AViewCom goes to extract files from archives, it will look in the
  225.      working directory to check if the filename already exists.  If it
  226.      does, the file will not be extracted and the existing file will be
  227.      displayed.  When done, the pre-existing file will not be deleted. The
  228.      best approach is to specify a temporary working directory which is
  229.      normally empty in which AViewCom can extract and display files which
  230.      will then be deleted when finished.  The temporary working directory
  231.      is specified with the '-p' option on the command line. For example:
  232.  
  233.           AVIEWCOM %1 COM1 -pC:\TEMP
  234.  
  235.      Please note that the directory pathname immediately proceeds the -p
  236.      characters.  You should make certain that the specified directory
  237.      actually exists.
  238.  
  239.      AViewCom v6.5
  240.      AViewCom v6.5                                                       4
  241.  
  242.      MULTI-NODE SYSTEMS
  243.      ------------------
  244.      WildCat places the DOOR.SYS file in the node subdirectory.  Since
  245.      AViewCom expects to find this file in the current directory, you must
  246.      CD to the node directory in the VIEWCOMP.BAT file.  You may keep the
  247.      VIEWCOMP.BAT file in the C:\WC30 directory and use the %WCNODEID%
  248.      environment variable in your CD statement to specify the appropriate
  249.      directory.  For example:
  250.  
  251.           CD C:\WC30\WCWORK\NODE%WCNODEID%
  252.  
  253.      MULTITASKING SYSTEMS
  254.      --------------------
  255.      If your system is running a multitasking software, be especially aware
  256.      of memory requirements.  The multitasker, BBS, AViewCom and the
  257.      extractor could all be resident simultaneously.  AViewCom has been
  258.      known to lock up tight with the combination of newer versions of
  259.      DesqView, WildCat, AViewCom, and pkunzip.  Older versions of DesqView
  260.      present no problem.  There ARE several Multi-Node systems now running
  261.      under DesqView that use AViewCom successfully.  If you are
  262.      experiencing difficulties, please review your setup, make sure you
  263.      have sufficient memory available to AViewCom, and try again. If you
  264.      still have trouble, check the DesqView message folder on the CatHouse
  265.      for current information regarding running under DesqView.
  266.  
  267.      RUNNING AVIEWCOM
  268.      ----------------
  269.      AViewCom may be run directly from the command line.  Simply specify
  270.      the full pathname to the archive to be viewed (with no comm port
  271.      specified, AViewCom will default to the local mode).  You should try
  272.      this before adding AViewCom to your BBS.  The screen will clear and a
  273.      prompt appears for ANSI display, then the filename to view.  After
  274.      answering, the contents of the archive will be displayed, and a
  275.      command line prompt will appear.
  276.  
  277.      Then try adding it to your BBS.  If you're using WildCat, modify your
  278.      VIEWCOMP.BAT file to read:  AVIEWCOM %1 COM1 (or whatever comm port
  279.      you are using for your BBS).  Once you're sure this is working okay,
  280.      you may add other options, such as reading caller information from the
  281.      DOOR.SYS (registered version only), a file which is created by Wildcat
  282.      when shelling to an archive viewer.  Add the '-w' parameter to the
  283.      AViewCom command line.  For example:
  284.  
  285.           AVIEWCOM %1 COM1 -W
  286.  
  287.      When using the -W parameter, AViewCom will read the WCBASEID and
  288.      WCIRQID from the environment and the COM1 on the command line serves
  289.      as a dummy variable which must still be present but will be ignored.
  290.  
  291.      Notice that case is not significant in command line parameters. Once
  292.      all this is working, you may wish to further review the other options
  293.      that are available as specified in the SETUP section of this
  294.      documentation.  If you have any trouble, start with things as simple
  295.      as possible.  Then add options one at a time and verify that each is
  296.      working properly.  Also, take time to read all options and review all
  297.      files included in this archive package.
  298.  
  299.      AViewCom v6.5
  300.      AViewCom v6.5                                                       5
  301.  
  302.      Review the files included and delete ALL that are not applicable to
  303.      your configuration.  Most WildCat systems can use the VIEWCOMP.BAT
  304.      file included.  Review the syntax listed below to select options for
  305.      your system.  You may choose to specify all options on the command
  306.      line, OR specify them in the AVIEWCOM.CNF file, whichever is most
  307.      comfortable for you to use. 
  308.  
  309.      However, if you use the command line for specifying options, please 
  310.      delete the .CNF files to reduce confusion.  If you use the .CNF file,
  311.      do not use the command line options.
  312.  
  313.      SysOp COMMANDS
  314.      --------------
  315.      These commands are available ONLY in the registered version. The SysOp
  316.      commands are read directly from the keyboard and are NOT accessible to
  317.      the caller online.  There is no possibility of the caller being able
  318.      to drop to DOS.
  319.  
  320.      While the caller is online, the following commands are available to
  321.      the SysOp.  I will add any other commands you may desire - just make
  322.      the suggestion!
  323.  
  324.           UP        add 1 minute to caller's time.
  325.           DOWN      subtract 1 minute from caller's time.
  326.           PG-UP     add 5 minutes to caller's time.
  327.           PG-DOWN   subtract 5 minutes from caller's time.
  328.           ALT-D     drop to DOS.
  329.           ALT-C     chat with caller
  330.           ALT-Q     goodbye to caller (terminate aviewcom session)
  331.           ALT-G     Drop DTR and HANGUP on caller!
  332.  
  333.      The caller time adjustment does not carry through to WildCat when the
  334.      caller returns to the BBS.  This may change in the future.
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.      AViewCom v6.5
  360.      AViewCom v6.5                                                       6
  361.  
  362.      ONLINE COMMANDS
  363.      ---------------
  364.      AViewCom will allow BBS callers to read text files that are contained
  365.      within an archive file.  AViewCom will not display files with .com,
  366.      .exe, .obj, or .ovl extensions.  The file is also checked for nul
  367.      characters contained within the first 255 bytes of the file and will
  368.      not display it if there are any.  If the file passes the tests, it
  369.      will be extracted by making a DOS call to an external extractor which
  370.      must reside somewhere in the DOS path (which includes the current
  371.      directory).  The file is then extracted to the home directory or
  372.      temporary path, displayed, and deleted. However, if the file already
  373.      exists before the call to the extractor, it is displayed, but not
  374.      deleted.  AViewCom displays the contents of archives in the following
  375.      format.
  376.  
  377. Performing ArcView on [Aview64g]
  378.  
  379.   #  FileName      Stowage   UnZIP Sz  ZIP Size  Pct  Date      Time   CRC 
  380. ═══  ════════════  ════════  ════════  ════════  ═══  ════════  ═════  ════════
  381.   1  av-pif.dvp    Implode        416       126  70%  03/29/92  12:15  A3D5C9F9
  382.   2  aviewcom.hlp  Implode      11777      3801  68%  07/09/92  09:02  277FA9AF
  383.   3  aviewcom.doc  Implode      41104     13819  67%  02/24/93  18:55  14DE017C
  384.   4  aviewcom.bye  Stored          50        50   0%  03/29/92  12:15  FFCA0810
  385.   5  aviewcom.pro  Shrunk         195       134  32%  03/29/92  12:15  ED85789B
  386.   6  aviewcom.hst  Implode      18870      5357  72%  02/24/93  18:25  0C5A9BB6
  387.   7  aviewcom.cnf  Implode       1817      1062  42%  08/04/92  21:42  99AB8C34
  388.   8  order.frm     Implode       2683      1037  62%  08/01/92  22:25  3C6261DC
  389.   9  viewcomp.bat  Implode       2145      1162  46%  02/24/93  19:19  3211EEF6
  390.  10  aviewcom.exe  Implode      55686     33961  40%  02/24/93  18:39  22212841
  391.  11  whatsup.doc   Implode       9614      4311  56%  02/24/93  19:08  A6B8AC4B
  392.  12  offer.txt     Implode       8081      3280  60%  02/24/93  00:32  F4CFE5FE
  393. ───  ────────────            ────────  ────────  ───
  394.  12  File(s)   Pkunzip Total   152438     68100  56%
  395.  
  396. Enter [filename] or [#] to read, [D]ownLoad, [M]ark, [V]iew, [L]ist, or [H]elp
  397. [45] Mins Left [ # [filename] D M V L H [Return] to Quit]? 
  398.  
  399.      The viewer is then presented with the above command prompt. The viewer
  400.      may enter the filename as it appears in the view listing, or may enter
  401.      the number associated with the filename (shown on the very left of the
  402.      listing).
  403.  
  404.           [file]    full filename of the file to view
  405.           [D]       download a file or marked files from the archive
  406.           [M]       mark a file
  407.           [V]       re-View the archive showing detailed information
  408.           [L]       list filenames, dates, and marked status
  409.           [H]       display AVIEWCOM.HLP
  410.           [Return]  terminate AViewCom session
  411.  
  412.      Not shown is the S command.  This command displays the caller's
  413.      "Statistics".  This command is provided to check that AViewCom has
  414.      properly read the caller's information from DOOR.SYS.  For more
  415.      details on Operation, please see the accompanying text file
  416.      AVIEWCOM.HLP.
  417.  
  418.  
  419.  
  420.  
  421.      AViewCom v6.5
  422.      AViewCom v6.5                                                       7
  423.  
  424.      SYNTAX
  425.      ------
  426.      AViewCom ? or /? or /h or /ho
  427.  
  428.      ?    If first and only parameter, displays syntax help screen.
  429.      In the arcview mode, AViewCom accepts the following parameters on
  430.      the command line.  Each is detailed below.
  431.  
  432.      AViewCom file [port] [-a#] [-b#] [-c] [-d] [-e#] [-f] [-i] [-l] [-n#]
  433.                           [-o#] [-p{tpath}] [-q] [-r#] [-s{pwd}] [-t#] [-u]
  434.                           [-v] [-w] [-z]
  435.  
  436.      file is a required parameter.  If omitted, there must be no other
  437.           parameters on the command line and the caller will be prompted
  438.           for a file to an archive file.  file is any valid DOS pathname to
  439.           the file to be viewed.  The archive extension is optional and is
  440.           added if not included.  Some BBS's such as WildCat! pass the file
  441.           as a DOS parameter.  WildCat! uses %1.  If the character '*' use
  442.           used as file, other options may be specified and the caller will
  443.           be prompted for a file to view.  file may also be a filelist of
  444.           files to view if preceeded with an '@'.  eg @file.lst.
  445.  
  446.      port is either 'com#' or 'local' where # is from 1 to 22 This is an
  447.           optional parameter and defaults to local.  If neither of these
  448.           are specified, local mode is entered and no transmission is sent
  449.           to the comm port.  In this manner, AViewCom may be run in the
  450.           local mode.
  451.  
  452.      -a#  is an optional parameter where # either 0, 1, or 2:
  453.  
  454.                0 = no ANSI.  In this mode, all display is MONO.
  455.                1 = ANSI color.  All display is in ANSI color.
  456.                2 = prompt caller for ANSI color or not (default).
  457.  
  458.           For WildCat systems, this parameter is not needed if the -w
  459.           switch is used, since this information will be read from DOOR.SYS
  460.           (registered version only).
  461.  
  462.      -b#  4 digit hexidecimal comm port base address.  This option is
  463.           included if for some reason the information cannot be read from
  464.           another source.  For example: -b02E8.
  465.  
  466.      -c   If -c is included on the command line, AViewCom will read options
  467.           from AVIEWCOM.CNF file.  If an asterisk is entered as the
  468.           filename, AViewCom will search through directories that are
  469.           listed after the #search command in the AVIEWCOM.CNF file.  This
  470.           option is included for non-WildCat systems which do not pass the
  471.           filename to view as a DOS parameter.
  472.  
  473.      -d   disables the download option.  This is included for those systems
  474.           which prefer not to allow downloading.  If not included,
  475.           downloading is enabled and external protocol programs must be
  476.           somewhere in the DOS path.
  477.  
  478.  
  479.  
  480.  
  481.  
  482.      AViewCom v6.5
  483.      AViewCom v6.5                                                       8
  484.  
  485.      -e#  Used to specify an archiver where # is as follows:
  486.  
  487.                0    pkarc (.COM or .EXE)        4    pkzip [default]
  488.                1    pkpak                       5    zoo
  489.                2    pak                         6    lha
  490.                3    arc                         7    arj
  491.  
  492.           If you use code 2, make sure that PAK.CNF is such that the
  493.           archive will not be deleted after extracting it.  The specified
  494.           extractor is also used to create the temporary archive which is
  495.           assigned the name AVIEWnnn.???.
  496.           Archiver versions supported (up to and including):
  497.  
  498.                PKXARC       v3.61               PKUNZIP    v2.04g
  499.                PKUNPAK      v3.61               ZOO        v2.10
  500.                PAK          v2.51               LHA        v2.13
  501.                ARC          v6.02               ARJ        v2.39d
  502.  
  503.           Please let me know if an archiver has a more current version.
  504.  
  505.      -f   Operate in Read Text mode instead of View Archive.  This option
  506.           is provided for systems which have a "Read Text" hook in their
  507.           menus and use AViewCom to "Read" the filename which is passed
  508.           as a parameter.  The file is checked to ensure it is an ASCII file.
  509.  
  510.      -i   comm port IRQ number.  The registered version of AViewCom reads
  511.           the comm port information including IRQ and port base address
  512.           from the environment.  The -i parameter is provided for systems
  513.           not using WildCat, or for the shareware version.
  514.  
  515.      -l   enables activity logging.  If this is included, AViewCom will
  516.           create and maintain an activity log called AVIEWmmm.LOG which
  517.           will contain dates and times of all arcviews and downloads that
  518.           occur.  The node number will replace mmm in the log name.
  519.  
  520.      -n#  is an optional parameter if omitted, defaults to no limit.  If #
  521.           is specified, it limits the maximum size of archive files created
  522.           for download to #.
  523.  
  524.      -o#  is an optional parameter if omitted, defaults to 0.  If # is
  525.           specified, it sets the node number for this door.  It is used to
  526.           select which log file to write to.  Values are from 0 to 999.
  527.  
  528.      -ptpath   is an optional parameter and if omitted, defaults to the
  529.           home directory where AViewCom.exe resides.  tpath is any valid DOS
  530.           path and specifies a temporary directory for the external extractor
  531.           to use when extracting files.  A useful tpath is a ramdrive.  The
  532.           '-p' indicates that a DOS pathname follows.
  533.  
  534.      -r#  Define the connection baud rate for file xfer calculations where
  535.           # is any valid baud rate.
  536.  
  537.      -spassword   Normally, no password is required for the local sysop to
  538.           drop to DOS (not the caller!).  If the -s parameter appears on the
  539.           command line with no password, then drop to DOS is disabled.  If
  540.           -spassword appears where password is any 15 character printable
  541.           character (case IS significant), then the local sysop will be
  542.      AViewCom v6.5
  543.      AViewCom v6.5                                                       9
  544.  
  545.           prompted for this password before they are allowed to drop to dos.
  546.           If an incorrect password is given, a log entry is made and drop
  547.           to DOS is not allowed.
  548.  
  549.      -t#  This parameter allows the SysOp to specify a maximum number of
  550.           minutes that the caller will be allowed to spend in a session of
  551.           AViewCom.  # is the number of minutes to be allowed.  In the
  552.           WildCat mode, the time allowed is read from DOOR.SYS.
  553.  
  554.           AViewCom computes file transfer times as if the file were
  555.           transfered at 95% efficiency.  If the caller does not have enough
  556.           time left for the file transfer, they will not be allowed to
  557.           download the file.
  558.  
  559.      -u   if included, instructs AViewCom to update the USERINFO.DAT file
  560.           which contains the number of files and kilobytes the caller
  561.           downloaded during the current session of AViewCom.
  562.                      
  563.           This option is available only for registered callers using
  564.           WildCat v3.n.  The ShareWare version AViewCom does NOT write any
  565.           information to USERINFO.DAT.
  566.  
  567.      -v   Disable direct screen writes.  AViewCom uses bios writes for
  568.           everything except saving the screen when dropping to DOS and
  569.           shelling out ext prots or any archiver/extractor.  Disabling
  570.           direct screen writes provides compatibility with programs like
  571.           DesqView and is not normally necessary.  Also, disabling direct
  572.           screen writes slows down the capture of the screen considerably.
  573.  
  574.      -w   Read the DOOR.SYS file for caller information.  With this option,
  575.           the DOOR.SYS file is read for caller information and the caller's
  576.           download ratio and number of downloaded kbytes are checked.  The
  577.           caller will not be able to download files if the ratio has
  578.           exceeded the values set for ratio limit.  If no limit is defined,
  579.           the upload/download ratio is set to 1:20.
  580.  
  581.           AViewCom will search the current directory for DOOR.SYS.  If you
  582.           CD to any other directory, you will need to copy this file to
  583.           that directory before calling AViewCom.
  584.  
  585.           This parameter is active ONLY in the registered version.
  586.  
  587.      -q   Disables prompt before shelling to external program while running
  588.           under a DesqView environment.  Use this if your system doesn't crash
  589.           when reading a text file and you are running DesqView.
  590.  
  591.      -z   This is a temporary parameter used to override LINE 30 in DOOR.SYS
  592.           which is incorrectly written by WildCat and sometimes causes
  593.           AViewCom to report that the user has exceeded the download kbyte
  594.           limit.  This bug exists in v3.00, v3.01, and v3.02 of WildCat.
  595.           Including this parameter on the command line will ZERO the caller's
  596.           DAILY DOWNLOAD KBYTES.  Therefore, if the caller has exceeded the
  597.           daily downlaod kbyte limit, AViewCom will still allow downloads.
  598.           However, the TOTAL KBYTE LIMIT is still in effect.  Note:  WildCat
  599.           v3.50 corrected this problem.
  600.  
  601.      AViewCom v6.5
  602.      AViewCom v6.5                                                      10
  603.      SETUP
  604.      -----
  605.      COMM PORTS
  606.      ----------
  607.      AViewCom will display the contents of an archive to the local console
  608.      and to COM1 through COM22 as specified on the command line. If no comm
  609.      port is specified, AViewCom enters the local mode and no output is
  610.      sent to the comm port.  Standard IRQ and Base Address are used for
  611.      comm ports 1 to 4.  Extended comm port numbers are assigned IRQ and
  612.      Base Address as listed below.  These defaults may be overridden on the
  613.      command line with the '-b' and '-i' parameters, or by specifying the
  614.      '-w' parameter on the command line and using the environment variables
  615.      for wildcat to specify the base address and irq number. Specifying
  616.      COM0: forces AViewCom to the local mode.
  617.           BASE, IRQ =    PORT #         BASE, IRQ =    PORT #
  618.           LOCAL          COM0           0x0368, 7 =    COM11
  619.           0x03F8, 4 =    COM1           0x0368, 9 =    COM12
  620.           0x02F8, 3 =    COM2           0x0278, 5 =    COM13
  621.           0x03E8, 4 =    COM3           0x03E8, 7 =    COM14
  622.           0x02E8, 3 =    COM4           0x03E8, 9 =    COM15
  623.           0x0378, 7 =    COM5           0x03E8, 5 =    COM16
  624.           0x0278, 9 =    COM6           0x02E8, 7 =    COM17
  625.           0x0368, 5 =    COM7           0x02E8, 9 =    COM18
  626.           0x0278, 7 =    COM8           0x02E8, 5 =    COM19
  627.           0x0378, 9 =    COM9           0x0268, 7 =    COM20
  628.           0x0378, 5 =    COM10          0x0268, 9 =    COM21
  629.                                         0x0268, 5 =    COM22
  630.      EXTRACTOR
  631.      ---------
  632.      AViewCom does not require any external programs to display the
  633.      filenames within the archive.  It does require an external extractor
  634.      to display text files and extract files for downloading. Before
  635.      displaying a text file, AViewCom makes a DOS call to an external
  636.      extractor which may be anywhere in the DOS path.  AViewCom examines
  637.      the archive extension to determine which extractor to use. The SysOp
  638.      may specify a temporary path to extract files to with the '-p'
  639.      parameter on the command line.  Review the '-e' command below for
  640.      further information on extractors.  Please be aware that the BBS
  641.      shells to AViewCom which shells to an extractor.
  642.      If AViewCom will display the archive contents, but will not display a
  643.      text file, then the trouble must be in shelling out to the extractor -
  644.      possibly not enough memory (different extractors require different
  645.      amounts of memory), or the archiver is not in the DOS path.
  646.      ANSI COLOR
  647.      ----------
  648.      AViewCom can display ANSI color.  If the '-a1' parameter is included
  649.      on the command line, the contents are displayed in color locally and
  650.      to the remote caller.  If ANSI is selected, an ANSI device driver is
  651.      required for the host computer.  However, a color monitor is not
  652.      required.  You must have a line in your CONFIG.SYS file resembling the
  653.      following:
  654.                DEVICE=C:\DOS\ANSI.SYS
  655.  
  656.      If an ANSI driver is not installed and ANSI is selected the display
  657.      will be cluttered with ANSI escape sequences. When running under
  658.      DesqView, you need to install the DesqView ANSI driver (DVANSI.COM) by
  659.      calling it from the batch file that starts up WildCat.  Please refer
  660.      to your DesqView manual for info on DVANSI.COM.
  661.      AViewCom v6.5
  662.      AViewCom v6.5                                                      11
  663.  
  664.      PROTOCOL DEFINITION FILE
  665.      ------------------------
  666.      AViewCom will allow BBS callers to download any file that is contained
  667.      within an archive file.  AViewCom makes a DOS call to external
  668.      protocols which may be anywhere in the DOS path (including the current
  669.      directory).  External protocols can be specified in the file
  670.      AVIEWCOM.PRO which is included with a few standard protocols. The file
  671.      is then extracted to the current directory or temporary path,
  672.      transfered, and deleted.  However, if the file already exists before
  673.      the call to the protocol, it is sent, but not deleted. Including '-d'
  674.      on the command line disables the downloading feature.  If the caller
  675.      has marked several files for downloading, AViewCom will extract these
  676.      files and archive them into a temporary file called AVIEWnnn.??? using
  677.      the default archiver PKZIP, and nnn is a number chosen to distinguish
  678.      temporary filenames.  An archiver other than PKZIP may be specified
  679.      with the '-e' option.
  680.  
  681.      AVIEWCOM.PRO:  This file defines the command line switches to be used
  682.      with external protocols.  Each line in the file is a definition for
  683.      different protocols.  Every line MUST follow the following format:
  684.  
  685.      Title,key,pathname,args
  686.  
  687.      Title     =  Protocol name displayed to the caller (spaces okay).
  688.      key       =  Letter designation entered by caller during selection
  689.      pathname  =  External Protocol Filename.  This may be as simple as "dsz"
  690.                   or may contain the extension "dsz.exe" or may also contain
  691.                   the full pathname "c:\util\dsz.exe".
  692.      progname  =  name of the program without the path, for example "dsz"
  693.      args      =  command line arguements passed to the external protocol to
  694.                   specify the type of file transfer.  This may be any number
  695.                   of switches which MAY be include spaces.
  696.  
  697.      Parameters
  698.      ----------
  699.  
  700.      %1 = comm port number
  701.      %2 = ADDR,IRQ (eg 3E8,1) base address and irq number of comm port
  702.      %3 = filename
  703.      %4 = baud rate
  704.  
  705.      The comm port number is passed as %1.  The ADDR,IRQ numbers are passed
  706.      as %2 in the form compatible with that required by the DSZ PORTX
  707.      parameter.  For example "3E8,1" for com3. These fields MUST be
  708.      separated by one comma and NO spaces!  Any other format will cause
  709.      unpredictable results!  Please refer to the AVIEWCOM.PRO file included
  710.      as an example.  The filename is always provided automatically as the
  711.      last arguement passed to the external protocol.  You MUST include comm
  712.      port number!  The filename to be transfered is passed as %3.  If %3 is
  713.      omitted, then the filename will be appended to the end of the parameter
  714.      list.
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.      AViewCom v6.5
  722.  
  723.      AViewCom v6.5                                                      12
  724.  
  725.      CONFIGURATION FILE
  726.      ------------------
  727.      The text file AVIEWCOM.CNF is provided for NON-WILDCAT systems, but
  728.      may also be used by WildCat systems and may be edited with any ASCII
  729.      editor.  The options are outlined in AVIEWCOM.DOC and a sample
  730.      AVIEWCOM.CNF file is provided.
  731.  
  732.      If the file AVIEWCOM.CNF exists, options will be read from a
  733.      configuration file.  The configuration file may contain ';' to
  734.      indicate comments.  The rest of the line after the ';' is ignored.
  735.      Lines beginning with '#' are command lines. 
  736.      Recognized commands are:
  737.              #search                   ;search directories
  738.              #paths                    ;paths to search
  739.              #port                     ;com port
  740.              #video                    ;ANSI or MONO
  741.              #temporary                ;extracting directory
  742.              #extractor                ;type of extractor
  743.              #nodownload               ;disables downloading
  744.              #log                      ;enables activity log
  745.              #timelimit                ;max minutes allowed
  746.              #update                   ;update USERINFO.DAT
  747.              #wildcat                  ;read DOOR.SYS
  748.      After each command line, another line begins containing options for
  749.      the last command.  The paths command is used to specify directories to
  750.      search for the requested archive file.  There is no limit to the
  751.      number of directories which may be searched.  See the included
  752.      AVIEWCOM.CNF file for further information.
  753.  
  754.      PRIORITY
  755.      --------
  756.      AViewCom will accept options from (low to high priority):
  757.  
  758.              lowest:    1)  defaults
  759.                         2)  the command line
  760.                         3)  DOOR.SYS (port, ansi, timelimit only)
  761.                         4)  wildcat configuration (environment SET)
  762.              highest:   5)  a text configuration file    (AVIEWCOM.CNF)
  763.  
  764.      The lowest priority option settings are overwritten by the highest
  765.      option settings.  If you don't need the AVIEWCOM.CNF file, delete it. 
  766.      Most systems can do without it.  It is mainly included for non-WildCat
  767.      systems to list directories to search for the file. For WildCat
  768.      systems, you should be able to list all of the options you need on the
  769.      command line.
  770.  
  771.      Update User's Information
  772.      -------------------------
  773.      AViewCom will now save information on the caller's downloading
  774.      activity.  If the caller has downloaded anything, the number of
  775.      downloads and the download kbytes are saved in a file called
  776.      USERINFO.DAT which is used by WildCat to update the user databases.
  777.  
  778.      There are 2 types of information that are updated:
  779.  
  780.              Downloads        (Line 17)
  781.              Download Kbytes  (Line 18)
  782.      AViewCom v6.5
  783.  
  784.      AViewCom v6.5                                                      13
  785.  
  786.      Installing your Registration Number
  787.      -----------------------------------
  788.  
  789.      If you have registered AViewCom, you will receive a registration
  790.      number which will appear on your diskette label, and on the receipt
  791.      you receive from Cygnus Data Systems.  Use this number with the
  792.      registration program included on the distribution diskette.  If you do
  793.      not have this program, and you have registered AViewCom, you may call
  794.      my BBS listed at the end of this document and download it. If you do
  795.      not have an account on my BBS, I will first have to validate your
  796.      account and give you access to the registered directory.  You may then
  797.      use this same program to install your registration number into all
  798.      future releases of AViewCom.
  799.  
  800.      These functions are enabled when AViewCom is registered:
  801.  
  802.      1)   A "Registered to" message is displayed with your BBS name
  803.      2)   The User Update function
  804.      3)   Will read WCPORTID, WCIRQID, WCBASEID from environment
  805.      4)   Will read DOOR.SYS and USERINFO.DAT files
  806.      5)   Will remove "Please register" message upon exiting
  807.      6)   Will enable the SysOp functions
  808.  
  809.      Please note:  WildCat v3.00 incorrectly writes line 30 of DOOR.SYS
  810.      which should the user's daily download kbyte total.  It instead writes
  811.      the same value as in line 48 which is total download kbytes (from day
  812.      one!).  This WildCat bug may cause AViewCom to give the message
  813.      "Sorry, you have exceeded your daily download ratio".
  814.  
  815.      EXIT CODE
  816.      ---------
  817.  
  818.      A DOS errorlevel of 1 is returned when an error in command line
  819.      parameters is encountered, or upon any error during execution.
  820.  
  821.      AViewCom monitors carrier detect and returns a DOS errorlevel of 2
  822.      upon loss of carrier detect.  It also monitors keyboard inactivity. 
  823.      If no keyboard activity occurs for 3 minutes while waiting at a
  824.      prompt, AViewCom exits with a DOS errorlavel of 3.
  825.  
  826.      CREDITS & ACKNOWLEDGEMENTS
  827.      --------------------------
  828.  
  829.      AViewCom was inspired by the ArcView function in Perspective Data
  830.      Systems by Carey Nash.  Original versions used his code, but have
  831.      since been replaced by my own.  The ShareWare version may be freely
  832.      distributed but may not be sold for any reason. The registered version
  833.      may NOT be distributed and may only be used on one system per
  834.      registration.
  835.  
  836.      The comm port communications are interrupt driven.  The original
  837.      interrupt request vector is saved and replaced with a local interrupt
  838.      service routine.  The original ISR is replaced on exit.
  839.  
  840.      "This product uses the SPAWNO routines by Ralf Brown to minimize memory
  841.      use while shelling to DOS and running other programs."
  842.  
  843.      AViewCom v6.5
  844.      AViewCom v6.5                                                      14
  845.  
  846.      To register your copy of AViewCom, print the file ORDER.FRM.  You may
  847.      wish to use your editor to fill in the blanks before printing the
  848.      form.  If you choose to register AViewCom, you will receive the latest
  849.      version of the program, and a laser printed manual. In addition, I will
  850.      be able to continue to support AViewCom and provide additional features
  851.      and enhancements.  See future below.
  852.  
  853.                    Daniel Durbin
  854.                    14027 NE 181st Street #B-103
  855.                    Woodinville, WA
  856.                    98072-6846
  857.                    (206) 481-3484 (voice)
  858.                    (206) 481-9582 (bbs/fax) ZyXel U-1496e+ v.32b/v.42b
  859.                    FidoNet 1:343/181
  860.  
  861.  
  862.      DISCLAIMER
  863.      ----------
  864.      THIS PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  865.      EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
  866.      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 
  867.      THE AUTHOR WILL NOT BE LIABLE TO USERS OF THIS PROGRAM FOR ANY
  868.      DAMAGES, INCLUDING LOST PROFITS OR LOST SAVINGS OR OTHER INCIDENTAL OR
  869.      CONSEQUENTIAL DAMAGES, ARISING OUT OF USE OF THIS PROGRAM.
  870.  
  871.      BUGS and LIMITATIONS
  872.      --------------------
  873.  
  874.      FUTURE
  875.      ------
  876.  
  877.      All suggestions are welcome and encouraged and may be mailed, emailed
  878.      or phoned to me anytime.  This is a continuation of AViewCom and many
  879.      enhancements and improvements will be added and supported. I thank all
  880.      those who have given me feedback and encouragement.
  881.  
  882.      * An optional menu file supporting WildCat control codes.
  883.  
  884.      * Support for the Maximus CBCS Compress.cfg file
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.      Daniel Durbin______________________________________________
  897.      SysOp: Cygnus X-1 BBS, Woodinville, WA | CIS: 73447,1744
  898.      (206) 481-9582 (bbs/fax) v32b/v42b     | GEnie: D.DURBIN
  899.      (206) 481-3484 (voice evenings)        | FidoNet 1:343/181
  900.      daniel.durbin@f181.n343.z1.fidonet.org | 
  901.  
  902.  
  903.      AViewCom v6.5