home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / ka9qdr12.zip / KA9QDOOR.DOC < prev    next >
Text File  |  1994-05-31  |  37KB  |  1,203 lines
  1.  
  2.  
  3.         
  4.  
  5.  
  6.                                   KA9QDOOR (tm)
  7.  
  8.                      Provides a Full TCP/IP Internet Gateway
  9.                                        by
  10.                        Runnning KA9Q NOS as a PCBoard DOOR
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                    Version 1.2
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.                               Copyright (C) 1990-94
  31.                                All Rights Reserved
  32.  
  33.  
  34.                                        by
  35.  
  36.  
  37.                               KEY SOFTWARE PRODUCTS
  38.  
  39.                                 440 Ninth Avenue
  40.                         Menlo Park, California 94025-1802
  41.                                   415-364-9847
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.                 KA9QDOOR is a trademark of Key Software Products.
  53.             PCBoard is a trademark of Clark Development Corporation.
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.         
  61.  
  62.  
  63.                                 TABLE OF CONTENTS
  64.  
  65.  
  66.  
  67.         CHAPTER 1 - INTRODUCTION        ...........................    1
  68.  
  69.         CHAPTER 2 - CONFIGURING KA9Q NOS (NET.EXE)     ............    3
  70.  
  71.         CHAPTER 3 - CONFIGURING THE PCBOARD DOOR COMMAND    .......    5
  72.  
  73.         CHAPTER 4 - CONFIGURING KA9QDOOR       ....................    6
  74.            4.1  Registration Information       ....................    6
  75.               4.1.1  Registered Owner       .......................    6
  76.               4.1.2  Access Key       .............................    6
  77.            4.2  Options related to NET.EXE     ....................    6
  78.               4.2.1  Program Filespec       .......................    6
  79.               4.2.2  Configuration Filespec       .................    7
  80.               4.2.3  Termination String       .....................    7
  81.            4.3  Operating Limits       ............................    7
  82.               4.3.1  Time Limit       .............................    8
  83.               4.3.2  Inactivity Limit       .......................    8
  84.               4.3.3  Minimum Baud Rate      .......................    8
  85.               4.3.4  Operating Hours       ........................    8
  86.            4.4  Display Files       ...............................    9
  87.               4.4.1  Startup Message       ........................    9
  88.               4.4.2  Time Limit Message      ......................    9
  89.               4.4.3  Inactivity Message       .....................    9
  90.               4.4.4  Low Speed Message      .......................   10
  91.               4.4.5  Operating Hours Message      .................   10
  92.            4.5  Log Files       ...................................   10
  93.  
  94.         CHAPTER 5 - CUSTOMIZING THE DISPLAY FILES     .............   12
  95.            5.1  PCBoard Display Macros      .......................   12
  96.            5.2  Macros Unique to KA9QDOOR     .....................   12
  97.            5.3  Justification and Spacing      ....................   12
  98.               5.3.1  No Justification       .......................   13
  99.               5.3.2  Left Justification       .....................   13
  100.               5.3.3  Center Justification       ...................   13
  101.               5.3.4  Right Justification       ....................   13
  102.            5.4  The DISPLAY Program      ..........................   13
  103.  
  104.         APPENDIX 1 - HOW TO REACH US     ..........................   15
  105.  
  106.         APPENDIX 2 - RETRIEVING FILES FROM KEY SOFTWARE PRODUCTS      17
  107.  
  108.         APPENDIX 3 - LIMITED WARRANTY       .......................   18
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.         
  121.  
  122.  
  123.  
  124.         May 31, 1994              KA9QDOOR (tm)                         1
  125.  
  126.  
  127.                         CHAPTER 1 - INTRODUCTION        
  128.  
  129.  
  130.         Many  BBS's  now offer E-Mail access to the Internet.  But few if
  131.         any  offer  a real TCP/IP connection.  As compared to mere E-Mail
  132.         access,  providing a TCP/IP connection opens up a large number of
  133.         new  possibilities  to  callers,  such  as  the ability to remote
  134.         login  to Internet hosts in foreign countries using Telnet, or to
  135.         access  files  on  those  hosts  using  FTP,  or  to  search  for
  136.         information   using   Gopher,  Archie,  and  the  new  multimedia
  137.         hypertext browser, Mosaic.  
  138.  
  139.         KA9QDOOR  (together  with  the  KA9Q  NOS  program) establishes a
  140.         logical  two-way  connection  between  the user's serial line and
  141.         the Internet: 
  142.  
  143.                             +----------+     |
  144.                User's       |          |     | Local Area Network
  145.                Modem <----->| KA9QDOOR |<----+ connected to the
  146.                             |          |     | Internet
  147.                             +----------+     |
  148.                             BBS Machine
  149.  
  150.         As  indicated,  the  physical  connection between the BBS machine
  151.         and  the  Internet  is  usually  by  means  of  an  Ethernet card
  152.         attached  to  a  local  area  network  that  is  attached  to the
  153.         Internet.   However,  this  connection  could instead be simply a
  154.         separate   modem  connection  to  a  commercial  Internet  access
  155.         provider, such as NETCOM.  
  156.  
  157.         TCP/IP  encapsulates  data in packets and transfers those packets
  158.         according  to  specific  communication  protocols.  This requires
  159.         that  data on the serial line between the BBS and the caller must
  160.         obey  one of two popular serial protocols: either the Serial Link
  161.         Internet  Protocol  (SLIP)  or the Point-to-Point Protocol (PPP).
  162.         Thus  the  gateway  software (running in the BBS machine) and the
  163.         "client"  software  running  on  the  caller's machine) must both
  164.         support SLIP and/or PPP protocols.  
  165.  
  166.         The  freeware  KA9Q  NOS  program  (NET.EXE)  can  be used as the
  167.         gateway  software,  and  supports  both  SLIP  and PPP protocols.
  168.         However,  since NET was designed to run as a stand-alone program,
  169.         and not with a BBS, it does not: 
  170.  
  171.              1.  Terminate when user's time limit expires.  
  172.              2.  Terminate when user hangs up.  
  173.              3.  Terminate  when there's no activity for some period
  174.                      of time.  
  175.              4.  Record termination in PCBoard log file.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  182.  
  183.  
  184.         May 31, 1994              KA9QDOOR (tm)                         2
  185.  
  186.  
  187.              5.  Provide  colorized  or  parameterized  messages  to
  188.                      user.  
  189.              6.  Restrict users by baud rate.  
  190.              7.  Restrict hours of operation.  
  191.  
  192.         KA9QDOOR  was  designed to solve these limitations.  It runs as a
  193.         PCBoard  BBS  door  command,  and  loads  and  executes NET while
  194.         providing  all  the  missing services listed above.  While NET is
  195.         running,  KA9QDOOR  is  constantly  checking to see if the user's
  196.         time  has  expired, if he hung up the phone, or if he's inactive.
  197.         In   any  of  these  situations,  KA9QDOOR  stuffs  the  keyboard
  198.         typeahead  buffer  with  a  command  that  terminates  NET  in  a
  199.         graceful manner.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  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.  
  241.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  242.  
  243.  
  244.         May 31, 1994              KA9QDOOR (tm)                         3
  245.  
  246.  
  247.                  CHAPTER 2 - CONFIGURING KA9Q NOS (NET.EXE)     
  248.  
  249.  
  250.         Most  of  the  hard work in setting up the gateway is configuring
  251.         KA9Q  NOS (NET).  We strongly suggest that begin by trying to get
  252.         NET  running stand alone.  That will probably be about 90% of the
  253.         work;  setting  up  the door using KA9QDOOR is relatively trivial
  254.         by comparison.  
  255.  
  256.         This  document  is  not intended to teach you about NET; you will
  257.         definitely  need  to  obtain  a copy of the documentation for NET
  258.         (see   Appendices).    However,  we've  included  a  file  called
  259.         AUTOEXEC.NET  that  is a sample configuration file to operate NET
  260.         as  a SLIP to Ethernet gateway.  A similar file could be prepared
  261.         to implement a PPP to Ethernet gateway if you prefer.  
  262.  
  263.         Although  the specific parameters in this file are ficticious (to
  264.         protect  the  system it came from), it is STRONGLY recommend that
  265.         you  follow  the  example, changing only the parameters indicated
  266.         as in 
  267.  
  268.                 ip address 130.253.15.148
  269.                 #          ^^^^^^^^^^^^^^
  270.  
  271.         and NOT the number or order of the commands.  
  272.  
  273.         There  are  two  reasons why it's important to use NET's built-in
  274.         SLIP  or  PPP  serial  port drivers ("attach asy") rather than an
  275.         external packet driver.   
  276.  
  277.         First,  a packet driver is usually installed as a TSR and thus is
  278.         resident  while  PCBoard is running; this usually interferes with
  279.         regular  operation  of PCBoard.  (The built-in drivers of NET are
  280.         only  resident  while  NET  is running, and thus cannot interfere
  281.         with PCBoard.) 
  282.  
  283.         Second,  KA9QDOOR  automatically  scans  NET's configuration file
  284.         and  sets  the  baud  rate  used by NET to the same value used by
  285.         PCBoard.   It  does this by searching for an "attach asy" command
  286.         that  specifies the same serial port base address as that used by
  287.         PCBoard.  
  288.  
  289.         You'll  probably  need  the help of the network administrator who
  290.         takes  care  of  your local area network.  They'll need to assign
  291.         an  Internet  style  name to your BBS and at least three Internet
  292.         IP  addresses  to  you:  one for the Ethernet card in the BBS and
  293.         two  for  the  two ends of the serial (SLIP) link - i.e., one for
  294.         the  BBS itself and another for the caller.  You'll need to check
  295.         with  this  same  person  to get the IP address of your network's
  296.         name  server  and  router,  as  well  as their help regarding the
  297.         "netmask", "route", "rip", and "arp" entries.  
  298.  
  299.  
  300.  
  301.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  302.  
  303.  
  304.         May 31, 1994              KA9QDOOR (tm)                         4
  305.  
  306.  
  307.  
  308.         You   may  also  need  to  modify  the  "attach  packet"  command
  309.         according  to  the  software  interrupt  vector  you use for your
  310.         Ethernet  card's  packet  driver,  and  the  "attach asy" command
  311.         according  to  the base address, interrupt vector, and DTE (PC to
  312.         modem) baud rate of your BBS's modem.  
  313.  
  314.         Don't  expect  that  coming up with all the right parameters will
  315.         be  easy.   And be sure to obtain a copy of the documentation for
  316.         the  NET  program  you're  using  -  it  (and a competent network
  317.         administrator) are the best (and only) resources to work from.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  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.  
  360.  
  361.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  362.  
  363.  
  364.         May 31, 1994              KA9QDOOR (tm)                         5
  365.  
  366.  
  367.               CHAPTER 3 - CONFIGURING THE PCBOARD DOOR COMMAND    
  368.  
  369.  
  370.         To  run  KA9QDOOR as a PCBoard door, you must create a batch file
  371.         (without  the  ".BAT" extension) that contains the commands to be
  372.         performed.   For  KA9QDOOR,  this  is  trivial.   The file should
  373.         contain simply 
  374.  
  375.                  C:\KA9QDOOR\KA9QDOOR <filespec>
  376.                  BOARD
  377.  
  378.         where   "<filespec>"   specifies   the   location  of  KA9QDOOR's
  379.         configuration file (described in the next chapter).   
  380.  
  381.         Do  NOT  add  commands  to  the  door  batch file that change the
  382.         default  drive  or directory before KA9QDOOR runs.  It expects to
  383.         find  the  files  PCBOARD.DAT,  PCBOARD.SYS, and USERS.SYS in the
  384.         same  drive  and  directory  that  PCBoard  is  in  when the door
  385.         command begins executing.  
  386.  
  387.         If  the  name  of  the  door  batch  file  is  "SLIP",  then  the
  388.         corresponding entry in the PCBoard setup should be: 
  389.  
  390.                                       USER DOOR
  391.           Filename Password Sec Login SYS  SYS  Shell Path to DOOR Files
  392.           -------- -------- --- ----- ---  ---  ----- ------------------
  393.           SLIP                0   N    Y    N     N   C:\KA9QDOOR
  394.  
  395.         Of  course you may change some of the above settings, but be sure
  396.         to  enter  "Y"  under  the  "USER.SYS"  column, and "N" under the
  397.         "DOOR.SYS"  column.   For  further  details,  please refer to the
  398.         PCBoard documentation.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  422.  
  423.  
  424.         May 31, 1994              KA9QDOOR (tm)                         6
  425.  
  426.  
  427.                      CHAPTER 4 - CONFIGURING KA9QDOOR       
  428.  
  429.  
  430.         KA9QDOOR  requires  a  single command line argument, which is the
  431.         name  of its configuration file.  This is a text file of options,
  432.         one  per  line.   Each option consists of a keyword followed by a
  433.         separator  and  a  string.   Blank lines and lines beginning with
  434.         anything  other  than  a  letter  are considered comments and are
  435.         ignored.   Any  character  can serve as a separator; we recommend
  436.         either an equals sign (=) or a colon (:).  
  437.  
  438.  
  439.         4.1 Registration Information        
  440.  
  441.         The  unlicensed  version of KA9QDOOR imposes a maximum time limit
  442.         of  ten  minutes per session.  To eliminate this restriction, you
  443.         must  purchase an access key from Key Software Products.  The key
  444.         is  derived  from your name; both your name and the corresponding
  445.         key   must  be  entered  as  options  to  remove  the  unlicensed
  446.         restrictions.  
  447.  
  448.  
  449.         4.1.1 Registered Owner        
  450.  
  451.          Syntax: owner=<your name> 
  452.  
  453.         Example: owner=John Doe 
  454.  
  455.         Purpose: Specifies  the  name  used when you obtained your access
  456.                  key  by  registering  KA9QDOOR.   KA9QDOOR behaves as an
  457.                  unlicensed version if omitted.  
  458.  
  459.  
  460.         4.1.2 Access Key        
  461.  
  462.          Syntax: key=<character sequence> 
  463.  
  464.         Example: key=12345678 
  465.  
  466.         Purpose: Specifies   the   access   key  you  obtained  when  you
  467.                  registered  KA9QDOOR.  KA9QDOOR behaves as an unlicensed
  468.                  version if omitted.  
  469.  
  470.  
  471.         4.2 Options related to NET.EXE      
  472.  
  473.         The  following options specify information needed to run the KA9Q
  474.         NOS program (NET.EXE).  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  482.  
  483.  
  484.         May 31, 1994              KA9QDOOR (tm)                         7
  485.  
  486.  
  487.         4.2.1 Program Filespec        
  488.  
  489.          Syntax: filespec=<program filespec> 
  490.  
  491.         Example: filespec=c:\bin\net.exe 
  492.  
  493.         Purpose: Specifies  the  name and location of the executable file
  494.                  image of the NET.EXE program.  Required.  
  495.  
  496.  
  497.         4.2.2 Configuration Filespec        
  498.  
  499.          Syntax: cmdtail=<configuration filespec> 
  500.  
  501.         Example: cmdtail=c:\slip\autoexec.net 
  502.  
  503.         Purpose: Specifies  the  command  line  options  for  the NET.EXE
  504.                  program.   Required;  the last option in the string must
  505.                  be  the  filespec  specifying  the  name and location of
  506.                  NET's configuration file.  
  507.  
  508.  
  509.         4.2.3 Termination String        
  510.  
  511.          Syntax: stuffkeyboard=<string> 
  512.  
  513.         Example: stuffkeyboard=exit<cr> 
  514.  
  515.         Purpose: Specifies  the  keyboard sequence to be stuffed into the
  516.                  keyboard   type  ahead  buffer  in  order  to  terminate
  517.                  NET.EXE.  Required.  
  518.  
  519.                  Since  KA9QDOOR was designed to be as general-purpose as
  520.                  possible,  there  are  several  rather  obvious "macros"
  521.                  (such  as  the  "<cr>"  in "exit<cr>" above) that can be
  522.                  used to represent special keystrokes, as follows: 
  523.  
  524.                  <pgdn>          <pgup>          <home>          <end>
  525.                  <del>           <ins>           <esc>           <escape>
  526.                  <left>          <right>         <up>            <down>
  527.                  <bs>            <backspace>     <cr>            <enter>
  528.                  <return>        <tab>
  529.  
  530.                  and <f1> through <f12>
  531.  
  532.  
  533.         4.3 Operating Limits        
  534.  
  535.         The  following  options control various operating limits that are
  536.         monitored while NET.EXE is running: 
  537.  
  538.  
  539.  
  540.  
  541.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  542.  
  543.  
  544.         May 31, 1994              KA9QDOOR (tm)                         8
  545.  
  546.  
  547.  
  548.         4.3.1 Time Limit        
  549.  
  550.          Syntax: maxminutes=<number> 
  551.  
  552.         Example: maxminutes=30 
  553.  
  554.         Purpose: Overrides  the time remaining as specified by PCBoard if
  555.                  lower.   If omitted, time remaining is that specified by
  556.                  PCBoard.  
  557.  
  558.  
  559.         4.3.2 Inactivity Limit        
  560.  
  561.          Syntax: idleminutes=<minutes>,<packet vector> 
  562.  
  563.         Example: idleminutes=10,96 
  564.  
  565.         Purpose: Establishes  an  upper limit on how long the session can
  566.                  remain  inactive  before it is terminated.  It does this
  567.                  by  monitoring  calls  to  the  (Ethernet) packet driver
  568.                  through  its  API  -  a  software interrupt known as the
  569.                  "packet  vector",  specified  as  a  decimal number.  If
  570.                  omitted, no inactivity limit is imposed.  
  571.  
  572.  
  573.         4.3.3 Minimum Baud Rate       
  574.  
  575.          Syntax: mindcespeed=<baudrate>[,<security>] 
  576.  
  577.         Example: mindcespeed=9600 
  578.  
  579.         Example: mindcespeed=9600,100 
  580.  
  581.         Purpose: Specifies  a  minimum  baud  rate  required  to  use the
  582.                  gateway,  and  an  optional  security  level required to
  583.                  override  the minimum baud rate.  If omitted, no minimum
  584.                  baud rate will be required.  
  585.  
  586.  
  587.         4.3.4 Operating Hours        
  588.  
  589.          Syntax: ophours=<hh:mm-hh:mm> 
  590.  
  591.         Example: ophours=21:00-23:00 
  592.  
  593.         Purpose: To  establish  the  hours  of operation for the gateway;
  594.                  attempts  to  use  the  gateway  at  other times will be
  595.                  disallowed.    Times   must  be  specified  in  24  hour
  596.                  format.   If  omitted,  the  gateway  may be used at any
  597.                  time.  
  598.  
  599.  
  600.  
  601.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  602.  
  603.  
  604.         May 31, 1994              KA9QDOOR (tm)                         9
  605.  
  606.  
  607.  
  608.  
  609.         4.4 Display Files        
  610.  
  611.         KA9QDOOR  sends  the  following  display  files  to  the  user as
  612.         indicated.   Each file may be customized with special "macros" to
  613.         colorize  the  display  files or with macros that are replaced by
  614.         user-specific  or  configuration-specific  information.   See the
  615.         following chapter for a complete list of supported macros.  
  616.  
  617.  
  618.         4.4.1 Startup Message        
  619.  
  620.          Syntax: startupmsg=<filespec> 
  621.  
  622.         Example: startupmsg=c:\slip\startup.msg 
  623.  
  624.         Purpose: Specifies  the  location  of  a display file sent to the
  625.                  user  when  the  gateway is initialized.  If omitted, no
  626.                  display file is sent.  
  627.  
  628.  
  629.         4.4.2 Time Limit Message       
  630.  
  631.          Syntax: timeoutmsg=<filespec> 
  632.  
  633.         Example: timeoutmsg=c:\slip\timeout.msg 
  634.  
  635.         Purpose: Specifies  the  location  of  a display file sent to the
  636.                  user  if  the  session is terminated because it exceeded
  637.                  the time limit.  If omitted, no display file is sent.  
  638.  
  639.            Note: This  display  file  may be irrelevant, since it is sent
  640.                  as  raw  ascii, without any TCP/IP packaging.  I.e., the
  641.                  user may never see it! 
  642.  
  643.  
  644.         4.4.3 Inactivity Message        
  645.  
  646.          Syntax: idlemsg=<filespec> 
  647.  
  648.         Example: idlemsg=c:\slip\tooidle.msg 
  649.  
  650.         Purpose: Specifies  the  location  of  a display file sent to the
  651.                  user  if  the  session is terminated because it was idle
  652.                  for   more  than  the  number  of  minutes  set  by  the
  653.                  "idleminutes"  option  (described earlier).  If omitted,
  654.                  no display file is sent.  
  655.  
  656.            Note: This  display  file  may be irrelevant, since it is sent
  657.                  as  raw  ascii, without any TCP/IP packaging.  I.e., the
  658.  
  659.  
  660.  
  661.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  662.  
  663.  
  664.         May 31, 1994              KA9QDOOR (tm)                        10
  665.  
  666.  
  667.                  user may never see it! 
  668.  
  669.  
  670.         4.4.4 Low Speed Message       
  671.  
  672.          Syntax: lospeedmsg=<filespec> 
  673.  
  674.         Example: lospeedmsg=c:\slip\lospeed.msg 
  675.  
  676.         Purpose: Specifies  the  location  of  a display file sent to the
  677.                  user  if the his baud rate is less than that required by
  678.                  the   "mindcespeed"   option  (described  earlier).   If
  679.                  omitted, no display file is sent.  
  680.  
  681.  
  682.         4.4.5 Operating Hours Message       
  683.  
  684.          Syntax: ophoursmsg=<filespec> 
  685.  
  686.         Example: ophoursmsg=c:\slip\ophours.msg 
  687.  
  688.         Purpose: Specifies  the  location  of  a display file sent to the
  689.                  user  if  the  he  attempts  to use the gateway at other
  690.                  than   the  hours  specified  by  the  "ophours"  option
  691.                  (described  earlier).   If  omitted,  no display file is
  692.                  sent.  
  693.  
  694.  
  695.         4.5 Log Files        
  696.  
  697.         KA9QDOOR  automatically updates the PCBoard CALLER file, entering
  698.         the   termination   status   of   the  connection.   However  for
  699.         convenience,  you  may  request an additional separate log unique
  700.         to KA9QDOOR: 
  701.  
  702.          Syntax: ka9qdoorlog=<filespec> 
  703.  
  704.         Example: ka9qdoorlog=c:\slip\slip.log 
  705.  
  706.         Each  entry  in  the  log is a fixed-length 64 byte ascii record,
  707.         such as: 
  708.  
  709.         05-31-94 11:30 (32) Dan Lewis [User hung up] 
  710.  
  711.         The  number  in  parentheses  is the number of minutes the caller
  712.         spent in the door.  
  713.  
  714.         You  may create another PCBoard DOOR batch file to do nothing but
  715.         simply  view this log by adding the "/LOG" command line option as
  716.         shown below.  
  717.  
  718.  
  719.  
  720.  
  721.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  722.  
  723.  
  724.         May 31, 1994              KA9QDOOR (tm)                        11
  725.  
  726.  
  727.                  C:\KA9QDOOR\KA9QDOOR /LOG <filespec>
  728.                  BOARD
  729.  
  730.         where   "<filespec>"   specifies   the   location  of  KA9QDOOR's
  731.         configuration file.  
  732.  
  733.  
  734.  
  735.  
  736.  
  737.  
  738.  
  739.  
  740.  
  741.  
  742.  
  743.  
  744.  
  745.  
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  782.  
  783.  
  784.         May 31, 1994              KA9QDOOR (tm)                        12
  785.  
  786.  
  787.                  CHAPTER 5 - CUSTOMIZING THE DISPLAY FILES     
  788.  
  789.  
  790.         The distribution package includes five sample display files: 
  791.  
  792.            TOOIDLE.MSG     Displayed on hangup after long inactivity
  793.            OPHOURS.MSG     Displayed during off hours
  794.            STARTUP.MSG     Displayed on start of gateway session
  795.            LOSPEED.MSG     Displayed if baud rate is too low
  796.            TIMEOUT.MSG     Displayed on hangup when time runs out
  797.  
  798.         These   files   have  been  customized  by  the  use  of  certain
  799.         predefined  "macros".  Some of these macros are a subset of those
  800.         supported by PCBoard, while others are unique to KA9QDOOR.  
  801.  
  802.  
  803.         5.1 PCBoard Display Macros       
  804.  
  805.         The  following  PCBoard  display  macros,  plus  all of PCBoard's
  806.         "@X##"  color control macros, may be used within KA9QDOOR display
  807.         files.   For  a  description of what they represent, refer to the
  808.         PCBoard documentation.  
  809.  
  810.                     @BEEP@          @CLREOL@        @CLS@
  811.                     @FIRST@         @MINLEFT@       @SECURITY@
  812.                     @SYSDATE@       @SYSTIME@       @USER@
  813.                     @POS:#@
  814.  
  815.  
  816.         5.2 Macros Unique to KA9QDOOR      
  817.  
  818.         The  following  additional display file macros are also supported
  819.         by KA9QDOOR.  
  820.  
  821.                 @DCESPEED@              Current DCE (carrier) speed
  822.                 @DTESPEED@              Current DTE (PC-Modem) speed
  823.                 @EXPIRETIME@            Expire time in HH:MM format
  824.                 @IDLEMINS@              Maximum inactivity time
  825.                 @MINDCESPEED@           Minimum DCE (carrier) speed
  826.                 @OPHOURS@               Hours of operation
  827.                 @OVERRIDE@              Override security for mindcespeed
  828.  
  829.  
  830.         5.3 Justification and Spacing       
  831.  
  832.         Any  of  the text insertion macros used in KA9QDOOR display files
  833.         can  appear  in  one  of four forms as discussed in the following
  834.         paragraphs.    These  options  allow  you  to  precisely  control
  835.         spacing,  and  allow  you  to  draw a box around a message - even
  836.         when replacement text within a line has a varying length.  
  837.  
  838.  
  839.  
  840.  
  841.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  842.  
  843.  
  844.         May 31, 1994              KA9QDOOR (tm)                        13
  845.  
  846.  
  847.  
  848.         5.3.1 No Justification        
  849.  
  850.          Syntax: @<keyword>@ 
  851.  
  852.         Example: @USER@ 
  853.  
  854.         Purpose: Inserts  the  replacment  text, using as many columns as
  855.                  are necessary.  
  856.  
  857.  
  858.         5.3.2 Left Justification        
  859.  
  860.          Syntax: @<keyword>:<number>@ 
  861.              or: @<keyword>:<number>L@ 
  862.  
  863.         Example: @USER:15@ 
  864.              or: @USER:15L@ 
  865.  
  866.         Purpose: Insert  the  replacement text, left justifying it within
  867.                  a   field   whose  width  is  specified  by  the  number
  868.                  following  the colon.  If more columns are required than
  869.                  provided  in  the  field  width,  the field is expanded.
  870.                  macro.  
  871.  
  872.  
  873.         5.3.3 Center Justification        
  874.  
  875.          Syntax: @<keyword>:<number>C@ 
  876.  
  877.         Example: @USER:15C@ 
  878.  
  879.         Purpose: Insert  the  replacement  text,  centering  it  within a
  880.                  field  whose  width is specified by the number following
  881.                  the  colon.   If more columns are required than provided
  882.                  in the field width, the field is expanded.  
  883.  
  884.  
  885.         5.3.4 Right Justification        
  886.  
  887.          Syntax: @<keyword>:<number>R@ 
  888.  
  889.         Example: @USER:15R@ 
  890.  
  891.         Purpose: Insert  the replacement text, right justifying it within
  892.                  a   field   whose  width  is  specified  by  the  number
  893.                  following  the colon.  If more columns are required than
  894.                  provided in the field width, the field is expanded.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.  
  901.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  902.  
  903.  
  904.         May 31, 1994              KA9QDOOR (tm)                        14
  905.  
  906.  
  907.         5.4 The DISPLAY Program       
  908.  
  909.         Included  among  the distribution files is DISPLAY.EXE, a program
  910.         that  helps  design  a  display  file by allowing it to be viewed
  911.         offline.  The command line syntax is: 
  912.  
  913.                         DISPLAY [-a] [-g] [-7] <filespec>
  914.  
  915.         Where:  <filespec>   Is the name of the display file.
  916.                              The filename extension defaults
  917.                              to ".MSG" if omitted.
  918.  
  919.                 []           Denotes an optional argument.
  920.  
  921.                 -a           Disables ANSI escape sequences
  922.                              (and color graphics).  Default
  923.                              is enabled and requires ANSI.SYS
  924.                              to be installed.
  925.  
  926.                 -g           Disables (color) graphics but
  927.                              not ANSI control sequences.
  928.                              Default is enabled and requires
  929.                              ANSI.SYS to be installed.
  930.  
  931.                 -7           Replaces 8-bit graphics characters
  932.                              with suitable 7-bit alternatives.
  933.  
  934.         DISPLAY  uses  a  predefined  set  of replacement strings for the
  935.         various text insertion macros such as @USER@.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960.  
  961.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  962.  
  963.  
  964.         May 31, 1994              KA9QDOOR (tm)                        15
  965.  
  966.  
  967.                         APPENDIX 1 - HOW TO REACH US     
  968.  
  969.  
  970.         The  Key  Software Products telephone (415-364-9847) is shared by
  971.         our  BBS,  FAX,  and  voice  mail  answering system.  Approximate
  972.         hours of operation are: 
  973.  
  974.                   Voice mail and FAX: 8am - 5pm PST (weekdays)
  975.                  BBS system: 5pm - 8am PST (24 hrs on weekends)
  976.            BBS Parameters: 1200/2400/9600/14400 baud (v.32bis/v.42bis)
  977.                              8 data bits, No Parity
  978.  
  979.         If  your call is answered by the voice mail system, it can take a
  980.         message  that  will be automatically forwarded to someone who can
  981.         return  your  call as soon as possible.  In addition, it offers a
  982.         touch-tone driven menu of useful information about our product.  
  983.  
  984.         To send us a FAX, follow the following steps: 
  985.  
  986.              Step 1:  You'll  be  greeted  by  our Voice Mail system
  987.                       which  will  prompt you to press 1 if you have
  988.                       a touch-tone phone.  
  989.  
  990.              Step 2:  Press 1.  You'll then hear a menu that prompts
  991.                       you to press 5 to send a FAX.  
  992.  
  993.              Step 3:  Press  5.  In a few seconds, you'll hear a FAX
  994.                       tone; press start on your FAX machine.  
  995.  
  996.         That's  all  there  is to it.  Be sure to include your FAX number
  997.         for  the  reply  which  will  be  sent  back to you in one or two
  998.         days.  
  999.  
  1000.         If  you have access to electronic mail, you can send us a message
  1001.         via any of the following: 
  1002.  
  1003.         On COMPUSERVE, send mail to:
  1004.  
  1005.                 >Internet:tech.support@ksp.com
  1006.  
  1007.         On PRODIGY, send mail to: VGDC59A
  1008.  
  1009.         On INTERNET, UUCP, or BITNET, send mail to:
  1010.  
  1011.                 tech.support@ksp.com
  1012.  
  1013.         On FIDONET, address mail to "UUCP" at nearest fidonet site which
  1014.         provides a gateway to Internet, such as 1:105/42.
  1015.  
  1016.                 1st line of message: To: tech.support@ksp.com
  1017.  
  1018.  
  1019.  
  1020.  
  1021.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  1022.  
  1023.  
  1024.         May 31, 1994              KA9QDOOR (tm)                        16
  1025.  
  1026.  
  1027.         On MCI,
  1028.  
  1029.                  At the "To:" prompt enter: TECH SUPPORT (EMS)
  1030.                 At the "EMS:" prompt enter: Internet
  1031.                 At the "Mbx:" prompt enter: tech.support@ksp.com
  1032.  
  1033.         On APPLELINK, send mail to:
  1034.  
  1035.                 tech.support@ksp.com@dasnet#
  1036.  
  1037.         On TELENET's Telemail Service:
  1038.  
  1039.                 Send to: [INTERMAIL/USCISI]TELEMAIL/USA
  1040.                 1st line of message: Forward: ARPA
  1041.                 2nd line of message: To: tech.support@ksp.com
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.  
  1079.  
  1080.  
  1081.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  1082.  
  1083.  
  1084.         May 31, 1994              KA9QDOOR (tm)                        17
  1085.  
  1086.  
  1087.            APPENDIX 2 - RETRIEVING FILES FROM KEY SOFTWARE PRODUCTS   
  1088.  
  1089.  
  1090.         You  will  need  a  copy of NET.EXE and it's documentation.  Your
  1091.         callers  will  need  SLIP  software on their end as well, such as
  1092.         Trumpet  Winsock  (for  Microsoft  Windows)  or the packet driver
  1093.         SLIPPER or CSLIPPER.  
  1094.  
  1095.         These  files are available from the KSP BBS, either by calling in
  1096.         and  downloading, or via e-mail using the "LISTSERV" capabilities
  1097.         of  the  BBS;  we  do  NOT have "real" FTP capability in case you
  1098.         were wondering.  
  1099.  
  1100.         The relevant filenames on the Key Software Products BBS are: 
  1101.  
  1102.           KA9QNOS.ZIP:   KA9Q NOS network gateway software and docs.
  1103.           SLIPPR13.ZIP:  TCP/IP packet drivers for serial SLIP & CSLIP
  1104.           TWSK10A.ZIP:   Trumpet Winsock TCP/IP for Windows.
  1105.  
  1106.         Directions  for  calling  the  BBS  directly  are provided in the
  1107.         previous appendix.  
  1108.  
  1109.         To  use  LISTSERV,  you  must  send  a  message  addressed to the
  1110.         Internet  address  listserv@ksp.com.  The message must contain an
  1111.         LISTSERV  command  entered  as a single line of text, and it must
  1112.         be  the first line in the message. The LISTSERV commands that are
  1113.         supported include: 
  1114.  
  1115.         Command: LIST tlbmm-l
  1116.         Purpose: Returns an e-mail message listing all of the file directories
  1117.                  on the BBS by number and description.
  1118.  
  1119.         Command: LIST tlbmm-l 2
  1120.         Purpose: Returns an e-mail message listing all of the files in
  1121.                  directory #2 of the BBS.  (The files KA9QNOS.ZIP,
  1122.                  TWSK10A.ZIP, and SLIPPR13.ZIP are in directory #7
  1123.                  of the Key Software Products BBS.)
  1124.  
  1125.         Command: GET tlbmm-l KA9QDOOR.ZIP
  1126.         Purpose: Returns an e-mail message containing a uuencoded version of
  1127.                  the file KA9QDOOR.ZIP.  To extract the file, you must save
  1128.                  the message as a file on your system, edit out the e-mail
  1129.                  header at the beginning of the file, and then use a program
  1130.                  called UUDECODE (commonly available on Unix) to convert the
  1131.                  uuencoded version back to the original ZIP format, and then
  1132.                  (finally) use PKUNZIP to extract the contents of the file.
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.  
  1139.  
  1140.  
  1141.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  1142.  
  1143.  
  1144.         May 31, 1994              KA9QDOOR (tm)                        18
  1145.  
  1146.  
  1147.                       APPENDIX 3 - LIMITED WARRANTY       
  1148.  
  1149.  
  1150.         This  software  is provided 'as is' without warranty of any kind,
  1151.         either  expressed  or  implied, including, but not limited to the
  1152.         implied   warranties   of   merchantability  and  fitness  for  a
  1153.         particular  purpose.   The  entire  risk  as  to  the quality and
  1154.         performance of the program is with you.  
  1155.  
  1156.         Some  states do not allow the exclusion of implied warranties, so
  1157.         the  above  exclusions may not apply to you.  This warranty gives
  1158.         you  specific  legal  rights  and  you may also have other rights
  1159.         which vary from state to state.  
  1160.  
  1161.         Key  Software  Products  has  taken  due  care  in  preparing the
  1162.         documentation  and  software  included  in  KA9QDOOR to ascertain
  1163.         their  correctness  and  effectiveness.   However,  Key  Software
  1164.         Products  does  not  warrant that operation of this software will
  1165.         be  uninterrupted  or error free.  In no event shall Key Software
  1166.         Products  be  liable  for  incidental or consequential damages in
  1167.         connection  with  or  arising out of the furnishing, performance,
  1168.         or use of this software.  
  1169.  
  1170.  
  1171.                                      LICENSE
  1172.  
  1173.         You  MAY  use  this software on any computer or computers in your
  1174.         possession, but on no more than one computer at any given time.  
  1175.  
  1176.         You  MAY  copy this software into any machine readable or printed
  1177.         form  for  backup or modification purposes in support of your use
  1178.         of the software.  
  1179.  
  1180.         You  MAY  distribute  the original unmodified, unlicensed version
  1181.         of  this  software,  but you may not charge a fee exceeding $5.00
  1182.         to  cover  the  cost of duplicating, shipping, and handling.  You
  1183.         may NOT distribute a licensed version of this software.  
  1184.  
  1185.         You  may  NOT  use,  copy, modify, sublicense, assign or transfer
  1186.         this  software  and  its license, or any copy or modification, in
  1187.         whole  or  in  part,  except  as  expressly  provided for in this
  1188.         license.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.  
  1199.  
  1200.  
  1201.         Copyright (C) 1990-94, Key Software Products. All Rights Reserved
  1202.  
  1203.