Update to upstream util-linux 2.20.1
[framework/base/util-linux-ng.git] / sys-utils / ldattach.8
1 .\" Copyright 2008 Tilman Schmidt (tilman@imap.cc)
2 .\" May be distributed under the GNU General Public License version 2 or later
3 .TH LDATTACH 8 "February 2010" "util-linux" "System Administration"
4 .SH NAME
5 ldattach \- attach a line discipline to a serial line
6 .SH SYNOPSIS
7 .B ldattach
8 .RB [ \-dhV78neo12 ]
9 .RB [ \-s
10 .IR speed ]
11 .RB [ \-i
12 .IR iflag ]
13 .I ldisc device
14 .SH DESCRIPTION
15 The
16 .B ldattach
17 daemon opens the specified
18 .I device
19 file
20 (which should refer to a serial device)
21 and attaches the line discipline
22 .I ldisc
23 to it for processing of the sent and/or received data.
24 It then goes into the background keeping the device open so that the
25 line discipline stays loaded.
26
27 The line discipline
28 .I ldisc
29 may be specified either by name
30 or by number.
31
32 In order to detach the line discipline,
33 .BR kill (1)
34 the
35 .B ldattach
36 process.
37
38 With no arguments,
39 .B ldattach
40 prints usage information.
41 .SH LINE DISCIPLINES
42 Depending on the kernel release, the following line disciplines are supported:
43 .TP
44 .BR TTY ( 0 )
45 The default line discipline,
46 providing transparent operation (raw mode)
47 as well as the habitual terminal line editing capabilities (cooked mode).
48 .TP
49 .BR SLIP ( 1 )
50 Serial Line IP (SLIP) protocol processor
51 for transmitting TCP/IP packets over serial lines.
52 .TP
53 .BR MOUSE ( 2 )
54 Device driver for RS232 connected pointing devices (serial mice).
55 .TP
56 .BR PPP ( 3 )
57 Point to Point Protocol (PPP) processor
58 for transmitting network packets over serial lines.
59 .TP
60 .BR STRIP ( 4 )
61 .TP
62 .BR AX25 ( 5 )
63 .TP
64 .BR X25 ( 6 )
65 Line driver for transmitting X.25 packets over asynchronous serial lines.
66 .TP
67 .BR 6PACK ( 7 )
68 .TP
69 .BR R3964 ( 9 )
70 Driver for Simatic R3964 module.
71 .TP
72 .BR IRDA ( 11 )
73 Linux IrDa (infrared data transmission) driver -
74 see http://irda.sourceforge.net/
75 .TP
76 .BR HDLC ( 13 )
77 Synchronous HDLC driver.
78 .TP
79 .BR SYNC_PPP ( 14 )
80 Synchronous PPP driver.
81 .TP
82 .BR HCI ( 15 )
83 Bluetooth HCI UART driver.
84 .TP
85 .BR GIGASET_M101 ( 16 )
86 Driver for Siemens Gigaset M101 serial DECT adapter.
87 .TP
88 .BR PPS ( 18 )
89 Driver for serial line Pulse Per Second (PPS) source.
90 .SH OPTIONS
91 .TP
92 \fB-d\fP | \fB--debug\fP
93 Causes
94 .B ldattach
95 to stay in the foreground so that it can be interrupted or debugged,
96 and to print verbose messages about its progress to the standard error output.
97 .TP
98 \fB-h\fP | \fB--help\fP
99 Prints a usage message and exits.
100 .TP
101 \fB-V\fP | \fB--version\fP
102 Prints the program version.
103 .TP
104 \fB-s\fP \fIvalue\fP | \fB--speed\fP \fIvalue\fP
105 Set the speed of the serial line to the specified value.
106 .TP
107 \fB-7\fP | \fB--sevenbits\fP
108 Sets the character size of the serial line to 7 bits.
109 .TP
110 \fB-8\fP | \fB--eightbits\fP
111 Sets the character size of the serial line to 8 bits.
112 .TP
113 \fB-n\fP | \fB--noparity\fP
114 Sets the parity of the serial line to none.
115 .TP
116 \fB-e\fP | \fB--evenparity\fP
117 Sets the parity of the serial line to even.
118 .TP
119 \fB-o\fP | \fB--oddparity\fP
120 Sets the parity of the serial line to odd.
121 .TP
122 \fB-1\fP | \fB--onestopbit\fP
123 Sets the number of stop bits of the serial line to one.
124 .TP
125 \fB-2\fP | \fB--twostopbits\fP
126 Sets the number of stop bits of the serial line to two.
127 .TP
128 \fB-i\fP \fIvalue\fP | \fB--iflag\fP [\fB-\fP]\fIvalue\fP{,...}
129 Sets the specified bits in the c_iflag word of the serial line.
130 \fIValue\fP may be a number or a symbolic name.
131 If \fIvalue\fP is prefixed by a minus sign, clear the specified bits instead.
132 Several comma separated \fIvalue\fPs may be given in order to
133 set and clear multiple bits.
134 .SH "SEE ALSO"
135 .BR inputattach (1),
136 .BR ttys (4)
137 .SH AUTHOR
138 .nf
139 Tilman Schmidt (tilman@imap.cc)
140 .fi
141 .SH AVAILABILITY
142 The ldattach command is part of the util-linux package
143 and is available from
144 ftp://ftp.kernel.org/pub/linux/utils/util-linux/.