Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify way-displays runs as a daemon/server #166

Merged
merged 2 commits into from
Apr 23, 2024
Merged

docs: clarify way-displays runs as a daemon/server #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5093231
docs: way-displays must be a server
alex-courtis Apr 23, 2024
11860d6
docs: sync readme and man description
alex-courtis Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ A wlroots based compositor that supports the WLR Output Management protocol.

way-displays is blessed for the [sway](https://swaywm.org/), [river](https://github.com/riverwm/river) and [Hpyrland](https://hyprland.org/) compositors. It may work on others.

way-displays must be run as a daemon, a background server process. It will respond to your configuration changes as well as state changes such as plugging in a monitor or closing the lid.

User should be a member of the `operation ` group for querying laptop lid state.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good changes. I notice you may have oopsied a bit right here. Should be input group, no?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thank you so much!


## Quick Start

Start with the default config file:
Expand All @@ -39,6 +43,8 @@ Add yourself to the `input` group to monitor events:
sudo usermod -a -G input "${USER}"
```

Start the way-displays server:

### Sway

Remove any `output` commands from your sway config file and add the following:
Expand Down Expand Up @@ -80,7 +86,7 @@ Restart the compositor and run `way-displays -g` or look at `/tmp/way-displays.1

Tweak [cfg.yaml](https://github.com/alex-courtis/way-displays/wiki/Configuration#cfgyaml) to your liking and save it. Changes will be immediately applied.

Alternatively, use the [command line](https://github.com/alex-courtis/way-displays/wiki/Configuration#command-line) to make your changes then persist them with `way-displays -w`.
Alternatively, use the [command line](https://github.com/alex-courtis/way-displays/wiki/Configuration#command-line) to make your changes then persist them with `way-displays -w`. See `man way-displays`

You might want to `tail -f /tmp/way-displays.1.me.log` whilst you are tweaking.

Expand Down
41 changes: 20 additions & 21 deletions doc/way-displays.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "WAY-DISPLAYS" "1" "2024/04/20" "way-displays" "User Manuals"
.TH "WAY-DISPLAYS" "1" "2024/04/23" "way-displays" "User Manuals"
.hy
.SH NAME
.PP
Expand All @@ -24,30 +24,24 @@ way-displays - Auto Manage Your Wayland Displays
way-displays [\f[I]OPTIONS\f[R]\&...]
[\f[I]COMMAND\f[R]]
.SH DESCRIPTION
.PP
way-displays manages your wayland displays:
.IP "1." 3
Sets mode:
.RS 4
.IP \[bu] 2
user specified resolution/refresh OR
.IP \[bu] 2
monitor preferred OR
.IP \[bu] 2
highest resolution/refresh
.RE
Set resolution/refresh: preferred, highest or custom
.IP "2." 3
Enables VRR / adaptive sync
Enable VRR / adaptive sync
.IP "3." 3
Arranges in a row or a column
Arrange in a row or a column
.IP "4." 3
Auto scales based on DPI: 96 is a scale of 1
Auto scale based on DPI: 96 is a scale of 1
.IP "5." 3
Reacts when displays are plugged/unplugged
Update when displays plugged/unplugged
.IP "6." 3
Reacts when laptop lid is closed/opened and no other displays connected
Update when laptop lid closed/opened
.PP
Works out of the box: no configuration required.
.PP
Wayland successor to xlayoutdisplay (https://github.com/alex-courtis/xlayoutdisplay), inspired by kanshi (https://sr.ht/~emersion/kanshi/).
.PP
See wiki for Configuration (https://github.com/alex-courtis/way-displays/wiki/Configuration), Recipes (https://github.com/alex-courtis/way-displays/wiki/Recipes), Troubleshooting (https://github.com/alex-courtis/way-displays/wiki/Troubleshooting) and more.
.SS Server
.PP
Background process that performs the management.
Expand Down Expand Up @@ -79,10 +73,15 @@ The active configuration and display state may be inspected, and the configurati
The active configuration can be written to disk, however any comments and formatting will be lost.
.SH REQUIREMENTS
.PP
way-displays is known to work on the sway and river compositors.
It may work on any wlroots compositor that supports the WLR Output Management protocol.
A wlroots based compositor that supports the WLR Output Management protocol.
.PP
way-displays is blessed for the sway (https://swaywm.org/), river (https://github.com/riverwm/river) and Hpyrland (https://hyprland.org/) compositors.
It may work on others.
.PP
way-displays must be run as a daemon, a background server process.
It will respond to your configuration changes as well as state changes such as plugging in a monitor or closing the lid.
.PP
The user must be a member of the \f[V]input\f[R] group.
User should be a member of the \f[V]input\f[R] group for querying laptop lid state.
.SH OPTIONS
.TP
\f[V]-L\f[R] | \f[V]--l[og-threshold]\f[R] <\f[I]debug\f[R]|\f[I]info\f[R]|\f[I]warning\f[R]|\f[I]error\f[R]>
Expand Down Expand Up @@ -142,7 +141,7 @@ Disable VRR for a display.
Disable a display.
.TP
\f[V]CHANGE_SUCCESS_CMD\f[R] <\f[I]shell command\f[R]>
Sets a \f[V]/bin/sh\f[R] command to be executed when display configurations are successfully changed e.g.\ \f[V]bell ; notify-send way-displays \[dq]change success!\[dq]\f[R]
Sets a \f[V]/bin/sh\f[R] command to be executed when display configurations are successfully changed e.g.\ \f[V]bell ; notify-send way-displays \[dq]Monitor changed\[dq]\f[R]
.RE
.TP
\f[V]-d\f[R], \f[V]--d[elete]\f[R]
Expand Down
34 changes: 21 additions & 13 deletions doc/way-displays.1.pandoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% WAY-DISPLAYS(1) way-displays | User Manuals
% Alexander Courtis
% 2024/04/20
% 2024/04/23

# NAME

Expand All @@ -12,20 +12,24 @@ way-displays [*OPTIONS*...] [*COMMAND*]

# DESCRIPTION

way-displays manages your wayland displays:
1. Set resolution/refresh: preferred, highest or custom

1. Sets mode:
* user specified resolution/refresh OR
* monitor preferred OR
* highest resolution/refresh
1. Enables VRR / adaptive sync
1. Arranges in a row or a column
1. Auto scales based on DPI: 96 is a scale of 1
1. Reacts when displays are plugged/unplugged
1. Reacts when laptop lid is closed/opened and no other displays connected
1. Enable VRR / adaptive sync

1. Arrange in a row or a column

1. Auto scale based on DPI: 96 is a scale of 1

1. Update when displays plugged/unplugged

1. Update when laptop lid closed/opened

Works out of the box: no configuration required.

Wayland successor to [xlayoutdisplay](https://github.com/alex-courtis/xlayoutdisplay), inspired by [kanshi](https://sr.ht/~emersion/kanshi/).

See wiki for [Configuration](https://github.com/alex-courtis/way-displays/wiki/Configuration), [Recipes](https://github.com/alex-courtis/way-displays/wiki/Recipes), [Troubleshooting](https://github.com/alex-courtis/way-displays/wiki/Troubleshooting) and more.

## Server

Background process that performs the management. Configuration is read from a file discovered in order:
Expand Down Expand Up @@ -53,9 +57,13 @@ The active configuration can be written to disk, however any comments and format

# REQUIREMENTS

way-displays is known to work on the sway and river compositors. It may work on any wlroots compositor that supports the WLR Output Management protocol.
A wlroots based compositor that supports the WLR Output Management protocol.

way-displays is blessed for the [sway](https://swaywm.org/), [river](https://github.com/riverwm/river) and [Hpyrland](https://hyprland.org/) compositors. It may work on others.

way-displays must be run as a daemon, a background server process. It will respond to your configuration changes as well as state changes such as plugging in a monitor or closing the lid.

The user must be a member of the `input` group.
User should be a member of the `input` group for querying laptop lid state.

# OPTIONS

Expand Down
Loading