xref: /netbsd/sbin/slattach/slattach.8 (revision c4a72b64)
1.\"	$NetBSD: slattach.8,v 1.25 2002/10/03 15:41:47 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.
58By default, no flow control is done.
59.It Fl h
60Turn on RTS/CTS flow control.
61By default, no flow control is done.
62.It Fl l
63Turn on the CLOCAL flag, making it possible to run SLIP on a cable
64without modem control signals (e.g. DTR, DSR, DCD).
65.It Fl m
66Maintain modem control signals after closing the line.
67Specifically, this disables HUPCL.
68.It Fl n
69Don't detach from invoking tty.
70.It Fl s Ar baudrate
71Specifies the speed of the connection.
72If not specified, the default of 9600 is used.
73.It Fl t Ar ldisc
74Specifies the line discipline to use for the tty.
75Supported line disciplines are
76.Dq slip
77(creates a
78.Xr sl 4
79instance) and
80.Dq strip
81(creates a
82.Xr strip 4
83instance).
84If this option is not specified, the default is
85.Dq slip .
86.It Ar ttyname
87Specifies the name of the tty device.
88.Ar ttyname
89should be a string of the form
90.Ql ttyXX ,
91or
92.Ql /dev/ttyXX .
93.El
94.Pp
95In addition, the following flags to
96.Xr ifconfig 8
97control various properties of a SLIP link:
98.Bl -tag -width Ar
99.It Ar link0
100Turn on Van Jacobsen header compression.
101.It Ar -link0
102Turn off header compression.
103.It Ar link1
104Don't pass through ICMP packets.
105.It Ar -link1
106Do pass through ICMP packets.
107.It Ar link2
108If a packet with a compressed header is received, automatically enable
109compression of outgoing packets.
110.It Ar -link2
111Don't auto-enable compression.
112.El
113.Pp
114Only the super-user may attach a network interface.
115.Pp
116To detach the interface, use
117.Dq Li ifconfig interface-name down
118after killing off the
119.Nm
120process.
121.Ar Interface-name
122is the name that is shown by
123.Xr netstat 1 .
124.Sh EXAMPLES
125.Bd -literal -offset indent -compact
126slattach ttyh8
127slattach \-s 4800 /dev/tty01
128.Ed
129.Sh DIAGNOSTICS
130Messages indicating that the specified interface does not exist, the
131requested address is unknown, or that the user is not privileged but
132tried to alter an interface's configuration.
133.Sh SEE ALSO
134.Xr netstat 1 ,
135.Xr daemon 3 ,
136.Xr netintro 4 ,
137.Xr sl 4 ,
138.Xr strip 4 ,
139.Xr ifconfig 8 ,
140.Xr rc 8
141.Sh HISTORY
142The
143.Nm
144command appeared in
145.Bx 4.3 .
146