UxPlay/Bluetooth_LE_beacon/uxplay-beacon.1

.TH UXPLAY 1 2026-03-15 "UxPlay 1.73.4" "User Commands"
.SH NAME
uxplay-beacon.py  \- Python (>= 3.6) script for a Bluetooth LE Service-Discovery beacon.
.SH SYNOPSIS
.B uxplay-beacon.py
[BlueIO] [\fI\, -h, --help] + more options.
.SH DESCRIPTION
.TP
UxPlay 1.73: Standalone Python Script for Bluetooth LE Service Discovery
.nf
Modules for BLE support:

BlueZ: (Linux, with D-Bus)
winrt: (Windows)
BleuIO: (for a BleuIO USB serial device, all platforms, including macOS).
HCI: Use Host Controller Interface (Linux/*BSD, needs elevated privileges)

The best choice for host platform is made unless option BleuIO is used.
.SH OPTIONS
.TP
.B
\fB\<module>\fR    Force use of non-default <module> = [\fBBleuIO\fR,\fBHCI\fR] 
.TP
\fB\--file\fR fn   Specify configuration file (default: ~/.uxplay.beacon)
.TP
\fB\--path\fR fn   Specify a non-default Bluetooth LE data file used by uxplay
.TP
\fB\--ipv4\fR ip   Override automatically-found ipv4 address for contacting UxPlay
.TP
\fB\--advmin\fR x  Minimum Advertising interval in msecs (>= 100)
.TP
\fB\--advmax\fR y  Maximum Advertising interval in msecs (>= advmin, <= 102400)
.TP
\fB\--index\fR x   Used to distinguish different instances of BlueZ beacons
.TP
\fB\--device\fR p  Specify an address for a required device

.TP
\fB \-h, --help\fR Show help text.
.SH
FILES
Options in configuration file are applied first (command-line options may modify them).
.TP
Format:  one option per line, with initial  "--"; lines beginning with "#" ignored.
.SH
AUTHORS
.TP
Various, see website or distribution.
.SH
COPYRIGHT
.TP
Various, see website or distribution.  License: GPL v3+: 
.TP
GNU GPL version 3 or later. (some parts LGPL v.2.1+ or MIT).
.SH
SEE ALSO
.TP
Website: <https://github.com/FDH2/UxPlay>