sbin/startslip/startslip.1

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)startslip.1 8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 5, 1993
  36 .Dt STARTSLIP 1
  37 .Os BSD 4.4
  38 .Sh NAME
  39 .Nm startslip
  40 .Nd dial up and login to a slip server
  41 .Sh SYNOPSIS
  42 .Nm startslip
  43 .Op Fl d
  44 .Op Fl b Ar speed
  45 [
  46 .Fl s Ar string1
  47 .Op Fl s Ar string2 Op Ar ...
  48 ]
  49 .Op Fl h
  50 .Op Fl l
  51 .Op Fl L
  52 .Op Fl A Ar annexname
  53 .Op Fl U Ar upscript
  54 .Op Fl D Ar downscript
  55 .Op Fl t Ar script_timeout
  56 .Op Fl W Ar maxtries
  57 .Op Fl w Ar retry_pause
  58 .Op Fl K Ar keepalive
  59 .Op Fl O Ar outfill
  60 .Op Fl S Ar unit
  61 .Ar device user password
  62 .Sh DESCRIPTION
  63 .Nm Startslip
  64 opens the specified
  65 .Ar device .
  66 Once carrier is asserted (if modem control is enabled)
  67 .Nm
  68 attempts to login as the specified
  69 .Ar user
  70 with the given
  71 .Ar password .
  72 Standard login: & Password: scheme assumed unless Annex option
  73 specified (see
  74 .Fl A ) .
  75 If successful, it puts the device into the slip line discipline,
  76 calls
  77 .Ar upscript
  78 and goes to wait mode.
  79 If carrier drops (modem control enabled) or a
  80 .Dv SIGHUP
  81 is sent to
  82 .Nm Ns ,
  83 it closes the device, calls
  84 .Ar downscript
  85 and attempts to repeat the dialup and login sequence.
  86 If a
  87 .Dv SIGTERM
  88 is send to
  89 .Nm Ns ,
  90 it closes the device, calls
  91 .Ar downscript
  92 and exits.
  93 When
  94 .Nm
  95 called twice on the same device, previous copy killed by a
  96 .Dv SIGTERM
  97 before any operation.
  98 .Pp
  99 The following options are available:
 100 .Bl -tag -width indent
 101 .It Fl d
 102 .Nm Startslip
 103 prints out debugging information about what it is trying to do.
 104 .It Fl b Ar speed
 105 Determine the baud rate used for
 106 .Ar device ,
 107 default value is 9600.
 108 .It Fl t Ar script_timeout
 109 Set login script timeout in seconds, default value is 90.
 110 .It Fl w Ar retry_pause
 111 Set connecting retry pause in seconds (increased from one retry to another),
 112 default value is 60.
 113 .It Fl W Ar maxtries
 114 Set maximum number of connection retries for one session,
 115 default value is 6.
 116 Value 0 means infinite count.
 117 .It Fl s Ar stringN
 118 The optional
 119 .Ar stringN
 120 is written to
 121 .Ar device .
 122 Return character is added automatically.
 123 For a dialup modem,
 124 the string is used to specify a dial sequence.
 125 No string written by default.
 126 You can specify several
 127 .Fl s Ar stringN
 128 arguments to use with each try, f.e. several host phone numbers.
 129 .It Fl A Ar annexname
 130 .Nm Startslip
 131 assumes it is connecting to a Xylogics Annex box and engages in an
 132 appropriate dialog using the
 133 .Ar user
 134 and
 135 .Ar password
 136 arguments.
 137 The
 138 .Ar annexname
 139 argument is a string that is used to match against the Annex prompt
 140 to determine when a connection has been established.
 141 .It Fl h
 142 Use hardware (CTS/RTS) flow control for
 143 .Ar device .
 144 Default value is no flow control.
 145 .It Fl l
 146 Disable modem control (waiting for carrier and carrier drop sense) for
 147 .Ar device .
 148 Modem control is enabled by default.
 149 .It Fl U Ar upscript
 150 Specify a script to run when a SLIP interface becomes connected.  This may
 151 contain
 152 .Xr ifconfig 8 ,
 153 .Xr route 8 ,
 154 and other appropriate commands.  The arguments that
 155 are passed to the script are "slX up".
 156 Default value is
 157 .Pa /sbin/ifconfig .
 158 Dial sequence number (see
 159 .Fl s )
 160 passed via
 161 .Ev LINE
 162 environment variable.
 163 .It Fl D Ar downscript
 164 Specify a script to run when a SLIP connection goes away.  The arguments that
 165 are passed to the script are "slX down". Default value is
 166 .Pa /sbin/ifconfig .
 167 Dial sequence number (see
 168 .Fl s )
 169 passed via
 170 .Ev LINE
 171 environment variable.
 172 .It Fl K Ar keepalive
 173 Set SLIP "keep alive" timeout in seconds.
 174 If FRAME_END not received during this
 175 time period, a reconnect will occur.
 176 Active "out fill" timeout expected from other
 177 side.
 178 Default value is no timeout.
 179 .It Fl O Ar outfill
 180 Set SLIP "out fill" timeout in seconds.
 181 It causes at least one FRAME_END
 182 to be sent during this timeout.
 183 Needed for "keep alive" timeout on other side.
 184 Default value is no timeout.
 185 .It Fl S Ar unit
 186 Set SLIP unit number directly.
 187 Use with caution, no check for two
 188 interfaces with same number made.
 189 Default is dynamic assignment.
 190 .It Fl L
 191 Use uucp-style device locking.
 192 You need it unless you start
 193 .Nm
 194 from external program which already does uucp locking.
 195 Default case is no uucp locking to satisfy such programs.
 196 .El
 197 .Sh FILES
 198 .Bl -tag -width /var/run/startslip.<device>.pid -compact
 199 .It Pa /var/run/startslip.<device>.pid
 200 pid stored here
 201 .It Pa /usr/share/examples/startslip/*
 202 .Sh SEE ALSO
 203 .Xr uustat 1 ,
 204 .Xr slattach 8 ,
 205 .Xr sliplogin 8
 206 .Sh HISTORY
 207 The
 208 .Nm
 209 appeared in
 210 .Bx 4.4 .