diff --git a/README.md b/README.md index 7d59a55..db143e2 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,6 @@ Wayland successor to [xlayoutdisplay](https://github.com/alex-courtis/xlayoutdis 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. -See `man way-displays` for further details. - ## Requirements A wlroots based compositor that supports the WLR Output Management protocol. @@ -88,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. diff --git a/doc/way-displays.1 b/doc/way-displays.1 index b6dc8ec..59f7f41 100644 --- a/doc/way-displays.1 +++ b/doc/way-displays.1 @@ -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. diff --git a/doc/way-displays.1.pandoc b/doc/way-displays.1.pandoc index bb0bb27..88f595a 100644 --- a/doc/way-displays.1.pandoc +++ b/doc/way-displays.1.pandoc @@ -12,20 +12,24 @@ way-displays [*OPTIONS*...] [*COMMAND*] # DESCRIPTION -way-displays manages your wayland displays: - -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. Set resolution/refresh: preferred, highest or custom + +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: