Skip to content

Commit

Permalink
README, man/wl-present: document wl-present --name option and env var
Browse files Browse the repository at this point in the history
  • Loading branch information
Ferdi265 committed Oct 13, 2024
1 parent 92397a7 commit 71dab26
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The [`scripts/`](scripts/) folder contains examples on how `wl-mirror` can be us
- [`wl-present`](scripts/wl-present) is a small script to demonstrate the use
of the `-S` option to interactively present on Sway.
This script is especially useful when binding the `wl-present` subcommands to
keyboard shortcuts. See example below
keyboard shortcuts. See example below.
- [`release.sh`](scripts/release.sh) Generates a release tar ball for the
currently checked out commit if there's a release tag on it.

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

Note that wl-present only allows one instance by default, but multiple
instances can be used at the same time using the `--name` option or
`WL_PRESENT_PIPE_NAME` environment variable.

### Kanshi Configuration Example

The following [kanshi](https://git.sr.ht/~emersion/kanshi) profile will launch
Expand Down
14 changes: 13 additions & 1 deletion man/wl-present.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ wl-present - an interactive client for *wl-mirror*(1)

# SYNOPSIS

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

# DESCRIPTION

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

# OPTIONS

*-n*, *--name*
Use an alternative pipe name (default is wl-present).
This allows multiple instances of wl-present to run at the same time.

# ENVIRONMENT VARIABLES

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

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

*WL_PRESENT_PIPE_NAME*
Overrides the default pipe name (default is wl-present). This is equivalent
to the *--name* option above.

Example: WL_PRESENT_PIPE_NAME=monitor2 wl-present mirror HDMI-A-1

# AUTHORS

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

0 comments on commit 71dab26

Please sign in to comment.