.\" Generated by scdoc 1.11.3
.\" 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 "wl-present" "1" "2025-08-07"
.PP
.SH NAME
.PP
wl-present - an interactive client for \fBwl-mirror\fR(1)
.PP
.SH SYNOPSIS
.PP
\fBwl-present\fR [OPTIONS] <COMMAND> [args.\&.\&.\&]
.PP
.SH DESCRIPTION
.PP
\fBwl-present\fR is an wrapper around \fBwl-mirror\fR(1) that uses its streaming mode
together with \fBpipectl\fR(1) to interactively control what is being captured.\&
.PP
The subcommands of \fBwl-present\fR are intended to be mapped to keyboard shortcuts
in your wayland compositor for easy access.\&
.PP
.SH COMMANDS
.PP
\fBhelp\fR
.RS 4
Show help message and exit.\&
.PP
.RE
\fBmirror\fR [OUTPUT] [OPTIONS]
.RS 4
Start \fBwl-mirror\fR(1) capturing OUTPUT.\& If no output is given, \fBslurp\fR(1) is
used to select the output or region to capture.\& If any additional OPTIONS
are specified, they are passed on to \fBwl-mirror\fR.\&
.PP
.RE
\fBset-output\fR [OUTPUT]
.RS 4
Set the captured output of a running \fBwl-present\fR session.\& If no output is
given, \fBslurp\fR(1) is used to select the output to capture.\&
.PP
.RE
\fBset-region\fR [REGION]
\fBunset-region\fR
.RS 4
Set the captured region of a running \fBwl-present\fR session.\& If no region is
given, \fBslurp\fR(1) us used to select a region to capture.\&
.PP
.RE
\fBset-scaling\fR [SCALING]
.RS 4
Set the scaling mode of a running \fBwl-present\fR session.\& If no region is
given, \fBdmenu\fR(1) (or a compatible replacement) is used to select a scaling
mode.\&
.PP
.RE
\fBfreeze\fR,
\fBunfreeze\fR,
\fBtoggle-freeze\fR
.RS 4
Set the freeze state of a running \fBwl-present\fR session.\&
.PP
.RE
\fBfullscreen\fR
\fBunfullscreen\fR
.RS 4
Set the fullscreen state of a running \fBwl-present\fR session.\&
.PP
.RE
\fBfullscreen-output\fR [OUTPUT]
.RS 4
Set the fullscreen target output of a running \fBwl-present\fR session, implies
\fBfullscreen\fR.\&
.PP
.RE
\fBno-fullscreen-output\fR
.RS 4
Unset a previously set fullscreen target output of a running \fBwl-present\fR
session, implies \fBunfullscreen\fR.\&
.PP
.RE
\fBcustom\fR [OPTIONS]
.RS 4
Send custom options to a running \fBwl-present\fR session.\& If no options are
given, \fBdmenu\fR(1) (or a compatible replacement) are used to select an
option.\&
.PP
.RE
.SH OPTIONS
.PP
\fB-n\fR, \fB--name\fR
.RS 4
Use an alternative pipe name (default is wl-present).\&
This allows multiple instances of wl-present to run at the same time.\&
.PP
.RE
.SH ENVIRONMENT VARIABLES
.PP
\fBWL_PRESENT_DMENU\fR
.RS 4
Overrides the used dmenu implementation.\& When set, this command is used to
select options instead of the default.\& When unset, \fBwl-present\fR attempts to
use \fBwofi\fR(1), \fBwmenu\fR(1), \fBfuzzel\fR(1), \fBrofi\fR(1), and \fBdmenu\fR(1), in this
order.\&
.PP
Example: WL_PRESENT_DMENU="rofi -dmenu -p present"
.PP
.RE
\fBWL_PRESENT_PIPECTL\fR
.RS 4
Overrides the used pipectl implementation.\& When set, this command is used to
pipe options to \fBwl-mirror\fR(1) instead of the default.\& When unset,
\fBwl-present\fR attempts to use \fBpipectl\fR(1) or an included pipectl shim
written in bash if pipectl is not available.\&
.PP
.RE
\fBWL_PRESENT_SLURP\fR
.RS 4
Overrides the used slurp implementation and options.\& When set, this command
is used to select regions and outputs instead of the default.\& When unset,
\fBwl-present\fR attempts to use \fBslurp\fR(1) without any additional options.\&
.PP
Example: WL_PRESENT_SLURP="slurp -c #859900 -w 2"
.PP
.RE
\fBWL_PRESENT_PIPE_NAME\fR
.RS 4
Overrides the default pipe name (default is wl-present).\& This is equivalent
to the \fB--name\fR option above.\&
.PP
Example: WL_PRESENT_PIPE_NAME=monitor2 wl-present mirror HDMI-A-1
.PP
.RE
.SH AUTHORS
.PP
Maintained by Ferdinand Bachmann <ferdinand.\&bachmann@yrlf.\&at>.\& More information on
\fBwl-mirror\fR can be found at <https://github.\&com/Ferdi265/wl-mirror>.\&
.PP
.SH SEE ALSO
.PP
\fBwl-mirror\fR(1) \fBpipectl\fR(1) \fBslurp\fR(1) \fBwofi\fR(1) \fBwmenu\fR(1) \fBfuzzel\fR(1)
\fBrofi\fR(1) \fBdmenu\fR(1)