@database Default
@master Work.2:tt/AGW/ReStarter.guide
@$VER: 2.1
@author "David L. Evans"
@(c) "1996"
@index HeddleyAutoIndex
@remark Created with Heddley v1.1 (c) Edd Dumbill 1994

@node "Commands" "Commands Recognized"
@next "BOOTP"
@prev "MainReStarter"
@{b}@{u}Commands recognized:@{ub}@{uu}

@{"BOOTP" link "BOOTP" 0}, @{"DEVICE" link "DEVICE" 0}, @{"DIALSCRIPT" link "DIALSCRIPT" 0}, @{"LOGNAME" link "LOGNAME" 0}, @{"OFFLINE" link "OFFLINE" 0}, @{"ONLINE" link "ONLINE" 0}, @{"PORTNAME" link "PORTNAME" 0}, @{"REXXDIALSCRIPT" link "REXXDIALSCRIPT" 0},
@{"REXXOFFLINE" link "REXXOFFLINE" 0}, @{"REXXONLINE" link "REXXONLINE" 0}, @{"UNIT" link "UNIT" 0}
@endnode

@node "BOOTP" "BOOTP"
@next "DEVICE"
@prev "Commands"
@{b}@{u}BOOTP:@{ub}@{uu}

With the advent of AmiTCP version 4.3, this command has become necessary.
Under  AmiTCP 4.3 (and later), the dialing function is handled by the TCP
Stack and not the  sana device.  As a result, this command causes the
"bootpconfig" program to execute  (which will perform the dialing functions)
and restore your TCP stack as needed.  Using  this command overrides the
@{"DIALSCRIPT" link "DIALSCRIPT" 0} command.

Usage:
                @{u}CLI@{uu}                                 @{u}Workbench@{uu}
                @{b}BOOTP@{ub}                               @{b}BOOTP@{ub}


IMPORTANT NOTE:  This command should only be used if you rely on the built-in
dialing features of AmiTCP 4.3 and later.
@endnode

@node "DEVICE" "DEVICE"
@next "DIALSCRIPT"
@prev "BOOTP"
@{b}@{u}DEVICE:@{ub}@{uu}

If this command is not present, it defaults to @{i}Devs:Networks/ppp.device@{ui}.  If
present,  the device specified is used as the sana device.  This program has
been tested fully  with ppp.device but should work with other Sana devices.

Usage:
                @{u}CLI@{uu}                      @{u}Workbench@{uu}
                @{b}DEVICE@{ub} Devs:cslip.device @{b}DEVICE=@{ub}DEVS:Networks/ppp.device
@endnode

@node "DIALSCRIPT" "DIALSCRIPT"
@next "LOGNAME"
@prev "DEVICE"
@{b}@{u}DIALSCRIPT:@{ub}@{uu}

There is no default dialing script.  If you define this command, the
associated option is  executed as a dos based script.  This can be used to
invoke whatever functions are  needed to perform the dialing function to
re-connect to a internet provider.  It should be  noted that under 4.3 and
later versions of AmiTCP, you should not use this command  (the @{"BootP" link "BOOTP" 0} command
should be used).

Usage:
                @{u}CLI@{uu}                                  @{u}Workbench@{uu}
                @{b}DIALSCRIPT@{ub} s:MyScript                @{b}DIALSCRIPT=@{ub}S:MyScript
@endnode

@node "LOGNAME" "LOGNAME"
@next "OFFLINE"
@prev "DIALSCRIPT"
@{b}@{u}LOGNAME:@{ub}@{uu}

This command defaults to "@{i}Amitcp:DialerLog@{ui}" unless it is specified.  Any
errors that occur are output into this file.  Under normal operation, a
offline event occurs and when  the device is restored to online, a online
event is recorded.  You can use this log to  help nail "fruity" providers.  I
have used this feature several times to prove to my provider that he hungup on
me 20 or 30 times in the last 48 hours.  Its Kind of nice to have  the
information at your fingertips!

Usage:
                @{u}CLI@{uu}                             @{u}Workbench@{uu}
                @{b}LOGNAME@{ub} AmiTCP:DialerLog        @{b}LOGNAME=@{ub}AmiTCP:DialerLog
@endnode

@node "OFFLINE" "OFFLINE"
@next "ONLINE"
@prev "LOGNAME"
@{b}@{u}OFFLINE:@{ub}@{uu}

By default, this command defaults to "@{i}Amitcp:db/ReStarter-offline@{ui}".  If
present, this command defines a dos based script to be executed when an
offline event is received from  the sana2 device being used.  Normally, you
would want to kill certain tasks and prepare to have a orderly shutdown of
your TCP Stack.  This however can be used to perform any task you wish to
perform at this point of the process.

Usage:
          @{u}CLI@{uu}                           @{u}Workbench@{uu}
          @{b}OFFLINE@{ub} s:ReStarter-offline   @{b}OFFLINE=@{ub}Amitcp:db/ReStarter-offline
@endnode

@node "ONLINE" "ONLINE"
@next "PORTNAME"
@prev "OFFLINE"
@{b}@{u}ONLINE:@{ub}@{uu}

By default, this command defaults to "Amitcp:db/ReStarter-online".  If
present, this command defines a dos based script to be executed when an online
event have been executed.  Normally, you would want to re-start certain tasks
and or commands.  For example, I reload certain CNET BBS ports.  Any function
you desire can be performed  however it should be noted that the sana device
will be ONLINE when this command is  performed.

Usage:
                @{u}CLI@{uu}                       @{u}Workbench@{uu}
                @{b}ONLINE@{ub} s:ReStarter-online @{b}ONLINE=@{ub}Amitcp:db/ReStarter-online
@endnode

@node "PORTNAME" "PORTNAME"
@next "REXXDIALSCRIPT"
@prev "ONLINE"
@{b}@{u}PORTNAME:@{ub}@{uu}

By default, this program creates an AREXX port called "@{i}ReStarterPort@{ui}".  If
present, this  command will define the AREXX port to create and use by this
program.  It should be  noted that when dealing with ports, the case of the
letters is very important.

Usage:
                CLI                           Workbench
                @{b}PORTNAME@{ub} ReStarterPort        @{b}PORTNAME=@{ub}ReStarterPort
@endnode

@node "REXXDIALSCRIPT" "REXXDIALSCRIPT"
@next "REXXOFFLINE"
@prev "PORTNAME"
@{b}@{u}REXXDIALSCRIPT:@{ub}@{uu}

There is no default dialing script.  If you define this command, the
associated option is  executed as a AREXX based script.  This can be used to
invoke whatever functions are  needed to perform the dialing function to
re-connect to a internet provider.  It should be  noted that under 4.3 and
later versions of AmiTCP, you should not use this command  (the @{"BootP" link "BOOTP" 0} command
should be used).  Note: This command overrides the @{"DIALSCRIPT" link "DIALSCRIPT" 0} command if
present.

Usage:
                @{u}CLI@{uu}                              @{u}Workbench@{uu}
                @{b}REXXDIALSCRIPT@{ub} s:MyScript        @{b}REXXDIALSCRIPT=@{ub}S:MyScript
@endnode

@node "REXXOFFLINE" "REXXOFFLINE"
@next "REXXONLINE"
@prev "REXXDIALSCRIPT"
@{b}@{u}REXXOFFLINE:@{ub}@{uu}

By default, this command defaults to "@{i}Amitcp:db/ReStarter-offline@{ui}".  If
present, this command defines a AREXX based script to be executed when an
offline event is received  from the sana2 device being used.  Normally, you
would want to kill certain tasks and  prepare to have a orderly shutdown of
your TCP Stack.  This however can be used to  perform any task you wish to
perform at this point of the process.  Note: This command  overrides the
@{"OFFLINE" link "OFFLINE" 0} command if present.

Usage:
                @{u}CLI@{uu}                                  @{u}Workbench@{uu}
                @{b}REXXOFFLINE@{ub} s:offline                @{b}REXXOFFLINE=@{ub}S:offline
@endnode

@node "REXXONLINE" "REXXONLINE"
@next "UNIT"
@prev "REXXOFFLINE"
@{b}@{u}REXXONLINE:@{ub}@{uu}

By default, this command defaults to "@{i}Amitcp:db/ReStarter-online@{ui}".  If
present, this command defines a AREXX based script to be executed when an
online event have been  executed.  Normally, you would want to re-start
certain tasks and or commands.  For  example, I reload certain CNET BBS ports.
Any function you desire can be performed  however it should be noted that the
sana device will be ONLINE when this command is  performed.  Note:  This
command overrides the @{"ONLINE" link "ONLINE" 0} command if present.

Usage:
                @{u}CLI@{uu}                                @{u}Workbench@{uu}
                @{b}REXXONLINE@{ub} s:online                @{b}REXXONLINE=@{ub}S:online
@endnode

@node "UNIT" "UNIT"
@prev "REXXONLINE"
@{b}@{u}UNIT:@{ub}@{uu}

By default, this command defaults to unit zero.  If present, this command
defines the  unit number to use with the associated device used by this
program.  Normally, you will  not use this command unless you also use the
@{"DEVICE" link "DEVICE" 0} command.

Usage:
                @{u}CLI@{uu}                                   @{u}Workbench@{uu}
                @{b}UNIT@{ub} 0                                @{b}UNIT=@{ub}0
@endnode

@node "Main" "Main Document"
@next "Commands"
 Short:          Redials ppp/sana device upon a hangup  
 Uploader:       devans@ccubb.com (David Evans)  
 Author:         devans@ccubb.com (David Evans) 
 Type:           comm/net 
 Requires:       A Sana device and a TCP/IP Stack 
 Version:        2.1 
 Distribution:   Worldwide


This program performs the simple function of restarting a sana2 device when it
is placed in a offline state.  This normally occurs when you are hungup on by
a provider or line noise.  This program does not require that a ping is used
so no additional CPU usage is consumed.  This program uses the multi-tasking
capabilities of the Amiga to wait for the OFFLINE event to occur.

With version 2.1 of this software, this program also responds to an AREXX
command to  KILL itself.  This can be useful to cause this program to exit
when you wish to actually terminate your connection.

If you are a workbench user, this program now also responds to workbench
start-ups.  It will use an icons tooltypes for its commands if started from
Workbench.

It should be noted that with the advent of other TCP stacks within the Amiga
world that this software has not been tested with any stack but AmiTCP.  It
should however work with all as it relies upon the Sana device specification
not the underlying TCP stack.  The only exception to this will be the @{"BOOTP" link "BOOTP" 0}
command which relies upon a AmiTCP program called "@{i}bootpconfig@{ui}".  I would be
interested in any feedback users of other stacks could provide concerning
these new stacks.

@{b}@{u}Legal Stuff:@{ub}@{uu}

This software is considered giftware.  If you find it useful, I will accept
any contributions  you wish to donate!  Money of course is always welcome!

I can be reached at:

                David L. Evans
                620 South 15th Ave.
                Caldwell, ID 83605

                EMAIL:  devans@ccubb.com

@{b}@{u}Shameless Plug:@{ub}@{uu}

You can also visit my BBS if you wish.  We are running on a Amiga 4000 (stock
system) and have been in continuous operation since 1982.  We started out our
life on a  Pet model 4016 of all things!  It can be reached on the net at:

                telnet:     ccubb.com
                web:        www.ccubb.com
                ftp:        ftp.ccubb.com
@endnode

@node HeddleyAutoIndex "Index"
@remark Index auto-generated by Heddley
Index of database Default

Documents

@{"BOOTP" link "BOOTP"}
@{"Commands Recognized" link "Commands"}
@{"DEVICE" link "DEVICE"}
@{"DIALSCRIPT" link "DIALSCRIPT"}
@{"LOGNAME" link "LOGNAME"}
@{"Main Document" link "Main"}
@{"OFFLINE" link "OFFLINE"}
@{"ONLINE" link "ONLINE"}
@{"PORTNAME" link "PORTNAME"}
@{"REXXDIALSCRIPT" link "REXXDIALSCRIPT"}
@{"REXXOFFLINE" link "REXXOFFLINE"}
@{"REXXONLINE" link "REXXONLINE"}
@{"UNIT" link "UNIT"}

Buttons

@{"BOOTP" link "BOOTP" 0}
@{"DEVICE" link "DEVICE" 0}
@{"DIALSCRIPT" link "DIALSCRIPT" 0}
@{"LOGNAME" link "LOGNAME" 0}
@{"OFFLINE" link "OFFLINE" 0}
@{"ONLINE" link "ONLINE" 0}
@{"PORTNAME" link "PORTNAME" 0}
@{"REXXDIALSCRIPT" link "REXXDIALSCRIPT" 0}
@{"REXXOFFLINE" link "REXXOFFLINE" 0}
@{"REXXONLINE" link "REXXONLINE" 0}
@{"UNIT" link "UNIT" 0}
@endnode