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