116 lines
2.6 KiB
Groff
116 lines
2.6 KiB
Groff
.\" Generated by scdoc 1.11.2
|
|
.\" Complete documentation for this program is not available as a GNU info page
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.nh
|
|
.ad l
|
|
.\" Begin generated content:
|
|
.TH "wf-shadow" "1" "2023-05-13" "wf-shadow" "wlroots Utilities"
|
|
.P
|
|
.SH NAME
|
|
.P
|
|
\fBwf-shadow\fR — An instant-replay solution for Linux-based operating systems running
|
|
a wlroots Wayland compositor
|
|
.P
|
|
.SH SYNOPSIS
|
|
.P
|
|
\fBwf-shadow\fR \fIOPTION\fR [\fIOPTIONS\fR.\&.\&.\&]
|
|
.P
|
|
.SH DESCRIPTION
|
|
.P
|
|
\fBwf-shadow\fR is a script written in order to fill the void in instant-replay
|
|
software for Wayland, specifically wlroots compositors.\& It uses wf-recorder(1)
|
|
and wofi(1) in order to accomplish the task.\&
|
|
.P
|
|
.SH OPTIONS
|
|
.P
|
|
\fB-s, --start\fR \fIMONITOR\fR
|
|
.RS 4
|
|
Starts a wf-shadow instance on monitor number \fIMONITOR\fR.\&
|
|
.P
|
|
.RE
|
|
\fB-r, --record\fR \fIMONITOR\fR
|
|
.RS 4
|
|
Record the last few moments of video using a wofi(1) menu.\&
|
|
.P
|
|
This will use the same \fIMONITOR\fR number as any running session of
|
|
\fBwf-shadow\fR.\&
|
|
.P
|
|
.RE
|
|
\fB-e, --end\fR \fIMONITOR\fR
|
|
.RS 4
|
|
End the current instance running on monitor \fIMONITOR\fR.\&
|
|
.P
|
|
.RE
|
|
\fB-a, --audio\fR \fIDEVICE\fR
|
|
.RS 4
|
|
By default, \fBwf-shadow\fR enables the -a option of wf-recorder(1).\& This
|
|
option is used in order to set the pulseaudio/pipewire-pulse device that is
|
|
recorded by \fBwf-shadow\fR.\&
|
|
.P
|
|
.RE
|
|
\fB-V, --video\fR \fIDEVICE\fR
|
|
.RS 4
|
|
This option is passed directly to wf-recorder(1)'\&s \fI-d\fR option.\&
|
|
.P
|
|
.RE
|
|
\fB-v, --verbose\fR
|
|
.RS 4
|
|
Show the output of wf-recorder(1), ffmpeg(1), and wofi(1)
|
|
.P
|
|
.RE
|
|
\fB-h, --help\fR
|
|
.RS 4
|
|
Show a simple help menu
|
|
.P
|
|
.RE
|
|
.SH ENVIRONMENT
|
|
.P
|
|
\fBWF_SHADOW_SAVE\fR
|
|
.RS 4
|
|
The path to the directory used to save clips.\&
|
|
.P
|
|
.RE
|
|
\fBWF_SHADOW_FORMAT\fR
|
|
.RS 4
|
|
The date(1) \fI-d\fR format used by \fBwf-shadow\fR to save clips.\&
|
|
.P
|
|
.RE
|
|
.SH EXAMPLES
|
|
.P
|
|
\fBwf-shadow\fR \fI-s\fR \fI1\fR
|
|
.RS 4
|
|
Start a \fBwf-shadow\fR session on monitor #1.\&
|
|
.P
|
|
.RE
|
|
\fBwf-shadow\fR \fI-r\fR \fI1\fR
|
|
.RS 4
|
|
Show a wofi(1) menu of time intervals to save as a clip for the
|
|
\fBwf-shadow\fR session on monitor #1.\& Fails if no such session exists.\&
|
|
.P
|
|
.RE
|
|
\fBwf-shadow\fR \fI-e\fR \fI3\fR
|
|
.RS 4
|
|
End the \fBwf-shadow\fR session running on monitor #3.\& Fails if no such
|
|
session exists.\&
|
|
.P
|
|
.RE
|
|
\fBwf-shadow\fR \fI-s\fR \fI2\fR \fI-V\fR \fI/dev/dri/renderD128\fR \fI-v\fR
|
|
.RS 4
|
|
Start a \fBwf-shadow\fR session on monitor #2, using /dev/dri/renderD128 as
|
|
the video encoder.\& Print verbose output.\&
|
|
.P
|
|
.RE
|
|
.SH EXIT STATUS
|
|
.P
|
|
143 A session has ended.\&
|
|
.P
|
|
Other See output.\&
|
|
.P
|
|
.SH SEE ALSO
|
|
.P
|
|
wf-recorder(1) wofi(1) ffmpeg(1) pactl(1) date(1)
|
|
.P
|
|
.SH AUTHOR
|
|
Skylar "The Cobra" Widulski <thecobra@riseup.\&net>
|