diff options
| author | Louis Burda <dev@sinitax.com> | 2026-02-14 15:07:41 +0100 |
|---|---|---|
| committer | Louis Burda <dev@sinitax.com> | 2026-02-14 15:07:41 +0100 |
| commit | 8e5aec9e7aca713f5acaaf6bc8e07f94facebd8d (patch) | |
| tree | c8c96b434f99e11e62cd156a5fe0733af3f604ee /wake-pulse.1 | |
| parent | eb6225bc3546a27b897cc7f12c20de0c471eff25 (diff) | |
| download | wake-pulse-main.tar.gz wake-pulse-main.zip | |
Diffstat (limited to 'wake-pulse.1')
| -rw-r--r-- | wake-pulse.1 | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/wake-pulse.1 b/wake-pulse.1 new file mode 100644 index 0000000..ec7d1aa --- /dev/null +++ b/wake-pulse.1 @@ -0,0 +1,65 @@ +.TH WAKE-PULSE 1 "February 2026" "wake-pulse" "User Commands" +.SH NAME +wake-pulse \- prevent PulseAudio/PipeWire sinks from auto-suspending +.SH SYNOPSIS +.B wake-pulse +[\fIOPTIONS\fR] +.SH DESCRIPTION +.B wake-pulse +prevents a PulseAudio or PipeWire sink from automatically suspending by playing a silent WAV file to it. By default, it exits once the sink is no longer suspended. Use \fB-c\fR to keep it awake continuously. +.PP +The script generates a 1-second silent WAV file and plays it on loop to the specified sink (or the default sink if none is specified). It monitors sink state changes via \fBpactl subscribe\fR. +.SH OPTIONS +.TP +.BR \-s ", " \-\-sink " " \fINAME\fR +Specify the sink name to keep awake. If not specified, the system default sink is used. +.TP +.BR \-c ", " \-\-continuous +Keep the sink awake continuously. Without this option, the script exits once the sink is no longer suspended. +.TP +.BR \-h ", " \-\-help +Show help message and exit. +.SH EXAMPLES +.TP +.B wake-pulse +Wake the default sink and exit once it is awake. +.TP +.B wake-pulse -c +Keep the default sink awake continuously until interrupted. +.TP +.B wake-pulse -s my_sink_name +Wake a specific sink named \fImy_sink_name\fR. +.TP +.B wake-pulse -s my_sink -c +Keep a specific sink awake continuously. +.SH FILES +.TP +.I /tmp/wake-pulse-silence.wav +Temporary silent WAV file used for playback. +.TP +.I /tmp/wake-pulse-$$.pid +PID file for the playback process. +.TP +.I /tmp/wake-pulse-silence.lock +Lock file for atomic silence file creation. +.SH DEPENDENCIES +.TP +.B pactl +PulseAudio control utility (from pulseaudio-utils package). +.TP +.B paplay +PulseAudio playback utility (from pulseaudio-utils package). +.SH EXIT STATUS +.TP +.B 0 +Success (sink was woken or kept awake). +.TP +.B 1 +Error (invalid options, sink not found, or other failure). +.SH AUTHOR +Written for PulseAudio and PipeWire users who need to prevent automatic sink suspension. +.SH SEE ALSO +.BR pactl (1), +.BR paplay (1), +.BR pulseaudio (1), +.BR pipewire (1) |