NetBSD/sbin/slattach/slattach.8

.\"	$NetBSD: slattach.8,v 1.28 2006/07/08 17:22:14 tsutsui Exp $
.\"
.\" Copyright (c) 1986, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)slattach.8	8.2 (Berkeley) 4/1/94
.\"
.Dd July 8, 2006
.Dt SLATTACH 8
.Os
.Sh NAME
.Nm slattach
.Nd attach serial lines as network interfaces
.Sh SYNOPSIS
.Nm
.Op Fl Hhlmn
.Op Fl s Ar baudrate
.Op Fl t Ar ldisc
.Ar ttyname
.Sh DESCRIPTION
.Nm
is used to assign a tty line to a network interface which uses asynchronous
serial lines.
.Pp
Currently the
.Nm
command is used to attach
.Xr sl 4
or
.Xr strip 4
interfaces.
These interfaces have to be created using the
.Xr ifconfig 8
.Cm create
subcommand before the
.Nm
command.
The network source and destination addresses and other interface parameters
are configured via
.Xr ifconfig 8 .
.Pp
The following operands are supported by
.Nm :
.Bl -tag -width Ar
.It Fl H
Turn on DTR/CTS flow control.
By default, no flow control is done.
.It Fl h
Turn on RTS/CTS flow control.
By default, no flow control is done.
.It Fl l
Turn on the CLOCAL flag, making it possible to run SLIP on a cable
without modem control signals (e.g. DTR, DSR, DCD).
.It Fl m
Maintain modem control signals after closing the line.
Specifically, this disables HUPCL.
.It Fl n
Don't detach from invoking tty.
.It Fl s Ar baudrate
Specifies the speed of the connection.
If not specified, the default of 9600 is used.
.It Fl t Ar ldisc
Specifies the line discipline to use for the tty.
Supported line disciplines are
.Dq slip
(creates a
.Xr sl 4
instance) and
.Dq strip
(creates a
.Xr strip 4
instance).
If this option is not specified, the default is
.Dq slip .
.It Ar ttyname
Specifies the name of the tty device.
.Ar ttyname
should be a string of the form
.Ql ttyXX ,
or
.Ql /dev/ttyXX .
.El
.Pp
Only the super-user may attach a network interface.
.Pp
To detach the interface, use
.Dq Li ifconfig interface-name down
after killing off the
.Nm
process.
.Ar Interface-name
is the name that is shown by
.Xr netstat 1 .
.Sh EXAMPLES
.Bd -literal -offset indent -compact
slattach ttyh8
slattach \-s 4800 /dev/tty01
.Ed
.Sh DIAGNOSTICS
Messages indicating that the specified interface is not configured or created,
the requested address is unknown, or that the user is not privileged
but tried to alter an interface's configuration.
.Sh SEE ALSO
.Xr netstat 1 ,
.Xr daemon 3 ,
.Xr netintro 4 ,
.Xr sl 4 ,
.Xr strip 4 ,
.Xr ifconfig 8 ,
.Xr rc 8 ,
.Xr sliplogin 8 ,
.Xr slstats 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.3 .
.Sh BUGS
There is no way to specify the interface name (sl%d etc.) to be attached by the
.Nm
command.
There is no way to see which interface is assigned to the specified tty by the
.Nm
command, either.
.Pp
It would be better if the network interfaces were created by the
.Nm
command rather than by using the
.Xr ifconfig 8
.Cm create
subcommand before the
.Nm
command.
Misc fixes for sl(4) and slattach(8) man pages: - note that ifconfig(8) create subcommand is required before slattach(8) - network addresses aren't defined by slattach(8) but ifconfig(8) - Add a BUGS section in slattach(8) to note that currently there is no way to specify/see an interface name to be attached - move description about link[0-2] flags from slattach(8) to sl(4) (rather than adding a new description...) - move description about SLIP limitations to a new BUGS section in sl(4) - remove inappropriate MLINKS of slip.8 to slattach.8 - create MLINKS of slip.4 to sl.4 instead - add some more xrefs Ok'ed by christos, and closes PR kern/33672 and PR bin/33923. 2006-07-08 21:22:14 +04:00			`.\" $NetBSD: slattach.8,v 1.28 2006/07/08 17:22:14 tsutsui Exp $`
convert to new RCS Id conventions; reduce my headache 1995-03-18 17:54:19 +03:00			`.\"`
Merge with 4.4-Lite version. 1994-09-23 05:38:45 +04:00			`.\" Copyright (c) 1986, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22308, verified by myself. 2003-08-07 14:04:22 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
convert to new RCS Id conventions; reduce my headache 1995-03-18 17:54:19 +03:00			`.\" @(#)slattach.8 8.2 (Berkeley) 4/1/94`
added rcs ids to all files 1993-03-22 11:04:00 +03:00			`.\"`
Misc fixes for sl(4) and slattach(8) man pages: - note that ifconfig(8) create subcommand is required before slattach(8) - network addresses aren't defined by slattach(8) but ifconfig(8) - Add a BUGS section in slattach(8) to note that currently there is no way to specify/see an interface name to be attached - move description about link[0-2] flags from slattach(8) to sl(4) (rather than adding a new description...) - move description about SLIP limitations to a new BUGS section in sl(4) - remove inappropriate MLINKS of slip.8 to slattach.8 - create MLINKS of slip.4 to sl.4 instead - add some more xrefs Ok'ed by christos, and closes PR kern/33672 and PR bin/33923. 2006-07-08 21:22:14 +04:00			`.Dd July 8, 2006`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt SLATTACH 8`
Drop arguments of .Os. 2001-06-05 15:22:41 +04:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
Misc fixes for sl(4) and slattach(8) man pages: - note that ifconfig(8) create subcommand is required before slattach(8) - network addresses aren't defined by slattach(8) but ifconfig(8) - Add a BUGS section in slattach(8) to note that currently there is no way to specify/see an interface name to be attached - move description about link[0-2] flags from slattach(8) to sl(4) (rather than adding a new description...) - move description about SLIP limitations to a new BUGS section in sl(4) - remove inappropriate MLINKS of slip.8 to slattach.8 - create MLINKS of slip.4 to sl.4 instead - add some more xrefs Ok'ed by christos, and closes PR kern/33672 and PR bin/33923. 2006-07-08 21:22:14 +04:00			`.Nm slattach`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Nd attach serial lines as network interfaces`
fix type, from Mark Weaver 1994-04-01 07:45:41 +04:00			`.Sh SYNOPSIS`
* cleanup for WARNS=1 * fix .Nm usage * deprecate register 1997-09-15 15:20:04 +04:00			`.Nm`
Sort options. Improve english in DIAGNOSTICS. [Pointed at this file by augustss.] 2001-12-05 18:03:27 +03:00			`.Op Fl Hhlmn`
Add "-l" to "SYNOPSIS" section and use same order as "slattach" when printing command line usage. 1999-03-20 00:18:32 +03:00			`.Op Fl s Ar baudrate`
Sort options. Improve english in DIAGNOSTICS. [Pointed at this file by augustss.] 2001-12-05 18:03:27 +03:00			`.Op Fl t Ar ldisc`
Merge with 4.4-Lite version. 1994-09-23 05:38:45 +04:00			`.Ar ttyname`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
* cleanup for WARNS=1 * fix .Nm usage * deprecate register 1997-09-15 15:20:04 +04:00			`.Nm`
Misc fixes for sl(4) and slattach(8) man pages: - note that ifconfig(8) create subcommand is required before slattach(8) - network addresses aren't defined by slattach(8) but ifconfig(8) - Add a BUGS section in slattach(8) to note that currently there is no way to specify/see an interface name to be attached - move description about link[0-2] flags from slattach(8) to sl(4) (rather than adding a new description...) - move description about SLIP limitations to a new BUGS section in sl(4) - remove inappropriate MLINKS of slip.8 to slattach.8 - create MLINKS of slip.4 to sl.4 instead - add some more xrefs Ok'ed by christos, and closes PR kern/33672 and PR bin/33923. 2006-07-08 21:22:14 +04:00			`is used to assign a tty line to a network interface which uses asynchronous`
			`serial lines.`
			`.Pp`
			`Currently the`
			`.Nm`
			`command is used to attach`
			`.Xr sl 4`
			`or`
			`.Xr strip 4`
			`interfaces.`
			`These interfaces have to be created using the`
			`.Xr ifconfig 8`
			`.Cm create`
			`subcommand before the`
			`.Nm`
			`command.`
			`The network source and destination addresses and other interface parameters`
			`are configured via`
			`.Xr ifconfig 8 .`
			`.Pp`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`The following operands are supported by`
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.Nm :`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Bl -tag -width Ar`
Add support for DTR/CTS flow control, from Bill Studenmund. 1997-10-20 12:07:47 +04:00			`.It Fl H`
New sentence, new line. From Robert Elz. 2002-10-03 19:41:44 +04:00			`Turn on DTR/CTS flow control.`
			`By default, no flow control is done.`
Sort options. Improve english in DIAGNOSTICS. [Pointed at this file by augustss.] 2001-12-05 18:03:27 +03:00			`.It Fl h`
New sentence, new line. From Robert Elz. 2002-10-03 19:41:44 +04:00			`Turn on RTS/CTS flow control.`
			`By default, no flow control is done.`
add the ability to run SLIP with CLOCAL set, per PR#3586 1998-03-23 07:41:16 +03:00			`.It Fl l`
			`Turn on the CLOCAL flag, making it possible to run SLIP on a cable`
			`without modem control signals (e.g. DTR, DSR, DCD).`
Merge with 4.4-Lite version. 1994-09-23 05:38:45 +04:00			`.It Fl m`
New sentence, new line. From Robert Elz. 2002-10-03 19:41:44 +04:00			`Maintain modem control signals after closing the line.`
			`Specifically, this disables HUPCL.`
-n don't detach from tty 1999-09-03 17:29:44 +04:00			`.It Fl n`
			`Don't detach from invoking tty.`
Merge with 4.4-Lite version. 1994-09-23 05:38:45 +04:00			`.It Fl s Ar baudrate`
New sentence, new line. From Robert Elz. 2002-10-03 19:41:44 +04:00			`Specifies the speed of the connection.`
			`If not specified, the default of 9600 is used.`
Document the STRIP-related options. 1997-11-18 02:32:18 +03:00			`.It Fl t Ar ldisc`
New sentence, new line. From Robert Elz. 2002-10-03 19:41:44 +04:00			`Specifies the line discipline to use for the tty.`
			`Supported line disciplines are`
Document the STRIP-related options. 1997-11-18 02:32:18 +03:00			`.Dq slip`
			`(creates a`
			`.Xr sl 4`
			`instance) and`
			`.Dq strip`
			`(creates a`
			`.Xr strip 4`
			`instance).`
			`If this option is not specified, the default is`
			`.Dq slip .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Ar ttyname`
			`Specifies the name of the tty device.`
Sort options. Improve english in DIAGNOSTICS. [Pointed at this file by augustss.] 2001-12-05 18:03:27 +03:00			`.Ar ttyname`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`should be a string of the form`
			`.Ql ttyXX ,`
			`or`
			`.Ql /dev/ttyXX .`
			`.El`
			`.Pp`
			`Only the super-user may attach a network interface.`
			`.Pp`
			`To detach the interface, use`
			`.Dq Li ifconfig interface-name down`
			`after killing off the`
* cleanup for WARNS=1 * fix .Nm usage * deprecate register 1997-09-15 15:20:04 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`process.`
			`.Ar Interface-name`
			`is the name that is shown by`
Document what link[0-2] do. 1994-08-13 13:00:57 +04:00			`.Xr netstat 1 .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh EXAMPLES`
			`.Bd -literal -offset indent -compact`
			`slattach ttyh8`
patched w/changes from blymn@mulga.awadi.com.AU (Brett Lymn) to fix things like flow control support, SLIP option support etc. 1993-04-08 08:15:41 +04:00			`slattach \-s 4800 /dev/tty01`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ed`
			`.Sh DIAGNOSTICS`
Misc fixes for sl(4) and slattach(8) man pages: - note that ifconfig(8) create subcommand is required before slattach(8) - network addresses aren't defined by slattach(8) but ifconfig(8) - Add a BUGS section in slattach(8) to note that currently there is no way to specify/see an interface name to be attached - move description about link[0-2] flags from slattach(8) to sl(4) (rather than adding a new description...) - move description about SLIP limitations to a new BUGS section in sl(4) - remove inappropriate MLINKS of slip.8 to slattach.8 - create MLINKS of slip.4 to sl.4 instead - add some more xrefs Ok'ed by christos, and closes PR kern/33672 and PR bin/33923. 2006-07-08 21:22:14 +04:00			`Messages indicating that the specified interface is not configured or created,`
			`the requested address is unknown, or that the user is not privileged`
			`but tried to alter an interface's configuration.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
			`.Xr netstat 1 ,`
-n don't detach from tty 1999-09-03 17:29:44 +04:00			`.Xr daemon 3 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr netintro 4 ,`
Reference the new sl(4) page 1996-08-11 01:26:42 +04:00			`.Xr sl 4 ,`
Document the STRIP-related options. 1997-11-18 02:32:18 +03:00			`.Xr strip 4 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr ifconfig 8 ,`
Misc fixes for sl(4) and slattach(8) man pages: - note that ifconfig(8) create subcommand is required before slattach(8) - network addresses aren't defined by slattach(8) but ifconfig(8) - Add a BUGS section in slattach(8) to note that currently there is no way to specify/see an interface name to be attached - move description about link[0-2] flags from slattach(8) to sl(4) (rather than adding a new description...) - move description about SLIP limitations to a new BUGS section in sl(4) - remove inappropriate MLINKS of slip.8 to slattach.8 - create MLINKS of slip.4 to sl.4 instead - add some more xrefs Ok'ed by christos, and closes PR kern/33672 and PR bin/33923. 2006-07-08 21:22:14 +04:00			`.Xr rc 8 ,`
			`.Xr sliplogin 8 ,`
			`.Xr slstats 8`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.3 .`
Misc fixes for sl(4) and slattach(8) man pages: - note that ifconfig(8) create subcommand is required before slattach(8) - network addresses aren't defined by slattach(8) but ifconfig(8) - Add a BUGS section in slattach(8) to note that currently there is no way to specify/see an interface name to be attached - move description about link[0-2] flags from slattach(8) to sl(4) (rather than adding a new description...) - move description about SLIP limitations to a new BUGS section in sl(4) - remove inappropriate MLINKS of slip.8 to slattach.8 - create MLINKS of slip.4 to sl.4 instead - add some more xrefs Ok'ed by christos, and closes PR kern/33672 and PR bin/33923. 2006-07-08 21:22:14 +04:00			`.Sh BUGS`
			`There is no way to specify the interface name (sl%d etc.) to be attached by the`
			`.Nm`
			`command.`
			`There is no way to see which interface is assigned to the specified tty by the`
			`.Nm`
			`command, either.`
			`.Pp`
			`It would be better if the network interfaces were created by the`
			`.Nm`
			`command rather than by using the`
			`.Xr ifconfig 8`
			`.Cm create`
			`subcommand before the`
			`.Nm`
			`command.`