.\" 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-23" "wf-shadow" "General Commands Manual"
.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-A, --acodec\fR \fICODEC\fR
.RS 4
This option is passed directly to ffmpeg(1)'\&s \fI-acodec\fR.\&
.P
.RE
\fB-a, --audio\fR \fIDEVICE\fR
.RS 4
This option is used in order to set the pulseaudio/pipewire-pulse device
that is recorded by \fBwf-shadow\fR.\&
.P
.RE
\fB-c, --vcodec\fR \fICODEC\fR
.RS 4
This option is passed directly to ffmpeg(1)'\&s \fI-vcodec\fR.\&
.P
.RE
\fB-d, --debug\fR
.RS 4
Sets the bash(1) \fI-x\fR option.\&
.P
.RE
\fB-e, --end\fR [\fIOUTPUT\fR]
.RS 4
End the current instance running on output \fIOUTPUT\fR.\&
.P
.RE
\fB-h, --help\fR
.RS 4
Shows a simple help menu.\&
.P
.RE
\fB-N, --no-video\fR
.RS 4
By default, \fBwf-shadow\fR enables video recording.\&
.P
.RE
\fB-n, --no-audio\fR
.RS 4
By default, \fBwf-shadow\fR enables the -a option of wf-recorder(1).\& This
option disables it.\&
.P
.RE
\fB-R, --raw-record\fR
.RS 4
Pass arguments directly to the record function.\& Somewhat like an API.\&
.P
.RE
\fB-r, --record\fR [\fIOUTPUT\fR]
.RS 4
Record the last few moments of video using a wofi(1) menu.\& Any arbitrary
number of seconds can be input.\&
.P
This will use the same \fIOUTPUT\fR number as any running session of
\fBwf-shadow\fR.\&
.P
.RE
\fB-s, --start\fR [\fIOUTPUT\fR]
.RS 4
Starts a wf-shadow instance on output number \fIOUTPUT\fR, if no \fIOUTPUT\fR
is specified, then use output #1.\&
.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-Y, --yes-video\fR
.RS 4
Enable video recording.\& Overrides \fI-N\fR.\&
.P
.RE
\fB-y, --yes-audio\fR
.RS 4
Enable audio recording.\& Overrides \fI-n\fR.\&
.P
.RE
\fB--version\fR
.RS 4
Display version information of \fBwf-shadow\fR and its dependencies.\&
.P
.RE
.SH ENVIRONMENT
.P
\fBWF_SHADOW_DIR\fR
.RS 4
The path to the directory used to save clips.\&
.P
.RE
\fBWF_SHADOW_FMT\fR
.RS 4
The date(1) \fI-d\fR format used by \fBwf-shadow\fR to save clips.\&
.P
.RE
\fBWF_SHADOW_EXT\fR
.RS 4
The file extension of the saved clips.\& Matches the container
.P
.RE
\fBWF_SHADOW_SAVE\fR
.RS 4
The bash(1) command to run to get the save file for clips.\& The output of
the command is used as the path.\& Overrides \fBWF_SHADOW_DIR\fR,
\fBWF_SHADOW_FMT\fR, and \fBWF_SHADOW_EXT\fR.\&
.P
.RE
\fBWF_SHADOW_CONFIG\fR
.RS 4
The path to the configuration file used by \fBwf-shadow\fR.\&
See \fBCONFIGURATION\fR for how to configure \fBwf-shadow\fR.\&
.P
.RE
.SH CONFIGURATION
.P
The configuration file takes the form of a bash(1) script.\& This file is sourced
after default variables are set.\& Use standard bash variable definitions in order
to set either environment variables found in \fBENVIRONMENT\fR, or the following
variables.\&
.P
\fBOUTPUT\fR
.RS 4
The output number to use to start, end, or record on.\& Default is 1.\&
.P
.RE
\fBOUTPUT_NAME\fR
.RS 4
The name of the output to use to start, end, or record on.\& Unset by
default.\& Overrides \fBOUTPUT\fR.\&
.P
.RE
\fBAUDIO_DEV\fR
.RS 4
This variable is the same as what is passed to \fI-a\fR.\& See \fBOPTIONS\fR for
more information.\&
.P
.RE
\fBAUDIO_CODEC\fR
.RS 4
This variable is the same as what is passed to \fI-A\fR.\& See \fBOPTIONS\fR for
more information.\&
.P
.RE
\fBNO_AUDIO\fR
.RS 4
When this variable is set, audio recording will be disabled.\&
.P
.RE
\fBVIDEO_DEV\fR
.RS 4
This variable is the same as what is passed to \fI-V\fR.\& See \fBOPTIONS\fR for
more information.\&
.P
.RE
\fBVIDEO_CODEC\fR
.RS 4
This variable is the same as what is passed to \fI-c\fR.\& See \fBOPTIONS\fR for
more information.\&
.P
.RE
\fBNO_VIDEO\fR
.RS 4
When this variable is set, video recording will be disabled in outputted
clips.\&
.P
.RE
\fBVERBOSE\fR
.RS 4
This variable is non-empty if verbose output should be enabled.\& Same as
\fI-v\fR.\&
.P
.RE
.SH EXAMPLES
.P
\fBwf-shadow\fR \fI-s\fR \fI1\fR
.RS 4
Start a \fBwf-shadow\fR session on output #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 output #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 output #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 output #2, using /dev/dri/renderD128 as
the video encoder.\& Print verbose output.\&
.P
.RE
.SH SEE ALSO
.P
wf-shadow-tui(1) wf-recorder(1) wofi(1) ffmpeg(1) pactl(1) date(1) bash(1)
.P
.SH AUTHOR
Skylar "The Cobra" Widulski <cobra@vern.\&cc>