Skip to content

Commit 71dab26

Browse files
committed
README, man/wl-present: document wl-present --name option and env var
1 parent 92397a7 commit 71dab26

2 files changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ The [`scripts/`](scripts/) folder contains examples on how `wl-mirror` can be us
9797
- [`wl-present`](scripts/wl-present) is a small script to demonstrate the use
9898
of the `-S` option to interactively present on Sway.
9999
This script is especially useful when binding the `wl-present` subcommands to
100-
keyboard shortcuts. See example below
100+
keyboard shortcuts. See example below.
101101
- [`release.sh`](scripts/release.sh) Generates a release tar ball for the
102102
currently checked out commit if there's a release tag on it.
103103

@@ -127,6 +127,10 @@ bindsym $mod+p mode "present"
127127
This requires `wl-mirror`, the `wl-present` script, `pipectl` (optional),
128128
slurp, and one of `wofi`, `wmenu`, `rofi`, or `dmenu`.
129129

130+
Note that wl-present only allows one instance by default, but multiple
131+
instances can be used at the same time using the `--name` option or
132+
`WL_PRESENT_PIPE_NAME` environment variable.
133+
130134
### Kanshi Configuration Example
131135

132136
The following [kanshi](https://git.sr.ht/~emersion/kanshi) profile will launch

man/wl-present.1.scd

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ wl-present - an interactive client for *wl-mirror*(1)
66

77
# SYNOPSIS
88

9-
*wl-present* <COMMAND> [args...]
9+
*wl-present* [OPTIONS] <COMMAND> [args...]
1010

1111
# DESCRIPTION
1212

@@ -58,6 +58,12 @@ in your wayland compositor for easy access.
5858
given, *dmenu*(1) (or a compatible replacement) are used to select an
5959
option.
6060

61+
# OPTIONS
62+
63+
*-n*, *--name*
64+
Use an alternative pipe name (default is wl-present).
65+
This allows multiple instances of wl-present to run at the same time.
66+
6167
# ENVIRONMENT VARIABLES
6268

6369
*WL_PRESENT_DMENU*
@@ -81,6 +87,12 @@ in your wayland compositor for easy access.
8187

8288
Example: WL_PRESENT_SLURP="slurp -c #859900 -w 2"
8389

90+
*WL_PRESENT_PIPE_NAME*
91+
Overrides the default pipe name (default is wl-present). This is equivalent
92+
to the *--name* option above.
93+
94+
Example: WL_PRESENT_PIPE_NAME=monitor2 wl-present mirror HDMI-A-1
95+
8496
# AUTHORS
8597

8698
Maintained by Ferdinand Bachmann <[email protected]>. More information on

0 commit comments

Comments
 (0)