nixos/sway: Update the module documentation

Most programs already run natively under Wayland so extraSessionCommands
isn't as important anymore. XWayland is already covered by
"programs.xwayland.enable = mkDefault true;" in the module.
This commit is contained in:
Michael Weiss 2021-05-06 15:21:15 +02:00
parent 5782a7c56a
commit a542827c9b
No known key found for this signature in database
GPG key ID: 5BE487C4D4771D83

View file

@ -39,9 +39,8 @@ in {
Sway, the i3-compatible tiling Wayland compositor. You can manually launch
Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to
~/.config/sway/config to modify the default configuration. See
https://github.com/swaywm/sway/wiki and "man 5 sway" for more information.
Please have a look at the "extraSessionCommands" example for running
programs natively under Wayland'';
<link xlink:href="https://github.com/swaywm/sway/wiki" /> and
"man 5 sway" for more information'';
wrapperFeatures = mkOption {
type = wrapperOptions;
@ -56,16 +55,20 @@ in {
type = types.lines;
default = "";
example = ''
# SDL:
export SDL_VIDEODRIVER=wayland
# needs qt5.qtwayland in systemPackages
export QT_QPA_PLATFORM=wayland
# QT (needs qt5.qtwayland in systemPackages):
export QT_QPA_PLATFORM=wayland-egl
export QT_WAYLAND_DISABLE_WINDOWDECORATION="1"
# Fix for some Java AWT applications (e.g. Android Studio),
# use this if they aren't displayed properly:
export _JAVA_AWT_WM_NONREPARENTING=1
'';
description = ''
Shell commands executed just before Sway is started.
Shell commands executed just before Sway is started. See
<link xlink:href="https://github.com/swaywm/sway/wiki/Running-programs-natively-under-wayland" />
and <link xlink:href="https://github.com/swaywm/wlroots/blob/master/docs/env_vars.md" />
for some useful environment variables.
'';
};
@ -95,13 +98,15 @@ in {
'';
example = literalExample ''
with pkgs; [
xwayland
i3status i3status-rust
termite rofi light
]
'';
description = ''
Extra packages to be installed system wide.
Extra packages to be installed system wide. See
<link xlink:href="https://github.com/swaywm/sway/wiki/Useful-add-ons-for-sway" /> and
<link xlink:href="https://github.com/swaywm/sway/wiki/i3-Migration-Guide#common-x11-apps-used-on-i3-with-wayland-alternatives" />
for a list of useful software.
'';
};