Add new manpages and update the old ones

5 files changed, 362 insertions, 2 deletions

diff --git a/tools/Makefile.am b/tools/Makefile.am
index 9ff29c14..0513c83b 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -7,7 +7,7 @@ mandir = $(prefix)/usr/share/man
 sbin_PROGRAMS = hciattach hciconfig
 bin_PROGRAMS  = hcitool l2ping
 
-man_MANS      = hciattach.8 l2ping.8
+man_MANS      = hciattach.8 hciconfig.8 hcitool.1 l2ping.1
 
 noinst_PROGRAMS	= ppporc
 
diff --git a/tools/hciattach.8 b/tools/hciattach.8
index b327336b..812c40dc 100644
--- a/tools/hciattach.8
+++ b/tools/hciattach.8
@@ -59,6 +59,9 @@ BrainBoxes PCMCIA card (BL620)
 .TP
 swave
 Silicon Wave kits
+.TP
+bcsp
+Serial adapters using CSR chips with BCSP serial protocol
 .RE
 
 Supported IDs are (manufacturer id, product id)
diff --git a/tools/hciconfig.8 b/tools/hciconfig.8
new file mode 100644
index 00000000..bf13c2bd
--- /dev/null
+++ b/tools/hciconfig.8
@@ -0,0 +1,212 @@
+.TH HCICONFIG 1 "Nov 11 2002" BlueZ "Linux System Administration"
+.SH NAME
+hciconfig \- configure Bluetooth devices
+.SH SYNOPSIS
+.B hciconfig -h
+.br
+.B hciconfig [-a]
+.br
+.B hciconfig [-a] <hciX> [command [command parameters]]
+
+.SH DESCRIPTION
+.LP
+.B
+hciconfig
+is used to configure Bluetooth devices. <hciX> is the name of a Bluetooth
+device installed in the system. If <hciX> is not given,
+.B
+hciconfig
+prints name and basic information about all the Bluetooth devices installed in
+the system. If <hciX> is given but no command is given,
+it prints basic information on device <hciX> only. Basic information is 
+interface type, BD address, ACL MTU, SCO MTU, flags (up, init, running, raw,
+page scan enabled, inquiry scan enabled, inquiry, authentication enabled,
+encryption enabled).
+.SH OPTIONS
+.TP
+.BI -h
+Gives a list of possible commands
+.TP
+.BI -a
+Other than the basic info, print features, packet type, link policy, link mode,
+name, class, version.
+.SH COMMANDS
+.TP
+.BI up
+Open and initialize HCI device
+.TP
+.BI down
+Close HCI device
+.TP
+.BI reset
+Reset HCI device
+.TP
+.BI rstat
+Reset statistic counters
+.TP
+.BI auth
+Enable authentication
+.TP
+.BI noauth
+Disable authentication
+.TP
+.BI encrypt
+Enable encryption
+.TP
+.BI noencrypt
+Disable encryption
+.TP
+.BI piscan
+Enable page and inquiry scan
+.TP
+.BI noscan
+Disable page and inquiry scan
+.TP
+.BI iscan
+Enable inquiry scan, disable page scan
+.TP
+.BI pscan
+Enable page scan, disable inquiry scan
+.TP
+.BI ptype " [type]"
+With no
+.I
+type
+, displays the current packet types. Otherwise, all the packet types specified
+by
+.I
+type
+are set.
+.I
+type
+is a comma-separated list of packet types, where the possible packet types are
+.BR DM1 ,
+.BR DM3 ,
+.BR DM5 ,
+.BR DH1 ,
+.BR DH3 ,
+.BR DH5 ,
+.BR HV1 ,
+.BR HV2 ,
+.BR HV3 .
+.TP
+.BI name " [name]"
+With no
+.IR name ,
+prints local name. Otherwise, sets local name to
+.IR name .
+.TP
+.BI class " [class]"
+With no
+.IR class ,
+prints class of device. Otherwise, sets class of device to
+.IR class .
+.I
+class
+is a 24-bit hex number describing the class of device, as specified in section
+1.2 of the Bluetooth Assigned Numers document.
+.TP
+.BI inqparms " [win:int]"
+With no
+.IR win:int ,
+prints inquiry scan window and interval. Otherwise, sets inquiry scan window
+to
+.I win
+slots and inquiry scan interval to
+.I int
+slots.
+.TP
+.BI pageparms " [win:int]"
+With no
+.IR win:int ,
+prints page scan window and interval. Otherwise, sets page scan window to
+.I
+win
+slots and page scan interval to
+.I 
+int
+slots.
+.TP
+.BI pageto " [to]"
+With no
+.IR to ,
+prints page timeout. Otherwise, sets page timeout
+to
+.I
+to
+slots.
+.TP
+.BI aclmtu " <mtu:pkt>"
+Sets ACL MTU to
+to
+.I
+mtu
+bytes and ACL buffer size to
+.I
+pkt
+packets.
+.TP
+.BI scomtu " <mtu:pkt>"
+Sets SCO MTU to
+to
+.I mtu
+bytes and SCO buffer size to
+.I pkt
+packets.
+.TP
+.BI features
+Display device features
+.TP
+.BI version
+Display version information
+.TP
+.BI revision
+Display revision information
+.TP
+.BI lm " [mode]"
+With no
+.I
+mode
+, prints link mode.
+.B
+MASTER
+or
+.B
+SLAVE
+mean, respectively, to ask to become master or to remain slave when a
+connection request comes in. The additional keyword
+.B
+ACCEPT
+means that baseband  connections will be accepted even if there are no
+listening
+.I AF_BLUETOOTH
+sockets.
+.I mode
+is
+.B
+NONE
+or a comma-separated list of keywords, where possible keywords are
+.B 
+MASTER
+and
+.B "ACCEPT" .
+.B
+NONE
+sets link policy to the default behaviour of remaining slave and not accepting
+baseband connections when there are no listening
+.I AF_BLUETOOTH
+sockets. If
+.B
+MASTER
+is present, the device will ask to become master if a connection request comes
+in. If
+.B
+ACCEPT
+is present, the device will accept baseband connections even when there are no
+listening
+.I AF_BLUETOOTH
+sockets
+.SH AUTHORS
+Written by Maxim Krasnyansky <maxk@qualcomm.com>
+.PP
+man page by Fabrizio Gennari <fabrizio.gennari@philips.com>
diff --git a/tools/hcitool.1 b/tools/hcitool.1
new file mode 100644
index 00000000..49b5e715
--- /dev/null
+++ b/tools/hcitool.1
@@ -0,0 +1,145 @@
+.TH HCITOOL 1 "Nov 12 2002" BlueZ "Linux System Administration"
+.SH NAME
+hcitool \- configure Bluetooth connections
+.SH SYNOPSIS
+.B hcitool [-h]
+.br
+.B hcitool [-i <hciX>] [command [command parameters]]
+
+.SH DESCRIPTION
+.LP
+.B
+hcitool
+is used to configure Bluetooth connections and send some special command to
+Bluetooth devices. If no
+.B
+command
+is given, or if the option
+.B
+-h
+is used,
+.B
+hcitool
+prints some usage information and exits.
+.SH OPTIONS
+.TP
+.BI -h
+Gives a list of possible commands
+.TP
+.BI -i " <hciX>"
+The command is applied to device
+.I
+hciX
+, which must be the name of an installed Bluetooth device. If not specified,
+the command will be sent to the first available Bluetooth device.
+.SH COMMANDS
+.TP
+.BI dev
+Display local devices
+.TP
+.BI inq
+Inquire remote devices. For each discovered device, Bluetooth device address,
+clock offset and class are printed.
+.TP
+.BI scan
+Inquire remote devices. For each discovered device, device name is printed.
+.TP
+.BI name " <bdaddr>"
+Print device name of remote device with Bluetooth address
+.IR bdaddr .
+.TP
+.BI info " <bdaddr>"
+Print device name, version and supported features of remote device with
+Bluetooth address
+.IR bdaddr .
+.TP
+.BI cmd " <ogf> <ocf> [parameters]"
+Submit an arbitrary HCI command to local device.
+.IR ogf ,
+.IR ocf
+and
+.IR parameters
+are hexadecimal bytes
+.TP
+.BI con
+Display active baseband connections
+.TP
+.BI cc " [--role=m|s] [--pkt-type=<ptype>] <bdaddr>"
+Create baseband connection to remote device with Bluetooth address
+.IR bdaddr .
+Option
+.I
+--pkt-type
+specifies a list of allowed packet types.
+.I
+<ptype>
+is a comma-separated list of packet types, where the possible packet types are
+.BR DM1 ,
+.BR DM3 ,
+.BR DM5 ,
+.BR DH1 ,
+.BR DH3 ,
+.BR DH5 ,
+.BR HV1 ,
+.BR HV2 ,
+.BR HV3 .
+Default is to allow all packet types. Option
+.I
+--role
+can have value
+.I
+m
+(do not allow role switch, stay master) or
+.I
+s
+(allow role switch, become slave if the peer asks to become master). Default is
+.IR m .
+.TP
+.BI dc " <bdaddr>"
+Delete baseband connection from remote device with Bluetooth address
+.IR bdaddr .
+.TP
+.BI cpt " <bdaddr> <packet types>"
+Change packet types for baseband connection to device with Bluetooth address
+.IR bdaddr .
+.I
+packet types
+is a comma-separated list of packet types, where the possible packet types are
+.BR DM1 ,
+.BR DM3 ,
+.BR DM5 ,
+.BR DH1 ,
+.BR DH3 ,
+.BR DH5 ,
+.BR HV1 ,
+.BR HV2 ,
+.BR HV3 .
+.TP
+.BI rssi " <bdaddr>"
+Display received signal strength information for the connection to the device
+with Bluetooth address
+.IR bdaddr .
+.TP
+.BI lq " <bdaddr>"
+Display link quality for the connection to the device with Bluetooth address
+.IR bdaddr .
+.TP
+.BI lst " <bdaddr> [value]"
+With no
+.IR value ,
+displays link supervision timeout for the connection to the device with Bluetooth address
+.IR bdaddr .
+If
+.I
+value
+is given, sets the link supervision timeout for that connection to
+.I
+value
+slots, or to infinite if
+.I
+value
+is 0.
+.SH AUTHORS
+Written by Maxim Krasnyansky <maxk@qualcomm.com>
+.PP
+man page by Fabrizio Gennari <fabrizio.gennari@philips.com>
diff --git a/tools/l2ping.8 b/tools/l2ping.1
index 41becdba..186e5056 100644
--- a/tools/l2ping.8
+++ b/tools/l2ping.1
@@ -1,4 +1,4 @@
-.TH L2PING 8 "Jan 22 2002" BlueZ "Linux System Administration"
+.TH L2PING 1 "Jan 22 2002" BlueZ "Linux System Administration"
 .SH NAME
 l2ping \- Send L2CAP echo request and receive answer
 .SH SYNOPSIS