Added documentation for using tuxrecord on PipeWire based systems.

This commit is contained in:
Johannes Findeisen 2026-10-09 23:36:54 +02:00
commit e699adfa60
2 changed files with 79 additions and 9 deletions

View file

@ -6,9 +6,8 @@
*
* A Linux port of the former macOS-only "macrecord" tool, rewritten in C99
* and using the ALSA capture API (libasound) as the recording source.
*
* The port is derived from [macrecord](https://codeberg.org/armin/macrecord)
* which was created by my good friend armin.
* macrecord was created by my good friend Armin. You can find his code here:
* https://codeberg.org/armin/macrecord
*
* Copyright 2026 Johannes Findeisen <you@hanez.org>
* Licensed under the terms of the Apache-2.0 license.
@ -120,7 +119,13 @@ static void usage(void)
"\n"
"By default the ALSA capture device \"default\" is used, which is usually\n"
"the microphone. To record system audio (everything playing on the\n"
"system) see the \"Recording system audio\" section in the README.\n",
"system) see the \"Recording system audio\" section in the README.\n"
"\n"
"PipeWire users: record from the PipeWire default source via the\n"
"ALSA compatibility plugin by passing the device name \"pipewire\":\n"
" tuxrecord -D pipewire (default source)\n"
" pactl set-default-source \"$(pactl get-default-sink).monitor\"\n"
" tuxrecord -D pipewire (system audio, uses the sink monitor)\n",
DEFAULT_PREFIX, DEFAULT_PREFIX, DEFAULT_DEVICE);
}