sbin/slattach/slattach.8

   1 .\"     $NetBSD: slattach.8,v 1.27 2003/08/07 10:04:40 agc 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. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)slattach.8  8.2 (Berkeley) 4/1/94
  31 .\"
  32 .Dd July 8, 2006
  33 .Dt SLATTACH 8
  34 .Os
  35 .Sh NAME
  36 .Nm slattach
  37 .Nd attach serial lines as network interfaces
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl Hhlmn
  41 .Op Fl s Ar baudrate
  42 .Op Fl t Ar ldisc
  43 .Ar ttyname
  44 .Sh DESCRIPTION
  45 .Nm
  46 is used to assign a tty line to a network interface which uses asynchronous
  47 serial lines.
  48 .Pp
  49 Currently the
  50 .Nm
  51 command is used to attach
  52 .Xr sl 4
  53 or
  54 .Xr strip 4
  55 interfaces.
  56 These interfaces have to be created using the
  57 .Xr ifconfig 8
  58 .Cm create
  59 subcommand before the
  60 .Nm
  61 command.
  62 The network source and destination addresses and other interface parameters
  63 are configured via
  64 .Xr ifconfig 8 .
  65 .Pp
  66 The following operands are supported by
  67 .Nm :
  68 .Bl -tag -width Ar
  69 .It Fl H
  70 Turn on DTR/CTS flow control.
  71 By default, no flow control is done.
  72 .It Fl h
  73 Turn on RTS/CTS flow control.
  74 By default, no flow control is done.
  75 .It Fl l
  76 Turn on the CLOCAL flag, making it possible to run SLIP on a cable
  77 without modem control signals (e.g. DTR, DSR, DCD).
  78 .It Fl m
  79 Maintain modem control signals after closing the line.
  80 Specifically, this disables HUPCL.
  81 .It Fl n
  82 Don't detach from invoking tty.
  83 .It Fl s Ar baudrate
  84 Specifies the speed of the connection.
  85 If not specified, the default of 9600 is used.
  86 .It Fl t Ar ldisc
  87 Specifies the line discipline to use for the tty.
  88 Supported line disciplines are
  89 .Dq slip
  90 (creates a
  91 .Xr sl 4
  92 instance) and
  93 .Dq strip
  94 (creates a
  95 .Xr strip 4
  96 instance).
  97 If this option is not specified, the default is
  98 .Dq slip .
  99 .It Ar ttyname
 100 Specifies the name of the tty device.
 101 .Ar ttyname
 102 should be a string of the form
 103 .Ql ttyXX ,
 104 or
 105 .Ql /dev/ttyXX .
 106 .El
 107 .Pp
 108 Only the super-user may attach a network interface.
 109 .Pp
 110 To detach the interface, use
 111 .Dq Li ifconfig interface-name down
 112 after killing off the
 113 .Nm
 114 process.
 115 .Ar Interface-name
 116 is the name that is shown by
 117 .Xr netstat 1 .
 118 .Sh EXAMPLES
 119 .Bd -literal -offset indent -compact
 120 slattach ttyh8
 121 slattach \-s 4800 /dev/tty01
 122 .Ed
 123 .Sh DIAGNOSTICS
 124 Messages indicating that the specified interface is not configured or created,
 125 the requested address is unknown, or that the user is not privileged
 126 but tried to alter an interface's configuration.
 127 .Sh SEE ALSO
 128 .Xr netstat 1 ,
 129 .Xr daemon 3 ,
 130 .Xr netintro 4 ,
 131 .Xr sl 4 ,
 132 .Xr strip 4 ,
 133 .Xr ifconfig 8 ,
 134 .Xr rc 8 ,
 135 .Xr sliplogin 8 ,
 136 .Xr slstats 8
 137 .Sh HISTORY
 138 The
 139 .Nm
 140 command appeared in
 141 .Bx 4.3 .
 142 .Sh BUGS
 143 There is no way to specify the interface name (sl%d etc.) to be attached by the
 144 .Nm
 145 command.
 146 There is no way to see which interface is assigned to the specified tty by the
 147 .Nm
 148 command, either.
 149 .Pp
 150 It would be better if the network interfaces were created by the
 151 .Nm
 152 command rather than by using the
 153 .Xr ifconfig 8
 154 .Cm create
 155 subcommand before the
 156 .Nm
 157 command.