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 .\" 4. 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$
  30 .\"
  31 .Dd June 5, 1993
  32 .Dt STARTSLIP 1
  33 .Os
  34 .Sh NAME
  35 .Nm startslip
  36 .Nd dial up and login to a slip server
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl d
  40 .Op Fl b Ar speed
  41 .Oo
  42 .Fl s Ar string1
  43 .Op Fl s Ar string2 Op Ar ...\&
  44 .Oc
  45 .Op Fl h
  46 .Op Fl l
  47 .Op Fl L
  48 .Op Fl A Ar annexname
  49 .Op Fl U Ar upscript
  50 .Op Fl D Ar downscript
  51 .Op Fl t Ar script_timeout
  52 .Op Fl W Ar maxtries
  53 .Op Fl w Ar retry_pause
  54 .Op Fl K Ar keepalive
  55 .Op Fl O Ar outfill
  56 .Op Fl S Ar unit
  57 .Ar device user password
  58 .Sh DESCRIPTION
  59 The
  60 .Nm
  61 utility opens the specified
  62 .Ar device .
  63 Once carrier is asserted (if modem control is enabled)
  64 .Nm
  65 attempts to login as the specified
  66 .Ar user
  67 with the given
  68 .Ar password .
  69 Standard login: & Password: scheme assumed unless Annex option
  70 specified (see
  71 .Fl A ) .
  72 If successful, it puts the device into the slip line discipline,
  73 calls
  74 .Ar upscript
  75 and goes to wait mode.
  76 If carrier drops (modem control enabled) or a
  77 .Dv SIGHUP
  78 is sent to
  79 .Nm ,
  80 it closes the device, calls
  81 .Ar downscript
  82 and attempts to repeat the dialup and login sequence.
  83 If a
  84 .Dv SIGTERM
  85 is send to
  86 .Nm ,
  87 it closes the device, calls
  88 .Ar downscript
  89 and exits.
  90 When
  91 .Nm
  92 called twice on the same device, previous copy killed by a
  93 .Dv SIGTERM
  94 before any operation.
  95 .Pp
  96 The following options are available:
  97 .Bl -tag -width indent
  98 .It Fl d
  99 Print out debugging information.
 100 .It Fl b Ar speed
 101 Determine the baud rate used for
 102 .Ar device ,
 103 default value is 9600.
 104 .It Fl t Ar script_timeout
 105 Set login script timeout in seconds, default value is 90.
 106 .It Fl w Ar retry_pause
 107 Set connecting retry pause in seconds (increased from one retry to another),
 108 default value is 60.
 109 .It Fl W Ar maxtries
 110 Set maximum number of connection retries for one session,
 111 default value is 6.
 112 Value 0 means infinite count.
 113 .It Fl s Ar stringN
 114 The optional
 115 .Ar stringN
 116 is written to
 117 .Ar device .
 118 Return character is added automatically.
 119 For a dialup modem,
 120 the string is used to specify a dial sequence.
 121 No string written by default.
 122 You can specify several
 123 .Fl s Ar stringN
 124 arguments to use with each try, f.e.
 125 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.
 149 This may
 150 contain
 151 .Xr ifconfig 8 ,
 152 .Xr route 8 ,
 153 and other appropriate commands.
 154 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.
 165 The arguments that
 166 are passed to the script are "slX down".
 167 Default value is
 168 .Pa /sbin/ifconfig .
 169 Dial sequence number (see
 170 .Fl s )
 171 passed via
 172 .Ev LINE
 173 environment variable.
 174 .It Fl K Ar keepalive
 175 Set SLIP "keep alive" timeout in seconds.
 176 If FRAME_END not received during this
 177 time period, a reconnect will occur.
 178 Active "out fill" timeout expected from other
 179 side.
 180 Default value is no timeout.
 181 .It Fl O Ar outfill
 182 Set SLIP "out fill" timeout in seconds.
 183 It causes at least one FRAME_END
 184 to be sent during this timeout.
 185 Needed for "keep alive" timeout on other side.
 186 Default value is no timeout.
 187 .It Fl S Ar unit
 188 Set SLIP unit number directly.
 189 Use with caution, no check for two
 190 interfaces with same number made.
 191 Default is dynamic assignment.
 192 .It Fl L
 193 Use uucp-style device locking.
 194 You need it unless you start
 195 .Nm
 196 from external program which already does uucp locking.
 197 Default case is no uucp locking to satisfy such programs.
 198 .El
 199 .Sh FILES
 200 .Bl -tag -width /var/run/startslip.<device>.pid -compact
 201 .It Pa /var/run/startslip.<device>.pid
 202 pid stored here
 203 .It Pa /usr/share/examples/startslip/*
 204 .El
 205 .Sh SEE ALSO
 206 .Xr uustat 1 Pq Pa ports/net/freebsd-uucp ,
 207 .Xr slattach 8 ,
 208 .Xr sliplogin 8
 209 .Sh HISTORY
 210 The
 211 .Nm
 212 appeared in
 213 .Bx 4.4 .