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