]> git.ipfire.org Git - thirdparty/util-linux.git/blob - sys-utils/ldattach.8
libdisk: write sample output to stdout
[thirdparty/util-linux.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 "July 2014" "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 [ \-1278denoVh ]
9 .RB [ \-i
10 .IR iflag ]
11 .RB [ \-s
12 .IR speed ]
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 .sp
27 The line discipline
28 .I ldisc
29 may be specified either by name
30 or by number.
31 .sp
32 In order to detach the line discipline,
33 .BR kill (1)
34 the
35 .B ldattach
36 process.
37 .sp
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 .TP
91 .BR GSM0710 ( 21 )
92 Driver for GSM 07.10 multiplexing protocol modem (CMUX).
93 .SH OPTIONS
94 .TP
95 .BR \-1 , " \-\-onestopbit"
96 Set the number of stop bits of the serial line to one.
97 .TP
98 .BR \-2 , " \-\-twostopbits"
99 Set the number of stop bits of the serial line to two.
100 .TP
101 .BR \-7 , " \-\-sevenbits"
102 Set the character size of the serial line to 7 bits.
103 .TP
104 .BR \-8 , " \-\-eightbits"
105 Set the character size of the serial line to 8 bits.
106 .TP
107 .BR \-d , " \-\-debug"
108 Keep
109 .B ldattach
110 in the foreground so that it can be interrupted or debugged,
111 and to print verbose messages about its progress to standard error output.
112 .TP
113 .BR \-e , " \-\-evenparity"
114 Set the parity of the serial line to even.
115 .TP
116 .BR -i , " --iflag " [ \- ] \fIvalue\fR...
117 Set the specified bits in the c_iflag word of the serial line.
118 The given \fIvalue\fP may be a number or a symbolic name.
119 If \fIvalue\fP is prefixed by a minus sign, the specified bits are cleared
120 instead. Several comma-separated values may be given in order to
121 set and clear multiple bits.
122 .TP
123 .BR \-n , " \-\-noparity"
124 Set the parity of the serial line to none.
125 .TP
126 .BR \-o , " \-\-oddparity"
127 Set the parity of the serial line to odd.
128 .TP
129 .BR \-s , " \-\-speed " \fIvalue
130 Set the speed (the baud rate) of the serial line to the specified \fIvalue\fR.
131 .TP
132 .BR \-c , " \-\-intro\-command " \fIstring
133 Define an intro command that is sent through the serial line before the invocation
134 of ldattach. E.g. in conjunction with line discipline GSM0710, the command
135 \'AT+CMUX=0\\r\' is commonly suitable to switch the modem into the CMUX mode.
136 .TP
137 .BR \-p , " \-\-pause " \fIvalue
138 Sleep for \fIvalue\fR seconds before the invocation of ldattach. Default is one second.
139 .TP
140 .BR \-V , " \-\-version"
141 Display version information and exit.
142 .TP
143 .BR \-h , " \-\-help"
144 Display help text and exit.
145 .SH "SEE ALSO"
146 .BR inputattach (1),
147 .BR ttys (4)
148 .SH AUTHOR
149 .nf
150 Tilman Schmidt (tilman@imap.cc)
151 .fi
152 .SH AVAILABILITY
153 The ldattach command is part of the util-linux package
154 and is available from
155 https://www.kernel.org/pub/linux/utils/util-linux/.