~ubuntu-branches/debian/sid/bluez-utils/sid

« back to all changes in this revision

Viewing changes to debian/patches/003_manpages.patch

  • Committer: Bazaar Package Importer
  • Author(s): Edd Dumbill
  • Date: 2004-06-14 14:24:12 UTC
  • Revision ID: james.westby@ubuntu.com-20040614142412-4awiu57ivcrk0mcs
Tags: 2.7-4
* Add support for HID proxy dongles in the init script.  These
  will now be switched on after hidd starts.
* Don't scribble permissions for /dev/rfcomm* on each install
  (Closes: #231510)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
diff -u tools/hciattach.8 tools/hciattach.8
 
2
--- tools/hciattach.8   2004-05-09 11:39:43.000000000 +0100
 
3
+++ tools/hciattach.8   2004-05-26 13:02:35.000000000 +0100
 
4
@@ -3,44 +3,41 @@
 
5
 hciattach \- attach serial devices via UART HCI to BlueZ stack
 
6
 .SH SYNOPSIS
 
7
 .B hciattach
 
8
-[ -n ] [ -p ] [ -t timeout ] <
 
9
+.RB [\| \-n \|]
 
10
+.RB [\| \-p \|]
 
11
+.RB [\| \-t 
 
12
+.IR timeout \|]
 
13
 .I tty
 
14
-> <
 
15
-.I type
 
16
-|
 
17
-.I id
 
18
-> [
 
19
+.IR type \||\| id
 
20
 .I speed
 
21
-] [
 
22
 .I flow
 
23
-]
 
24
 .SH DESCRIPTION
 
25
 .LP
 
26
 Hciattach is used to attach a serial UART to the Bluetooth stack as HCI
 
27
 transport interface.
 
28
 .SH OPTIONS
 
29
 .TP
 
30
-.BI -n
 
31
+.B \-n
 
32
 Don't detach from controlling terminal.
 
33
 .TP
 
34
-.BI -p
 
35
+.B \-p
 
36
 Print the PID when detaching.
 
37
 .TP
 
38
-.BI -t timeout
 
39
+.BI \-t " timeout"
 
40
 Specify an initialization timeout.  (Default is 5 seconds.)
 
41
 .TP
 
42
-.I <tty>
 
43
+.I tty
 
44
 This specifies the serial device to attach. A leading
 
45
 .B /dev
 
46
 can be omitted. Examples:
 
47
 .B /dev/ttyS1
 
48
 .B ttyS2
 
49
 .TP
 
50
-.I <type | id>
 
51
+.IR type \||\| id
 
52
 The
 
53
-.B type
 
54
+.I type
 
55
 or
 
56
-.B id
 
57
+.I id
 
58
 of the Bluetooth device that is to be attached, i.e. vendor or other device
 
59
 specific identifier. Currently supported types are
 
60
 .RS
 
61
@@ -48,45 +45,45 @@
 
62
 .B type
 
63
 .B description
 
64
 .TP
 
65
-any
 
66
+.B any
 
67
 Unspecified HCI_UART interface, no vendor specific options
 
68
 .TP
 
69
-ericsson
 
70
+.B ericsson
 
71
 Ericsson based modules
 
72
 .TP
 
73
-digi
 
74
+.B digi
 
75
 Digianswer based cards
 
76
 .TP
 
77
-xircom
 
78
+.B xircom
 
79
 Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter
 
80
 .TP
 
81
-csr
 
82
+.B csr
 
83
 CSR Casira serial adapter or BrainBoxes serial dongle (BL642)
 
84
 .TP
 
85
-bboxes
 
86
+.B bboxes
 
87
 BrainBoxes PCMCIA card (BL620)
 
88
 .TP
 
89
-swave
 
90
+.B swave
 
91
 Silicon Wave kits
 
92
 .TP
 
93
-bcsp
 
94
+.B bcsp
 
95
 Serial adapters using CSR chips with BCSP serial protocol
 
96
 .RE
 
97
 
 
98
 Supported IDs are (manufacturer id, product id)
 
99
 .RS
 
100
 .TP
 
101
-0x0105, 0x080a
 
102
+.B 0x0105, 0x080a
 
103
 Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter
 
104
 .TP
 
105
-0x0160, 0x0002
 
106
+.B 0x0160, 0x0002
 
107
 BrainBoxes PCMCIA card (BL620)
 
108
 .RE
 
109
 
 
110
 .TP
 
111
-.I <speed>
 
112
+.I speed
 
113
 The
 
114
-.B speed
 
115
+.I speed
 
116
 specifies the UART speed to use. Baudrates higher than 115.200bps require
 
117
 vendor specific initializations that are not implemented for all types of
 
118
 devices. In general the following speeds are supported:
 
119
@@ -96,9 +93,9 @@
 
120
 Supported vendor devices are automatically initialised to their respective
 
121
 best settings.
 
122
 .TP
 
123
-.I <flow>
 
124
+.I flow
 
125
 If the keyword
 
126
-.B flow
 
127
+.I flow
 
128
 is appended to the list of options then hardware flow control is forced on
 
129
 the serial link (
 
130
 .B CRTSCTS
 
131
diff -u tools/hciconfig.8 tools/hciconfig.8
 
132
--- tools/hciconfig.8   2004-05-09 11:39:43.000000000 +0100
 
133
+++ tools/hciconfig.8   2004-05-26 13:02:35.000000000 +0100
 
134
@@ -2,83 +2,89 @@
 
135
 .SH NAME
 
136
 hciconfig \- configure Bluetooth devices
 
137
 .SH SYNOPSIS
 
138
-.B hciconfig -h
 
139
+.B hciconfig
 
140
+.B \-h
 
141
 .br
 
142
-.B hciconfig [-a]
 
143
+.B hciconfig
 
144
+.RB [\| \-a \|]
 
145
 .br
 
146
-.B hciconfig [-a] <hciX> [command [command parameters]]
 
147
+.B hciconfig
 
148
+.RB [\| \-a \|]
 
149
+.RI [\| command
 
150
+.RI [\| "command parameters" \|]\|]
 
151
 
 
152
 .SH DESCRIPTION
 
153
 .LP
 
154
-.B
 
155
-hciconfig
 
156
-is used to configure Bluetooth devices. <hciX> is the name of a Bluetooth
 
157
-device installed in the system. If <hciX> is not given,
 
158
-.B
 
159
-hciconfig
 
160
+.B hciconfig
 
161
+is used to configure Bluetooth devices.
 
162
+.I hciX
 
163
+is the name of a Bluetooth device installed in the system. If
 
164
+.I hciX
 
165
+is not given,
 
166
+.B hciconfig
 
167
 prints name and basic information about all the Bluetooth devices installed in
 
168
-the system. If <hciX> is given but no command is given,
 
169
-it prints basic information on device <hciX> only. Basic information is 
 
170
+the system. If
 
171
+.I hciX
 
172
+is given but no command is given, it prints basic information on device
 
173
+.I hciX
 
174
+only. Basic information is 
 
175
 interface type, BD address, ACL MTU, SCO MTU, flags (up, init, running, raw,
 
176
 page scan enabled, inquiry scan enabled, inquiry, authentication enabled,
 
177
 encryption enabled).
 
178
 .SH OPTIONS
 
179
 .TP
 
180
-.BI -h
 
181
+.B \-h, \-\-help
 
182
 Gives a list of possible commands
 
183
 .TP
 
184
-.BI -a
 
185
+.B \-a, \-\-all
 
186
 Other than the basic info, print features, packet type, link policy, link mode,
 
187
 name, class, version.
 
188
 .SH COMMANDS
 
189
 .TP
 
190
-.BI up
 
191
+.B up
 
192
 Open and initialize HCI device
 
193
 .TP
 
194
-.BI down
 
195
+.B down
 
196
 Close HCI device
 
197
 .TP
 
198
-.BI reset
 
199
+.B reset
 
200
 Reset HCI device
 
201
 .TP
 
202
-.BI rstat
 
203
+.B rstat
 
204
 Reset statistic counters
 
205
 .TP
 
206
-.BI auth
 
207
+.B auth
 
208
 Enable authentication
 
209
 .TP
 
210
-.BI noauth
 
211
+.B noauth
 
212
 Disable authentication
 
213
 .TP
 
214
-.BI encrypt
 
215
+.B encrypt
 
216
 Enable encryption
 
217
 .TP
 
218
-.BI noencrypt
 
219
+.B noencrypt
 
220
 Disable encryption
 
221
 .TP
 
222
-.BI piscan
 
223
+.B piscan
 
224
 Enable page and inquiry scan
 
225
 .TP
 
226
-.BI noscan
 
227
+.B noscan
 
228
 Disable page and inquiry scan
 
229
 .TP
 
230
-.BI iscan
 
231
+.B iscan
 
232
 Enable inquiry scan, disable page scan
 
233
 .TP
 
234
-.BI pscan
 
235
+.B pscan
 
236
 Enable page scan, disable inquiry scan
 
237
 .TP
 
238
-.BI ptype " [type]"
 
239
+\fBptype\fP [\fItype\fP]
 
240
 With no
 
241
-.I
 
242
-type
 
243
+.I type
 
244
 , displays the current packet types. Otherwise, all the packet types specified
 
245
 by
 
246
-.I
 
247
-type
 
248
+.I type
 
249
 are set.
 
250
-.I
 
251
-type
 
252
+.I type
 
253
 is a comma-separated list of packet types, where the possible packet types are
 
254
 .BR DM1 ,
 
255
 .BR DM3 ,
 
256
@@ -111,8 +117,7 @@
 
257
 .IR voice ,
 
258
 prints voice setting. Otherwise, sets voice setting to
 
259
 .IR voice .
 
260
-.I
 
261
-voice
 
262
+.I voice
 
263
 is a 16-bit hex number describing the voice setting.
 
264
 .TP
 
265
 .BI iac " [iac]"
 
266
@@ -127,9 +132,9 @@
 
267
 prints out the current inquiry mode. Otherwise, sets inquiry mode to
 
268
 .IR mode .
 
269
 .TP
 
270
-.BI inqparms " [win:int]"
 
271
+\fBinqparams\fP [\fIwin\fP:\fIint\fP]
 
272
 With no
 
273
-.IR win:int ,
 
274
+.IR win : int ,
 
275
 prints inquiry scan window and interval. Otherwise, sets inquiry scan window
 
276
 to
 
277
 .I win
 
278
@@ -137,23 +142,20 @@
 
279
 .I int
 
280
 slots.
 
281
 .TP
 
282
-.BI pageparms " [win:int]"
 
283
+\fBpageparms\fP [\fIwin\fP:\fIint\fP]
 
284
 With no
 
285
-.IR win:int ,
 
286
+.IR win : int ,
 
287
 prints page scan window and interval. Otherwise, sets page scan window to
 
288
-.I
 
289
-win
 
290
+.I win
 
291
 slots and page scan interval to
 
292
-.I 
 
293
-int
 
294
+.I int
 
295
 slots.
 
296
 .TP
 
297
 .BI pageto " [to]"
 
298
 With no
 
299
 .IR to ,
 
300
 prints page timeout. Otherwise, sets page timeout
 
301
-to
 
302
-.I
 
303
+to .I
 
304
 to
 
305
 slots.
 
306
 .TP
 
307
@@ -163,19 +165,16 @@
 
308
 prints out the current AFH mode. Otherwise, sets AFH mode to
 
309
 .IR mode .
 
310
 .TP
 
311
-.BI aclmtu " <mtu:pkt>"
 
312
+\fBaclmtu\fP \fImtu\fP:\fIpkt\fP
 
313
 Sets ACL MTU to
 
314
 to
 
315
-.I
 
316
-mtu
 
317
+.I mtu
 
318
 bytes and ACL buffer size to
 
319
-.I
 
320
-pkt
 
321
+.I pkt
 
322
 packets.
 
323
 .TP
 
324
-.BI scomtu " <mtu:pkt>"
 
325
+\fBscomtu\fP \fImtu\fP:\fIpkt\fP
 
326
 Sets SCO MTU to
 
327
-to
 
328
 .I mtu
 
329
 bytes and SCO buffer size to
 
330
 .I pkt
 
331
@@ -192,43 +191,34 @@
 
332
 .TP
 
333
 .BI lm " [mode]"
 
334
 With no
 
335
-.I
 
336
-mode
 
337
+.I mode
 
338
 , prints link mode.
 
339
-.B
 
340
-MASTER
 
341
+.B MASTER
 
342
 or
 
343
-.B
 
344
-SLAVE
 
345
+.B SLAVE
 
346
 mean, respectively, to ask to become master or to remain slave when a
 
347
 connection request comes in. The additional keyword
 
348
-.B
 
349
-ACCEPT
 
350
+.B ACCEPT
 
351
 means that baseband  connections will be accepted even if there are no
 
352
 listening
 
353
 .I AF_BLUETOOTH
 
354
 sockets.
 
355
 .I mode
 
356
 is
 
357
-.B
 
358
-NONE
 
359
+.B NONE
 
360
 or a comma-separated list of keywords, where possible keywords are
 
361
-.B 
 
362
-MASTER
 
363
+.B MASTER
 
364
 and
 
365
 .B "ACCEPT" .
 
366
-.B
 
367
-NONE
 
368
+.B NONE
 
369
 sets link policy to the default behaviour of remaining slave and not accepting
 
370
 baseband connections when there are no listening
 
371
 .I AF_BLUETOOTH
 
372
 sockets. If
 
373
-.B
 
374
-MASTER
 
375
+.B MASTER
 
376
 is present, the device will ask to become master if a connection request comes
 
377
 in. If
 
378
-.B
 
379
-ACCEPT
 
380
+.B ACCEPT
 
381
 is present, the device will accept baseband connections even when there are no
 
382
 listening
 
383
 .I AF_BLUETOOTH
 
384
diff -u tools/l2ping.1 tools/l2ping.1
 
385
--- tools/l2ping.1      2004-05-09 11:39:43.000000000 +0100
 
386
+++ tools/l2ping.1      2004-05-26 13:02:35.000000000 +0100
 
387
@@ -3,38 +3,36 @@
 
388
 l2ping \- Send L2CAP echo request and receive answer
 
389
 .SH SYNOPSIS
 
390
 .B l2ping
 
391
-[
 
392
-.I -S source addr
 
393
-] [
 
394
-.I -s size
 
395
-] [
 
396
-.I -c count
 
397
-] [
 
398
-.I -f
 
399
-] <
 
400
+.RB [\| \-S
 
401
+.IR source\-addr \|]
 
402
+.RB [\| \-s
 
403
+.IR size \|]
 
404
+.RB [\| \-c
 
405
+.IR count \|]
 
406
+.RB [\| \-f \|]
 
407
 .I bd_addr
 
408
->
 
409
+
 
410
 .SH DESCRIPTION
 
411
 .LP
 
412
 L2ping sends a L2CAP echo request to the Bluetooth MAC address
 
413
-.B bd_addr
 
414
+.I bd_addr
 
415
 given in dotted hex notation.
 
416
 .SH OPTIONS
 
417
 .TP
 
418
-.I -S source addr
 
419
+.BI \-S " source\-addr"
 
420
 Select address to be used as source address for the request.
 
421
 .TP
 
422
-.I -s size
 
423
+.BI \-s " size"
 
424
 The
 
425
-.B size
 
426
+.I size
 
427
 of the data packets to be sent.
 
428
 .TP
 
429
-.I -c count
 
430
+.BI \-c " count"
 
431
 Send
 
432
-.B count
 
433
+.I count
 
434
 number of packets then exit.
 
435
 .TP
 
436
-.I -f
 
437
+.B \-f
 
438
 Kind of flood ping. Use with care! It reduces the delay time between packets
 
439
 to 0.
 
440
 .TP