summaryrefslogtreecommitdiff
path: root/contrib/man/bt-device.pod
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/man/bt-device.pod')
-rw-r--r--contrib/man/bt-device.pod113
1 files changed, 113 insertions, 0 deletions
diff --git a/contrib/man/bt-device.pod b/contrib/man/bt-device.pod
new file mode 100644
index 0000000..50f4221
--- /dev/null
+++ b/contrib/man/bt-device.pod
@@ -0,0 +1,113 @@
+=head1 NAME
+
+bt-device - a bluetooth device manager
+
+=head1 SYNOPSIS
+
+bt-device [OPTION...]
+
+Help Options:
+ -h, --help
+
+Application Options:
+ -a, --adapter=<name|mac>
+ -l, --list
+ -c, --connect=<mac>
+ -r, --remove=<name|mac>
+ -i, --info=<name|mac>
+ -s, --services <name|mac> [<pattern>]
+ --set <name|mac> <property> <value>
+ -v, --verbose
+
+=head1 DESCRIPTION
+
+This utility is used to manage Bluetooth devices. You can list added devices,
+connect to a new device, remove added device, show info about device,
+discover remote device services or change device properties.
+
+=head1 OPTIONS
+
+B<-h, --help>
+ Show help
+
+B<-a, --adapter E<lt>name|macE<gt>>
+ Specify adapter to use by his Name or MAC address
+ (if this option does not defined - default adapter used)
+
+B<-l, --list>
+ List added devices
+
+B<-c, --connect E<lt>macE<gt>>
+ Connect to the remote device by his MAC and retrieve all SDP
+ records and then initiate the pairing
+
+B<-r, --remove>
+ Remove device (and also the pairing information)
+
+B<-i, --info>
+ Show information about device (returns all properties)
+
+B<-s, --services E<lt>name|macE<gt> [E<lt>patternE<gt>]>
+ Starts the service discovery to retrieve remote service records,
+ the `pattern` parameter can be used to specify specific UUIDs
+
+B<--set E<lt>propertyE<gt> E<lt>valueE<gt>>
+ Change device properties (see PROPERTIES section for list of
+ available properties)
+
+B<-v, --verbose>
+ Verbosely display remote service records (affect to service
+ discovery mode)
+
+=head1 DEVICE PROPERTIES
+
+string Address [ro]
+ The Bluetooth device address (MAC) of the remote device.
+
+string Name [ro]
+ The Bluetooth remote device name.
+
+string Icon [ro]
+ Proposed icon name according to the freedesktop.org
+ icon naming specification.
+
+uint32 Class [ro]
+ The Bluetooth class of device of the remote device.
+
+list UUIDs [ro]
+ List of 128-bit UUIDs that represents the available
+ remote services.
+
+boolean Paired [ro]
+ Indicates if the remote device is paired.
+
+boolean Connected [ro]
+ Indicates if the remote device is currently connected.
+
+boolean Trusted [rw]
+ Indicates if the remote is seen as trusted.
+
+boolean Blocked [rw]
+ If set to true any incoming connections from the
+ device will be immediately rejected.
+
+string Alias [rw]
+ The name alias for the remote device. The alias can
+ be used to have a different friendly name for the
+ remote device.
+
+ In case no alias is set, it will return the remote
+ device name. Setting an empty string as alias will
+ convert it back to the remote device name.
+
+boolean LegacyPairing [ro]
+ Set to true if the device only supports the pre-2.1
+ pairing mechanism.
+
+=head1 AUTHOR
+
+Alexander Orlenko <zxteam@gmail.com>.
+
+=head1 SEE ALSO
+
+bt-agent(1) bt-adapter(1)