Add manpages for hcid and hcid.conf

3 files changed, 276 insertions, 1 deletions

diff --git a/hcid/Makefile.am b/hcid/Makefile.am
index 14428722..ba00df7e 100644
--- a/hcid/Makefile.am
+++ b/hcid/Makefile.am
@@ -2,6 +2,8 @@
 #  $Id$
 #
 
+mandir = $(prefix)/usr/share/man
+
 sbin_PROGRAMS = hcid
 
 if ENABLE_DBUS
@@ -13,11 +15,13 @@ endif
 hcid_SOURCES = main.c security.c hcid.h lib.c lib.h parser.h parser.y lexer.l kword.h kword.c glib-ectomy.h glib-ectomy.c $(dbus_hcid_sources)
 hcid_CONFIG  = hcid.conf
 
+man_MANS = hcid.8 hcid.conf.5
+
 YFLAGS   = -d
 
 CLEANFILES = lexer.c parser.c parser.h
 
-EXTRA_DIST = $(hcid_CONFIG)
+EXTRA_DIST = $(hcid_CONFIG) $(man_MANS) dbus.c
 
 #
 # Install configuration files
diff --git a/hcid/hcid.8 b/hcid/hcid.8
new file mode 100644
index 00000000..2ef8ed31
--- /dev/null
+++ b/hcid/hcid.8
@@ -0,0 +1,39 @@
+.\" 
+.TH "HCID" "8" "March 2004" "hcid - HCI daemon" "System management commands"
+.SH "NAME"
+hcid \- Bluetooth Host Controller Interface Daemon
+
+.SH "SYNOPSIS"
+.B hcid
+[
+.B \-n
+] [
+.B \-f
+.I config\-file
+]
+
+.SH "DESCRIPTION"
+This manual page documents briefly the
+.B hcid
+daemon, which manages all the Bluetooth devices. 
+.B hcid
+itself does not accept many command\-line options, as most of its
+configuration is done in the 
+.B hcid.conf
+file, which has its own man page.
+.SH "OPTIONS"
+.TP 
+.B \-n
+Don't fork to run daemon in background.
+.TP 
+.BI \-f\ config\-file
+Use alternate configuration file instead of /etc/bluetooth/hcid.conf
+.SH "FILES"
+.TP 
+.I /etc/bluetooth/hcid.conf
+Default location of the global configuration file.
+
+.SH "SEE ALSO"
+\fBhcid.conf\fR(5)
+.SH "AUTHOR"
+This manual page was written by Philipp Matthias Hahn.
diff --git a/hcid/hcid.conf.5 b/hcid/hcid.conf.5
new file mode 100644
index 00000000..4bac6de1
--- /dev/null
+++ b/hcid/hcid.conf.5
@@ -0,0 +1,232 @@
+.TH "HCID.CONF" "5" "March 2004" "hcid.conf - HCI daemon" "System management commands"
+.SH "NAME"
+/etc/bluetooth/hcid.conf \- Configuration file for the hcid Bluetooth HCI daemon
+
+.SH "DESCRIPTION"
+/etc/bluetooth/hcid.conf contains all the options needed by the Bluetooth Host Controller Interface daemon.
+
+It consists of sections and parameters. A section begins with
+the name of the section followed by optional specifiers and the
+parameters inside curly brackets. Sections contain parameters of
+the form:
+.TP 
+\fIname\fP \fIvalue1\fP, \fIvalue2\fP ... ;
+
+.PP 
+Any character after a hash ('#') character is ignored until newline.
+Whitespace is also ignored.
+
+
+The valid section names for
+.B hcid.conf
+are, at the moment:
+
+.TP 
+.B options
+contains generic options for hcid and the pairing policy.
+.TP 
+.B device
+contains lower\-level options for the hci devices connected to the computer.
+.SH "OPTIONS SECTION"
+The following parameters may be present in an option section:
+
+
+.TP 
+\fBautoinit\fP  yes|no
+
+Automatically initialize newly connected devices. The default is \fIno\fP.
+
+
+.TP 
+\fBpairing\fP  none|multi|once
+
+\fInone\fP means that pairing is disabled. \fImulti\fP allows pairing
+with already paired devices. \fIonce\fP allows pairing once and denies
+successive attempts. The default hcid configuration is shipped with \fBmulti\fP
+enabled
+
+.TP 
+\fBpin_helper\fP "\fIfile\fP"
+
+The path to the PIN helper application. The default is "/bin/bluepin".
+The following output is expected from the PIN helper:
+
+PIN:12345678
+
+Or, when no PIN is available:
+
+ERR
+
+.TP 
+\fBsecurity\fP  none|auto|user
+
+\fInone\fP means the security manager is disabled. \fIauto\fP uses
+local PIN for incoming connections. \fIuser\fP always asks the user
+for a PIN.
+
+.SH "DEVICE SECTION"
+Parameters within a device section with no specifier, the default
+device section, will be applied to all devices and device sections
+where these are unspecified. The following optional device specifiers
+are supported:
+
+.TP 
+\fInn\fP\fB:\fP\fInn\fP\fB:\fP\fInn\fP\fB:\fP\fInn\fP\fB:\fP\fInn\fP\fB:\fP\fInn\fP
+
+Parameters specified within this section will be applied to the device
+with this \fIdevice bluetooth address\fP. All other parameters are applied from
+the default section.
+
+.TP 
+\fBhci\fIn\fP
+
+Parameters specified within this section will be applied to the device
+with this \fIdevice interface\fP, unless that device is matched by a
+\fIdevice address\fP section. All other parameters are applied from
+the default section.
+
+
+.PP 
+\fBNote\fP: Most of the options supported in the \fBdevice\fP section are described to some extent in the bluetooth specification version 1.2 Vol2, Part E section 6. Please refer to it for technical details.
+
+.PP 
+The following parameters may be present in a device section:
+
+.TP 
+\fBname\fP  "\fIname\fP"
+
+The device name. \fI%d\fP inserts the device id. \fI%h\fP inserts
+the host name.
+
+
+.TP 
+\fBauth\fP  enable|disable
+Enables or disables authentication between local and remote devices when they connect.
+
+Authentication is done following a challenge\-response mechanism described in the Bluetooth Specification 1.2 volume 2 part C section 4.2, and uses the link key generated during pairing as the shared secret.
+
+.TP 
+\fBencrypt\fP  enable|disable
+Enable or disable link encryption. Should be set to enable in most cases, unless one of the devices does not support encryption for some reason.
+
+Encryption can only occur on authenticated connections, as a shared secret key is necessary for encryption to work. The detailed encryption mechanism is described in the bluetooth specification as mentioned above.
+
+
+.TP 
+\fBclass\fP  0x\fISSDDdd\fP (three bytes)
+
+The Bluetooth Device Class is described in the Bluetooth Specification section 1.2 ("Assigned Numbers \- Bluetooth Baseband").
+
+The default shipped with hcid is 0x000100 which simply stands for "Computer".
+
+The Bluetooth device class is a high\-level description of the bluetooth device, composed of three bytes: the "Major Service Class" (byte "SS" above), the "Major Device Class" (byte "DD" above) and the "Minor Device Class" (byte "dd" above). These classes describe the high\-level capabilities of the device, such as "Networking Device", "Computer", etc. This information is often used by clients who are looking for a certain type of service around them.
+
+Where it becomes tricky is that another type of mechanism for service discovery exists: "SDP", as in "Service Discovery Protocol".
+
+In practice, most Bluetooth clients scan their surroundings in two successive steps: they first look for all bluetooth devices around them and find out their "class". You can do this on Linux with the \fBhcitool scan\fP command. Then, they use SDP in order to check if a device in a given class offers the type of service that they want.
+
+This means that the hcid.conf "class" parameter needs to be set up properly if particular services are running on the host, such as "PAN", or "OBEX Obect Push", etc: in general a device looking for a service such as "Network Access Point" will only scan for this service on devices containing "Networking" in their major service class.
+
+
+.IP 
+Major service class byte allocation (from LSB to MSB):
+
+Bit 1:	Positioning (Location identification)
+
+Bit 2:  Networking (LAN, Ad hoc, ...)
+
+Bit 3:  Rendering (Printing, Speaker, ...)
+
+Bit 4:  Capturing (Scanner, Microphone, ...)
+
+Bit 5:  Object Transfer (v\-Inbox, v\-Folder, ...)
+
+Bit 6:  Audio (Speaker, Microphone, Headset service, ...)
+
+Bit 7:  Telephony (Cordless telephony, Modem, Headset service, ...)
+
+Bit 8:  Information (WEB\-server, WAP\-server, ...)
+
+.IP 
+Example: class 0x02hhhh : the device offers networking service
+
+
+.IP 
+Major device class allocation:
+
+0x00: Miscellaneous
+
+0x01: Computer (desktop,notebook, PDA, organizers, .... )
+
+0x02: Phone (cellular, cordless, payphone, modem, ...)
+
+0x03: LAN /Network Access point
+
+0x04: Audio/Video (headset,speaker,stereo, video display, vcr.....
+
+0x05: Peripheral (mouse, joystick, keyboards, ..... )
+
+0x06: Imaging (printing, scanner, camera, display, ...)
+
+Other values are not defined (refer to the Bluetooth specification for more details
+
+.IP 
+Minor device class allocation: the meaning of this byte depends on the major class allocation, please refer to the Bluetooth specifications for more details).
+
+.IP 
+.B Example:
+if PAND runs on your server, you need to set up at least \fBclass 0x020100\fP, which stands for "Service Class: Networking" and "Device Class: Computer, Uncategorized".
+
+
+.TP 
+\fBiscan\fP  enable|disable
+.TP 
+\fBpscan\fP  enable|disable
+
+Bluetooth devices discover and connect to each other through the use of two special Bluetooth channels, the Inquiry and Page channels (described in the Bluetooth Spec Volume 1, Part A, Section 3.3.3, page 35). These two options enable the channels on the bluetooth device.
+
+\fBiscan enable\fP: makes the bluetooth device "discoverable" by enabling it to answer "inquiries" from other nearby bluetooth devices.
+
+\fBpscan enable\fP: makes the bluetooth device "connectable to" by enabling the use of the "page scan" channel.
+
+.TP 
+\fBlm\fP  none|accept,master
+
+\fInone\fP means no specific policy. \fIaccept\fP means always accept
+incoming connections. \fImaster\fP means become master on incoming
+connections and deny role switch on outgoing connections.
+
+.TP 
+\fBlp\fP  none|rswitch,hold,sniff,park
+
+\fInone\fP means no specific policy. \fIrswitch\fP means allow role
+switch. \fIhold\fP means allow hold mode. \fIsniff\fP means allow
+sniff mode. \fIpark\fP means allow park mode. Several options can be
+combined.
+
+This option determines the various operational modes that are allowed for this device when it participates to a piconet. Normally  hold and sniff should be enabled for standard operations.
+
+hold: this mode is related to synchronous communications (SCO voice channel for example).
+
+sniff: when in this mode, a device is only present on the piconet during determined slots of time, allowing it to do other things when it is "absent", for example to scan for other bluetooth devices.
+
+park:  this is a mode where the device is put on standby on the piconet, for power\-saving purposes for example.
+
+rswitch: this is a mode that enables role\-switch (master <\-> slave) between two devices in a piconet. It is not clear whether this needs to be enabled in order to make the "lm master" setting work properly or not.
+
+
+
+
+.TP 
+\fBpkt_type\fP  DH1,DM1,HV1, etc.
+
+This fairly obscure option determines the packet types that the bluetooth device will send or accept. This is a very low\-level option that should probably not be changed for normal use. You do not need to specify defaults.
+
+You can check the Bluetooth specification version 1.2 Volume 2, Part B section 6 for more details about this.
+.SH "FILES"
+.TP 
+.I /etc/bluetooth/hcid.conf
+Default location of the global configuration file.
+
+.SH "AUTHOR"
+This manual page was written by Edouard Lafargue, Fredrik Noring and Maxim Krasnyansky.