diff options
author | Michael Weiss <dev.primeos@gmail.com> | 2021-05-15 21:29:12 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-05-15 21:29:12 +0200 |
commit | cc7fe8ff0c293883e22fecda692aaec9d1cddbb3 (patch) | |
tree | 825e57c547a8af1abc9b8895403714e6299f9a00 | |
parent | f8a8ac2331053fe553b53f0862ed80af570b137b (diff) | |
parent | a542827c9bb9f90fad6d1c9b5bab7eec24db824c (diff) |
Merge pull request #123149 from primeos/nixos-sway-doc
nixos/sway: Update the module documentation
-rw-r--r-- | nixos/modules/programs/sway.nix | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/nixos/modules/programs/sway.nix b/nixos/modules/programs/sway.nix index ca79177f827e6..de0b234a6316a 100644 --- a/nixos/modules/programs/sway.nix +++ b/nixos/modules/programs/sway.nix @@ -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. ''; }; |