
     Qdialer v. 0.31 Documentation

A call for additions.

     If you know something that you think should be added to this
doc file please let me know.  The programmer is usually the worst person
to actually document operation of a program.


     What is it?

          Qdialer is about the 4th generation of a dialer interface for STiK2.
If you think this is bad you should have seen some of the earlier models.  It's
purpose is to connect and disconnect STiK2 with an ISP.  Qdialer can be ran as
either an APP or as an ACC.  When operation as an APP it need not remain resident
for operations. (ie.  If you connect with it, you don't need to keep it running
til you disconnect)

     What's New?

     Since the last doc file?  Quite a bit.  Almost all internal changes and bug fixes.  

     Overview of dialogs and buttons.

Main Dialog:

     Closer Button:  This is the normal GEM closer.  When in application mode
it exits Qdialer. (only from Main Dialog)

     Iconify Button: This will iconify the dialog. (only available on an AES
that supports iconification)

     Fuller Button:  This provides a window shade effect.  Collapsing the dialog
into just the Title (or mover) Bar.  When collapsed click on the Fuller button
again to restore the dialog to normal.

     First icon in Tool Bar: (i in circle)  This is the Information Tool.  This 
button will open the About Dialog.

     Second icon in Tool Bar: (SIMM looking object)  This is the Memory Tool.  This
button will open the Memory Statistics Dialog.

     Third icon in Tool Bar: (Capital IP) This is the IP Address Tool.  This button
will open the IP Address Dialog.

     Fourth icon in Tool Bar: (Telephone with i) This is the Port Info Tool.  This
button will open the Port Info Dialog.

     Fifth icon in Tool Bar: (Hammer and Screwdriver)  This is the Tools Tool.
This button will open the Qdial Tools Dialog.

     First button below Tool Bar:  This is the Port that Qdial is operating on.
Currently this is the value stored in DEFAULT.CFG.

     Second button below Tool Bar:  Online/Offline Status button.  Currently when
STIK2 hasn't been ran yet, this will display Unknown.  Once a connection has
been made it should represent the appropriate value.

     Third button below Tool Bar:  Script Selection Button.  If you click on this
button it will allow you to load a different script for dialer operations.  The
default value is from DEFAULT.CFG.

     Fourth button below Tool Bar: Connect/Disconnect.  As the name implies it
either dials and connects STiK2 or Disconnects, depending upon the current online
state.  It's value should always match the appropriate operation for the online
state.


About Dialog:

     Displays the version of Qdial and the date it was compiled.

     Also displays the STiK version and Author.

     The About Dialog can be closed from the closer button or from the OK button.

Memory Statistics Dialog:

     Displays STiK2 Free Memory, Largest Block of STiK2 Free Memory and System
Free Memory.  All values are measured in Bytes.  Forcing a redraw of the Memory
Statistics Dialog should update the values.

     The Memory Statistics Dialog can be closed from the closer button or from 
the OK button.

IP Address Dialog:

     Displays current IP address.  Also allows user to manually set the IP address
by editing the IP Address field and clicking Set Address.  If you don't want to 
set the IP address click on Cancel or the Closer Button.

Port Info Dialog:

     First Box displays current Port. 

     Second shows the current connection speed to the modem. 
     This is the DTE rate.  The DTE rate is the speed at which
     your comuter talks to your modem.
     
     Third is the Up Since line.  It displays the time your system registered when
you connected.  If you are offline, it should report Offline.

     Fourth is Data Sent.  This is the amount of Data that STiK2 has sent since
the last time you reset your machine.   It is not session independent. The value
is in bytes.

     Fifth is Data Received.  This is the amount of Data that STiK2 has received
since the last time you reset your machine.  It is not session independent.  The
value is in bytes.

Qdial Tools Dialog:

     Displays options etc for the Dialers operations.

     Log Dial Connection:

     If logging is enabled the box should be checked.  To turn logging on or off
click the button.  If you change the button and don't want to keep the new value
select Cancel.  Selecting OK will set the new logging value.

     The changed value of logging will take effect the next time you connect.

     Use STiK 1.x Dialog

     If this is checked then the old faithful STiK 1 connection dialog is used
during connection.  If it is not checked a new connection dialog will be used.

     Save Error Log

     If you select this a copy of STiK's Error log will be written out to a file
called "ERROR.LOG", in the directory that Qdial was executed from.  This is for
use in debugging STiK.  It shows various items that will either be self explanatory
to you or completely useless ;)  I or other programmers from time to time, may
ask for this error.log.  The information in the ERROR.LOG is only accurate for the moment
that you select this option.  It is not updated in anyway.  It is only a snapshot
of the current values.
     
     SLICE

     Setting a value any numerical value 0 up will change the SLICE variable in STIK2
to this value if you exit Tools via the OK button.

	Save Preferences
	
	This button will save (create if necessary) a file called "QDIAL.CFG", in your
STIK_CFG directory.  This file is read when Qdial launches and set's its options.
This will save the following options.

	Connection Logging -> Do you want to log the connection attempt
	STiK 1.x Connection Dialog -> Use STiK 1.x Dialog if True
	Slice value -> Delay value of STiK's slice variable
	The path to find your dial scripts.
	Qdials default dial script name located in above path.

STiK 1.x Connection Dialog:

     (Appears when making a connection)  Connecting can only be aborted by use
of the Esc key.

     It features two message lines that report the operation of the connection
process.  It still displays GET_IP which is only of use in SLIP mode.  The bottom
right button is the time out value for the current step.
     
New Connection Dialog

     (Appears when making a connection) 

     Features a small buffer of lines so that the user can watch what is going on a litle
bit better.

/**********************************************************/
	Some Answers to questions
/**********************************************************/

When I start Qdial it lists some serial port other than the one
I want to use?

	Until a dial script is loaded, unless you have defined SERIALPORT
in your DEFAULT.CFG file, the serial port will show as the first
one on your system.

I want to make a null modem connection to another machine anything
I need to set specifically?

	Yes.
	
	See how do I setup a direct connection below.
	
	Also you need to set CDVALID = FALSE.  This avoids STiK2 attempting
	to detect a carrier when there will be none present.


How do I setup a direct connection with the dialer?

	Under the SUCCESS variable set the line to read
	
	SUCCESS = DIRECT
	
	The dialer will not dial and go directly to the connection process
	


Variables recognized in a dial script

BAUD_RATE
CDVALID
CLIENT_IP
CONNECT_WAIT
FAILURE
FIND
HANGUP   - DTR
HOSTNAME
INIT
MTU
NAMESERVER
PAP_ID
PASSWORD
PHONE_NUMBER
PING_TTL
PPP_PASSWORD   /* Can be substitued for PASSWORD in a Dial Script */
PREFIX
RCV_WND
REDIAL_DELAY
REPORT
REPT
RESP
SERIALPORT
SLICE
SUCCESS
TTL
UNTL
UP_RESPONSE
USERNAME
WAIT

(some non dialer specific variables are listed in the file
STIKVAR.TXT)

     Summation:

          Eventually this will probably be a more exciting application.  But 
hopefully it's functional and not too painful.  If there is anything you think
is missing let me know.  Eventually there will probably be an explanation of
the Dialer Scripts in this document.


     Color Qdialer RSC provided by:

---------------------------------------------------------------------------
Anthony Green B.Eng (Hons)          64Mb/4Gb MCS Hades 060       
Fujination                        * TOS compatible sales and service         
GPO Box 1190, Hobart TAS 7001     * Authorised MCS Hades reseller 
AUSTRALIA                         * WWW/Database development & CD Mastering        
http://www.intelitec.com.au/fujination/     E-mail: ac_green@tassie.net.au  
---------------------------------------------------------------------------
