WF-RECORDER(1)              General Commands Manual             WF-RECORDER(1)

<?><?><?> (NAME)
     wf-recorder - <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
     <?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?>
     <?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> wlroots

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
     wf-recorder [-abcCdDefFghlmopPrRvxX] [-a, --audio [=DEVICE]] [-b,
     --bframes max_b_frames] [-B, --buffrate buffrate] [-c, --codec
     output_codec] [-r, --framerate framerate] [-d, --device encoding_device]
     [--no-dmabuf] [-D, --no-damage] [-f, --file filename.ext] [-F
     filter_string] [-g, --geometry geometry] [-h, --help] [-l, --log] [-m,
     --muxer muxer] [-L, --list-output] [-o, --output output] [-p,
     --codec-param [option_param=option_value]] [-v, --version] [-x,
     --pixel-format] [--audio-backend audio_backend] [-C, --audio-codec
     output_audio_codec] [-P, --audio-codec-param [option_param=option_value]]
     [-R, --sample-rate sample_rate] [-X, --sample-format sample_format] [-y,
     --overwrite]

<?><?><?><?><?><?><?> (DESCRIPTION)
     wf-recorder <?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?> <?><?><?>
     <?><?><?><?><?><?><?><?><?><?> <?><?>
     <?><?><?><?><?><?><?><?><?><?><?><?><?> Wayland <?><?><?><?><?> <?><?><?>
     <?><?><?>.  <?><?><?> <?><?><?><?><?> <?><?> wlr-screencopy <?><?><?><?>
     <?><?><?> <?><?><?><?><?> <?> <?><?> ffmpeg(1) <?><?><?><?>
     <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>.

     <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> wf-recorder <?><?>
     <?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?> <?> <?><?>
     `Ctrl+C' <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?>
     <?><?><?><?>.  <?><?><?> <?><?><?> <?><?><?><?><?> <?><?> <?><?><?>
     `recording.mp4' <?><?> <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?>
     <?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?> codec
     <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

     <?><?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?> <?><?><?><?><?>:

     -a, --audio [=DEVICE]
             <?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?>.

             <?><?><?><?><?><?><?> DEVICE <?><?><?><?><?><?><?> <?><?><?>.
             <?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?>
             <?><?><?><?><?><?> PulseAudio <?><?><?><?><?><?><?><?><?>
             <?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
             <?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?>
             <?><?><?><?><?> <?><?> <?><?><?> <?><?> <?><?><?><?><?><?>
             <?><?><?><?> <?><?><?><?><?><?>.  <?><?><?><?><?><?><?><?><?>
             <?><?><?><?><?><?> <?><?><?> <?><?> <?><?> <?><?><?><?><?>
             <?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?>:
                   $ pactl list sources | grep Name

     -b, --bframes max_b_frames
             <?><?><?><?><?><?> <?><?><?><?><?> B-Frame<?><?><?> <?><?><?><?>
             <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?>.
     -B, --buffrate buffrate
             <?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?>
             <?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?>
             <?><?><?><?><?> <?><?><?><?><?><?>.  <?><?><?> <?><?><?> VFR
             <?><?> <?><?><?> <?><?><?><?> <?> <?><?><?><?>
             <?><?><?><?><?><?><?> FPS <?><?><?><?> <?><?>
             <?><?><?><?><?><?><?><?> (<?><?><?><?><?> svt-av1) <?><?> <?><?>
             <?><?><?><?><?><?>.  <?><?><?><?> <?><?><?> <?><?><?><?>
             <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
             <?><?><?>.

     -c, --codec output_codec
             <?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?>
             <?><?><?><?><?><?>. <?><?> <?><?><?><?><?> GIF <?><?><?>
             <?><?><?><?><?><?><?><?> <?><?><?><?><?><?>.

             <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
             <?><?><?><?> <?><?> -p option_name=option_value
             <?><?><?><?><?><?><?> <?><?><?><?>.

     -r, --framerate framerate
             <?><?> <?><?><?> <?><?><?><?> <?><?><?><?> (CFR)
             <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
             <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?>
             <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?>.
             <?><?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?> CFR
             <?><?><?><?><?><?> <?> <?><?><?><?> <?><?><?><?><?><?><?> FPS
             <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?>
             <?><?><?><?><?><?>.

     -d, --device encoding_device
             <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
             <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?><?><?><?><?> <?><?><?><?><?><?>.

             <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
             <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> `rgb0'
             <?><?> <?><?><?><?> <?><?><?><?><?> vaapi <?><?><?><?><?>
             <?><?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?>
             <?><?><?><?> <?><?> yuv <?><?><?><?><?><?><?><?>
             <?><?><?><?><?><?><?>.  <?><?><?><?><?> <?><?>
             <?><?><?><?><?><?><?><?><?> vaapi<?> <?><?> <?><?><?><?><?> -x
             yuv420 <?><?><?><?><?><?><?> <?><?><?><?> <?><?>
             <?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?><?> <?><?>
             GPU<?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
             <?><?><?><?><?> <?><?><?><?>.

     --no-dmabuf
             <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> wf-recorder <?><?>
             <?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> GPU
             <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?>
             <?><?><?><?><?><?> <?> <?><?><?><?><?><?><?> GPU
             <?><?><?><?><?><?><?> <?><?><?>.  <?><?> <?><?><?> <?><?><?><?>
             <?><?><?> <?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?>
             <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
             <?><?><?><?><?><?><?> <?><?><?>.  <?><?> <?><?><?><?>
             <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?> GPU
             <?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?>
             <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> (CPU)
             <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>.

     -D, --no-damage
             <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> wf-recorder
             <?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
             <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?>
             <?><?><?><?><?><?><?><?><?><?><?> <?><?><?>. <?><?><?> <?><?><?>
             <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
             <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
             <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?>
             <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?>.
             <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?>
             <?><?><?><?><?> wf-recorder <?><?> <?><?><?>
             <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
             <?><?><?><?><?> <?> <?><?><?> <?><?><?> <?><?><?>
             <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?>
             <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
             <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?>
             <?><?><?><?><?><?>.

     -f, --file filename.ext
             <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> -f <?>
             <?><?><?><?> <?><?><?><?><?> <?><?><?> filename.ext <?><?>
             <?><?><?><?><?> <?><?><?><?> <?> <?><?><?><?> <?><?><?><?> <?><?>
             <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
             <?><?><?><?><?> <?><?><?><?><?><?>.  <?><?><?> <?><?><?><?><?>
             <?><?><?><?> <?><?><?><?><?><?><?><?> ffmpeg(1) <?><?><?>
             <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?>.

             <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?>
             <?><?> <?><?><?> ffmpeg(1) <?><?><?> <?><?><?><?><?><?><?><?>
             <?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?>
             <?><?><?> <?><?><?><?><?> <?><?><?><?>:
                   $ ffmpeg -muxers

     -F, --filter filter_string
             <?><?><?><?><?> ffmpeg <?><?><?><?> <?><?><?><?><?><?><?> <?><?>
             <?><?><?><?><?> <?><?><?><?><?><?>. VAAPI <?><?><?><?>
             <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
             `scale_vaapi=format=nv12:out_range=full` <?><?><?>.

     -g, --geometry screen_geometry
             <?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?>
             <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?><?><?><?>
             <?><?> <?><?> <?><?><?><?> "x,y WxH" <?><?><?>.

     -h, --help
             <?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?>
             <?><?><?><?><?><?>.

     -l, --log
             <?><?> <?><?><?><?><?> (<?><?><?>) <?><?><?>
             <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
             <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?>
             <?><?><?><?><?><?><?><?><?><?><?>.

     -m, --muxer muxer
             <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?>
             <?><?><?><?><?> <?><?> <?><?><?> <?><?><?> <?><?><?><?><?>
             <?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
             <?><?><?><?><?><?>.

     -L, --list-output
             <?><?><?><?><?><?><?><?><?> (<?><?><?><?><?><?><?><?><?><?>)
             <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

     -o, --output
             <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?>
             <?><?> <?><?> <?><?><?> <?><?><?> <?><?> <?><?><?><?>
             <?><?><?><?><?><?>.

     -p, --codec-param [option_name=option_value]
             <?><?> <?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?><?>
             <?><?><?><?><?><?>. <?><?><?><?><?><?><?><?> <?><?><?><?><?>
             <?><?><?> <?><?><?><?><?><?><?> <?><?><?>: -p
             option_name_1=option_value_1 -p option_name_2=option_value_2

     -v, --version
             <?><?><?><?> wf-recorder <?><?> <?><?><?> <?><?><?><?><?><?>.

     -x, --pixel-format pixel_format
             <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?><?><?><?> <?><?><?><?><?><?>.

             <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?>:
                   $ ffmpeg -pix_fmts

     --audio-backend audio_backend
             <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
             <?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
             <?><?><?><?> a- <?><?> <?><?><?><?> <?><?><?><?><?><?>.

     -C, --audio-codec output_audio_codec
             <?><?><?> <?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?>.

     -P, --audio-codec-param [option_name=option_value]
             <?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?> <?><?>
             <?><?><?><?><?> <?><?><?><?><?><?>.

     -R, --sample-rate sample_rate
             <?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?>
             <?><?> <?><?><?> <?><?><?><?> (HZ) <?><?><?><?><?>
             <?><?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?> 48000
             <?><?><?>.

     -X, --sample-format sample_format
             <?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?><?><?><?> <?><?><?><?><?><?>.

             <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?>:
                   $ ffmpeg -sample_fmts

     -y, --overwrite
             <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
             <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
             <?><?><?><?><?><?>.


<?><?><?><?><?><?><?> (EXAMPLES)
     <?><?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?>
     <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?> --g geometry
     <?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?>
     https://github.com/emersion/slurp <?><?><?><?> <?><?><?><?><?><?>
     <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?>
     <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>:
           $ wf-recorder -g "$(slurp)"

     <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?> <?><?><?>
     <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?><?>
     <?><?>:
           $ wf-recorder --audio --file=recording_with_audio.mp4

     <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?>
     <?><?><?><?><?><?><?><?><?> --a<DEVICE> <?><?> ---audio=<DEVICE>
     <?><?><?><?><?><?><?> <?><?><?><?>.

     <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> codec <?><?>
     <?><?><?><?><?> -c codec <?><?><?><?><?><?><?> <?><?><?><?>. <?><?><?><?>
     <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?>
     <?><?><?><?><?> -p <?><?><?><?><?><?><?> <?><?><?><?>:
           $ wf-recorder -c libx264 -p preset=slow -p crf=18

     <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
     <?><?><?><?> <?><?> <?><?><?><?><?> -m, --muxer <?><?><?><?><?><?><?>
     <?><?><?><?>. <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
     <?><?><?><?><?> <?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?>
     video4linux2 <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?>
     <?><?><?><?><?><?><?> <?><?><?><?>:
           $ wf-recorder --muxer=v4l2 --codec=rawvideo --file=/dev/video2

     <?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> GPU<?>
     <?><?> <?><?> <?><?><?> VAAPI (<?><?><?><?><?><?><?><?> <?><?><?><?>
     `h264_vaapi' ) <?><?><?><?><?><?><?> <?><?><?><?> <?> <?><?>
     <?><?><?><?><?><?> GPU <?><?> <?><?> <?><?><?><?><?> -d <?><?><?><?>
     <?><?><?><?><?><?>:
           $ wf-recorder -f test-vaapi.mkv -c h264_vaapi -d
           /dev/dri/renderD128

     <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
     <?><?><?><?><?><?><?><?> `rgb0' <?><?> <?><?><?><?> <?><?><?><?><?>
     `vaapi' <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?> <?><?>
     <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
     <?><?><?><?> (planar) yuv <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>.
     <?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?>
     <?><?><?><?><?><?><?><?><?> `vaapi' <?><?> <?><?><?><?><?> -x yuv420p
     <?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?>
     <?><?> <?><?><?><?><?> <?><?> GPU <?><?> <?><?><?><?><?><?><?><?>
     <?><?><?><?> yuv <?><?><?><?><?> <?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
     ffmpeg(1), pactl(1)

Linux 6.12.107+deb13-amd64       July 30, 2022      Linux 6.12.107+deb13-amd64