summaryrefslogtreecommitdiff
path: root/headsetcontrol/debian/headsetcontrol.1
diff options
context:
space:
mode:
Diffstat (limited to 'headsetcontrol/debian/headsetcontrol.1')
-rw-r--r--headsetcontrol/debian/headsetcontrol.1138
1 files changed, 138 insertions, 0 deletions
diff --git a/headsetcontrol/debian/headsetcontrol.1 b/headsetcontrol/debian/headsetcontrol.1
new file mode 100644
index 0000000..eaf79a2
--- /dev/null
+++ b/headsetcontrol/debian/headsetcontrol.1
@@ -0,0 +1,138 @@
+.\" Text automatically generated by txt2man and adjusted, from `headsetcontrol --help`
+.TH headsetcontrol 1 "30 December 2024" "headsetcontrol" "General Commands Manual"
+.SH NAME
+\fBheadsetcontroll \fP- control features of USB headsets
+.SH SYNOPSIS
+.nf
+.fam C
+\fIheadsetcontrol\fP [\fB-s 0-128\fP] [\fB-b\fP] [\fB-l 0|1\fP] [\fB-n 0|1\fP] ...
+HeadsetControl by Sapd (Denis Arnst)
+https://github.com/Sapd/HeadsetControl
+.PP
+Version: continuous-1-g343d071-modified
+.PP
+Sidetone:
+.TP
+.B
+\fB-s\fP, \fB--sidetone\fP LEVEL
+Set sidetone level (0-128)
+.PP
+Battery:
+.TP
+.B
+\fB-b\fP, \fB--battery\fP
+Check battery level
+.PP
+Lights and Voice Prompts:
+.TP
+.B
+\fB-l\fP, \fB--light\fP [0|1]
+Turn lights off (0) or on (1)
+.TP
+.B
+\fB-v\fP, \fB--voice-prompt\fP [0|1]
+Turn voice prompts off (0) or on (1)
+.PP
+Features:
+.TP
+.B
+\fB-i\fP, \fB--inactive-time\fP MINUTES
+Set inactive time (0-90 minutes, 0 disables)
+.TP
+.B
+\fB-m\fP, \fB--chatmix\fP
+Get chat-mix-dial level (0-128, <64 for game, >64 for chat)
+.TP
+.B
+\fB-n\fP, \fB--notificate\fP SOUNDID
+Play notification sound (SOUNDID depends on device)
+.TP
+.B
+\fB--volume-limiter\fP [0|1]
+Turn Volume limiter off (0) or on (1)
+.PP
+Equalizer:
+.TP
+.B
+\fB-e\fP, \fB--equalizer\fP STRING
+Set equalizer curve (values separated by spaces, commas, or new-lines)
+\fB-p\fP, \fB--equalizer-preset\fP NUMBER Set equalizer preset (0-3, 0 for default)
+.PP
+Microphone:
+.TP
+.B
+\fB-r\fP, \fB--rotate-to-mute\fP [0|1]
+Toggle rotate to mute (0 = off, 1 = on)
+.TP
+.B
+\fB--microphone-mute-led-brightness\fP NUMBER
+Set mic mute LED brightness (0-3)
+.TP
+.B
+\fB--microphone-volume\fP NUMBER
+Set microphone volume (0-128)
+.PP
+Bluetooth:
+.TP
+.B
+\fB--bt-when-powered-on\fP [0|1]
+Toggle bluetooth turning off (0) or on (1) when turning on headpohnes
+.TP
+.B
+\fB--bt-call-volume\fP NUMBER
+Set headphones volume during a bluetooth call by lowering pc volume (0-2)
+.PP
+Advanced:
+.TP
+.B
+\fB-f\fP, \fB--follow\fP [SECS]
+Re-run commands after SECS seconds (default 2 seconds if not specified)
+.TP
+.B
+\fB--timeout\fP MS
+Set timeout for reading data (0-100000 ms, default 5000)
+.TP
+.B
+-?, \fB--capabilities\fP
+List supported features of the connected headset
+.PP
+Miscellaneous:
+.TP
+.B
+\fB-u\fP
+Output udev rules to stdout/console
+.TP
+.B
+\fB--dev\fP
+Development options
+.TP
+.B
+\fB--readme-helper\fP
+Output table of device features for README.md
+.TP
+.B
+\fB--test-device\fP [profile]
+Use a built-in test device instead of a real one
+profile is an optional number for different tests
+.TP
+.B
+\fB--connected\fP
+Check if device connected (for scripting purposes)
+.TP
+.B
+\fB-o\fP, \fB--output\fP FORMAT
+Output format (JSON, YAML, ENV, STANDARD)
+.PP
+Examples:
+.TP
+.B
+headsetcontrol \fB-b\fP
+Check the battery level
+.TP
+.B
+headsetcontrol \fB-s\fP 64
+Set sidetone level to 64
+.TP
+.B
+headsetcontrol \fB-l\fP 1 \fB-s\fP 0
+Turn on lights and deactivate sidetone
bgstack15