STiK Configuration Variables
Date. Feb. 25, 2000

This is a list of variables that STiK uses are known
to be used by clients.  There are possibly more that
are used by clients that I do not know about.
There is a maximum of 100 variables that are stored 
in STiK.   The variable names and boolean values are
not case sensitive.  Values may be case sensitive 
depending on usage.

Usage format in Config Files or Scripts.

 VAR = VALUE           :standard format

   Non existent vars are 0 (FALSE) by default.
   Variables without "= value" are set to ON
   Variables with " = " but no value are set to 0. (ie: = nothing)

   TRUE  and ON  are acceptable substitutes for 1
   FALSE and OFF are acceptable substitutes for 0

Part 1.  STiK Variables

ALLOCMEM

    Can only be set in default.cfg.

    Memory to be reserved.  This is for ALL of TCP's internal memory
 requirements, except the space to store the config file.
 This includes all input queues, output queues, DNS cache, etc...
 It must be large enough to cope, plus a bit extra for luck :-)
 If unset, defaults to 75000 bytes.


CDVALID

  Can be used in default.cfg or a dial script.

   Set this variable to FALSE if your modem doesn't
assert Carrier Detect properly.  Also in situations
where you aren't using a modem.  Such as a NULL
modem cable.


CLIENT_IP

  Can be used in default.cfg or a dial script.

    If your provider allocates you a different Ip Address
 whenever you log in, then don't bother with CLIENT_IP
 However, if you have an IP address all to yourself, then put
 it here, in dotted decimal.  If your dial script file gets
 your address at login time, it will override this value.


DIALFILE

  Can only be used in default.cfg.

  Not used much anymore.  It was used to setup
what would be the default dial script for the dialer.
It still functions for this use if you have not configured,
the dialer or you are using a dialer that does not
allow you to save a prefered script.


FULLNAME

 Can be used in default.cfg or a dial script.

 Not used by STiK (unless I've forgotten something)
anymore.  May be used by clients for email or news,
etc.  It is simply the name you want to be known as,
accuracy is probably not important at all if it does not
matter to you.


HOSTNAME

 Can be used in default.cfg or a dial script.

  The hostname of your computer for this session. 
It is used in creating defualt email address's and in
the identd services.  If it is not accurate, identd services
may fail for some servers.  


MTU

  Can be used in default.cfg or a dial script.

   Maximum Transfer Unit - Not necessary
for a PPP session, unless the other end
is old and buggy.  PPP negotiation settles
this value for you.  If left unset STiK will
set a value of 1500.


NAMESERVER

  Can be used in default.cfg or a dial script.

   This is the Domain Name Server that all
IP addresses will be resolved from.  Your ISP
probably recommends one.  It must be set in
either your default.cfg or your dial script.  If it
is set in both places the value from the dial script
will over ride the value from the default.cfg.


PAP_ID

  Can be used in default.cfg or a dial script.

  PAP_ID is used to replace username on systems where
your PAP_ID is not your email username.  If your 
username for PAP is the same as your normal email
USERNAME you do not need to use this setting.
If you are not using PAP you do not need to set this
variable.  If it is set in both places the value in
the dial script will over ride the value from the
default.cfg.


PASSWORD

  Can be used in default.cfg or a dial script.

  This is your PAP password.  You only need
this set if you are using PAP to connect your 
machine.  If you are using PAP you need this variable
set and correct.  If it exists in both default.cfg and
your dial script, the value in the dial script will
over ride the value from the default.cfg.


PING_TTL

  Can be used in default.cfg or a dial script.

   PING Time To Live - How many hops a ping
packet can survive.   If it is not set it is set by
STiK.


PROTOCOL

  Must be set in Default.cfg at the moment.

  Values 

   0 = Normal Slip
   1 = CSLIP
   2 = PPP 


RCV_WND

 Can be used in default.cfg or a dial script.

  ReCeiVe WiNDow - The size of the buffer
for receiving packets on a connection.  If unset
STiK will set this for you.


REPORT

 Can be used in default.cfg or a dial script.

 This just prints debugging information to the
screen.  On anything less than a 68030 never
set this to TRUE.

  Values

  0 - OFF do not print reports to screen
  1 - ON  print reports to screen

  If left unset the default value is OFF.


SERIALPORT

  Can be used in default.cfg or a dial script.

 Use the program `listport.tos' to list the serial ports
available with your hardware configuration.  Use the
port name exactly as it appears in the listport display,
including correct capitilisation and spaces.

If SERIALPORT is not set, or has an invalid port name,
the default is to use the first port listed by listport.tos
So if that port is the one you want to use, you don't need
to set this variable.

Use the program `listport.tos' to list the serial ports
available with your hardware configuration.  Use the
port name exactly as it appears in the listport display,
including correct capitilisation and spaces.

If SERIALPORT is not set, or has an invalid port name,
the default is to use the first port listed by listport.tos
So if that port is the one you want to use, you don't need
to set this variable.


SLICE

   Can be used in default.cfg or a dial script.

   Modifies how often the stik interupt will run.
0 is fine for a machine with a 68030 or better CPU,
other machines will need 1 or higher.

  Values can be any value 0 and up.

   If you do not set this STiK will set it to ? (not at 
my Atari atm.  Remind me to fix this someone).


TTL

 Can be used in default.cfg or a dial script.

  Time To Live - How many hops a packet will last before
it is deleted by the network.  Too many hops and you won't
want the connection anyway.

  If you are having problems with your connections, you 
may want to set this variable.  If it is not set it is set by
STiK.


UP_RESPONSE

   Can be used in default.cfg or a dial script.

  Response to incoming TCP packets to unknown ports

   Values
   0 = default (3 = send ICMP)
   1 = ignore
   2 = send TCP RST
   3 = send ICMP `unknown port' response

   3 is the `correct' response, but when connecting to an IRC server
   it attempts to contact your identd on port 113.  If it thinks you
   don't have identd, it will most probably reset your IRC session.

   This variable is not necessary anymore.  STiK2 supports
identd internally.  If you want for some reason you can still
configure this variable.


USERNAME

  Can be used in default.cfg or a dial script.

  It has several uses.

  Can be used for making default mail addresses.
  Is used in Identd services.
  Can be used in PAP connection if you do not have PAP_ID set.

  A value for this variable is necessary.


YIELD

  Can be used in default.cfg or a dial script.

  This utilizes the app_yield system command.  Which
is not available on all systems.  However it does
keep several routines from blocking the system, if
you can use it.

  Values

  0 - Off (default value) - do not call app_yield
  1 - ON call app_yield

 If you do not set YIELD it is off by default.


Part 2.  Client related variables


  Some of the variables in this section are probably unused
by any clients anymore.  I mearly have included them so that
people know what they are if they see them.  The notes are old
and probably of litle value.


Variables for IRC implementations

IRCNICK

Your prefered IRC nick.  It might be in use, of course...
 defaults to USERNAME if not set

IRCPONGMSG

This is text for a /msg to be sent to the person
 who pinged you.  If you want to save network
 bandwidth, leave it commented out :-)

IRCPORT

If port number is not specified, it defaults to 6667

IRCSERVER

  IRC servers.  Currently, just one default server
 can be specified.

Miscellaneous variables

This variables have more than one type of client that
may use them.  Possibly more than one client that still
uses them.  

#  WWW Proxy for HTML

  If you need to use a Web proxy server.  You may
want to set the following 2 variables.  If you don't use
a proxy then don't worry about them.

HTTP_PROXY  

Name of your proxy server.

HTTP_PROXY_PORT

The port number your HTTP_PROXY uses
 
MAIL variables

  These are actually kind of nice to store here.
I do not know how many clients use them.  This
gives about any program the ability to send mail
with out internal mail configurations.  However as
I said I'm not certain how many clients use them.
(SMTP is a fairly simple protocol consisting of about
2k of source code for a minimal implementation)

SMTP_HOST

Your default mail host for sending mail.

EMAIL

Your email address you wish to receive mail at.  CAB.OVL uses this.

Eof