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