xref: /netbsd/sbin/slattach/slattach.8 (revision bf9ec67e)
1.\"	$NetBSD: slattach.8,v 1.24 2001/12/05 15:03:27 wiz Exp $
2.\"
3.\" Copyright (c) 1986, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)slattach.8	8.2 (Berkeley) 4/1/94
35.\"
36.Dd September 3, 1999
37.Dt SLATTACH 8
38.Os
39.Sh NAME
40.Nm slattach ,
41.Nm slip
42.Nd attach serial lines as network interfaces
43.Sh SYNOPSIS
44.Nm
45.Op Fl Hhlmn
46.Op Fl s Ar baudrate
47.Op Fl t Ar ldisc
48.Ar ttyname
49.Sh DESCRIPTION
50.Nm
51is used to assign a tty line to a network interface,
52and to define the network source and destination addresses.
53The following operands are supported by
54.Nm "" :
55.Bl -tag -width Ar
56.It Fl H
57Turn on DTR/CTS flow control.  By default, no flow control is done.
58.It Fl h
59Turn on RTS/CTS flow control.  By default, no flow control is done.
60.It Fl l
61Turn on the CLOCAL flag, making it possible to run SLIP on a cable
62without modem control signals (e.g. DTR, DSR, DCD).
63.It Fl m
64Maintain modem control signals after closing the line.  Specifically,
65this disables HUPCL.
66.It Fl n
67Don't detach from invoking tty.
68.It Fl s Ar baudrate
69Specifies the speed of the connection.  If not specified, the
70default of 9600 is used.
71.It Fl t Ar ldisc
72Specifies the line discipline to use for the tty.  Supported line
73disciplines are
74.Dq slip
75(creates a
76.Xr sl 4
77instance) and
78.Dq strip
79(creates a
80.Xr strip 4
81instance).
82If this option is not specified, the default is
83.Dq slip .
84.It Ar ttyname
85Specifies the name of the tty device.
86.Ar ttyname
87should be a string of the form
88.Ql ttyXX ,
89or
90.Ql /dev/ttyXX .
91.El
92.Pp
93In addition, the following flags to
94.Xr ifconfig 8
95control various properties of a SLIP link:
96.Bl -tag -width Ar
97.It Ar link0
98Turn on Van Jacobsen header compression.
99.It Ar -link0
100Turn off header compression.
101.It Ar link1
102Don't pass through ICMP packets.
103.It Ar -link1
104Do pass through ICMP packets.
105.It Ar link2
106If a packet with a compressed header is received, automatically enable
107compression of outgoing packets.
108.It Ar -link2
109Don't auto-enable compression.
110.El
111.Pp
112Only the super-user may attach a network interface.
113.Pp
114To detach the interface, use
115.Dq Li ifconfig interface-name down
116after killing off the
117.Nm
118process.
119.Ar Interface-name
120is the name that is shown by
121.Xr netstat 1 .
122.Sh EXAMPLES
123.Bd -literal -offset indent -compact
124slattach ttyh8
125slattach \-s 4800 /dev/tty01
126.Ed
127.Sh DIAGNOSTICS
128Messages indicating that the specified interface does not exist, the
129requested address is unknown, or that the user is not privileged but
130tried to alter an interface's configuration.
131.Sh SEE ALSO
132.Xr netstat 1 ,
133.Xr daemon 3 ,
134.Xr netintro 4 ,
135.Xr sl 4 ,
136.Xr strip 4 ,
137.Xr ifconfig 8 ,
138.Xr rc 8
139.Sh HISTORY
140The
141.Nm
142command appeared in
143.Bx 4.3 .
144