Skip to content

Xserver

services.xserver.cmt.enable

Enable chrome multitouch input (cmt). Touchpad drivers that are configured for chromebooks. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/cmt.nix

services.xserver.cmt.models

Which models to enable cmt for. Enter the Code Name for your Chromebook. Code Name can be found at https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices.

Type: one of "atlas", "banjo", "candy", "caroline", "cave", "celes", "clapper", "cyan", "daisy", "elan", "elm", "enguarde", "eve", "expresso", "falco", "gandof", "glimmer", "gnawty", "heli", "kevin", "kip", "leon", "lulu", "orco", "pbody", "peppy", "pi", "pit", "puppy", "quawks", "rambi", "samus", "snappy", "spring", "squawks", "swanky", "winky", "wolf", "auron_paine", "auron_yuna", "daisy_skate", "nyan_big", "nyan_blaze", "veyron_jaq", "veyron_jerry", "veyron_mighty", "veyron_minnie", "veyron_speedy"

Example

"banjo"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/cmt.nix

services.xserver.desktopManager.budgie.enable

Whether to enable the Budgie desktop. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/budgie.nix

services.xserver.desktopManager.budgie.extraGSettingsOverridePackages

List of packages for which GSettings are overridden. Type: list of path

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/budgie.nix

services.xserver.desktopManager.budgie.extraGSettingsOverrides

Additional GSettings overrides. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/budgie.nix

services.xserver.desktopManager.budgie.extraPlugins

Extra plugins for the Budgie desktop Type: list of package

Default

[ ]

Example

[ pkgs.budgie-analogue-clock-applet ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/budgie.nix

services.xserver.desktopManager.budgie.sessionPath

Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart.

Note that this should be a last resort; patching the package is preferred (see GPaste).

Type: list of package

Default

[ ]

Example

[ pkgs.gpaste ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/budgie.nix

services.xserver.desktopManager.cde.enable

Whether to enable Common Desktop Environment. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/cde.nix

services.xserver.desktopManager.cde.extraPackages

Extra packages to be installed system wide.

Type: list of package

Default

with pkgs.xorg; [xclock bitmap xlsfonts xfd xrefresh xload xwininfo xdpyinfo xwd xwud]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/cde.nix

services.xserver.desktopManager.cinnamon.enable

Whether to enable the cinnamon desktop manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/cinnamon.nix

services.xserver.desktopManager.cinnamon.extraGSettingsOverridePackages

List of packages for which gsettings are overridden. Type: list of path

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/cinnamon.nix

services.xserver.desktopManager.cinnamon.extraGSettingsOverrides

Additional gsettings overrides. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/cinnamon.nix

services.xserver.desktopManager.cinnamon.sessionPath

Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart.

Note that this should be a last resort; patching the package is preferred (see GPaste).

Type: list of package

Default

[ ]

Example

[ pkgs.gpaste ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/cinnamon.nix

services.xserver.desktopManager.deepin.enable

Whether to enable Deepin desktop manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/deepin.nix

services.xserver.desktopManager.deepin.extraGSettingsOverridePackages

List of packages for which gsettings are overridden. Type: list of path

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/deepin.nix

services.xserver.desktopManager.deepin.extraGSettingsOverrides

Additional gsettings overrides. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/deepin.nix

services.xserver.desktopManager.enlightenment.enable

Enable the Enlightenment desktop environment. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/enlightenment.nix

services.xserver.desktopManager.gnome.debug

Whether to enable gnome-session debug messages. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.enable

Enable GNOME desktop manager. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.extraGSettingsOverridePackages

List of packages for which gsettings are overridden. Type: list of path

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.extraGSettingsOverrides

Additional gsettings overrides. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.flashback.customSessions

Other GNOME Flashback sessions to enable. Type: list of (submodule)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.flashback.customSessions.*.enableGnomePanel

Whether to enable the GNOME panel in this session. Type: boolean

Default

true

Example

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.flashback.customSessions.*.wmCommand

The executable of the window manager to use. Type: string

Example

"${pkgs.haskellPackages.xmonad}/bin/xmonad"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.flashback.customSessions.*.wmLabel

The name of the window manager to show in the session chooser. Type: string

Example

"XMonad"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.flashback.customSessions.*.wmName

A unique identifier for the window manager. Type: string matching the pattern [a-zA-Z0-9_-]+

Example

"xmonad"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.flashback.enableMetacity

Whether to enable the standard GNOME Flashback session with Metacity. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.flashback.panelModulePackages

Packages containing modules that should be made available to gnome-panel (usually for applets).

If you're packaging something to use here, please install the modules in $out/lib/gnome-panel/modules.

Type: list of package

Default

[ pkgs.gnome.gnome-applets ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.gnome.sessionPath

Additional list of packages to be added to the session search path. Useful for GNOME Shell extensions or GSettings-conditional autostart.

Note that this should be a last resort; patching the package is preferred (see GPaste).

Type: list of package

Default

[ ]

Example

[ pkgs.gpaste ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/gnome.nix

services.xserver.desktopManager.kodi.enable

Enable the kodi multimedia center. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/kodi.nix

services.xserver.desktopManager.kodi.package

The kodi package to use. Type: package

Default

pkgs.kodi

Example

kodi.withPackages (p: with p; [ jellyfin pvr-iptvsimple vfs-sftp ])

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/kodi.nix

services.xserver.desktopManager.lumina.enable

Enable the Lumina desktop manager Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/lumina.nix

services.xserver.desktopManager.lxqt.enable

Enable the LXQt desktop manager Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/lxqt.nix

services.xserver.desktopManager.mate.debug

Whether to enable mate-session debug messages. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/mate.nix

services.xserver.desktopManager.mate.enable

Enable the MATE desktop environment Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/mate.nix

services.xserver.desktopManager.mate.enableWaylandSession

Whether to enable MATE Wayland session. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/mate.nix

services.xserver.desktopManager.mate.extraCajaExtensions

Extra extensions to add to caja. Type: list of package

Default

[ ]

Example

with pkgs.mate; [ caja-extensions ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/mate.nix

services.xserver.desktopManager.mate.extraPanelApplets

Extra applets to add to mate-panel. Type: list of package

Default

[ ]

Example

with pkgs.mate; [ mate-applets ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/mate.nix

services.xserver.desktopManager.pantheon.debug

Whether to enable gnome-session debug messages. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/pantheon.nix

services.xserver.desktopManager.pantheon.enable

Enable the pantheon desktop manager Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/pantheon.nix

services.xserver.desktopManager.pantheon.extraGSettingsOverridePackages

List of packages for which gsettings are overridden. Type: list of path

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/pantheon.nix

services.xserver.desktopManager.pantheon.extraGSettingsOverrides

Additional gsettings overrides. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/pantheon.nix

services.xserver.desktopManager.pantheon.extraSwitchboardPlugs

Plugs to add to Switchboard. Type: null or (list of package)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/pantheon.nix

services.xserver.desktopManager.pantheon.extraWingpanelIndicators

Indicators to add to Wingpanel. Type: null or (list of package)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/pantheon.nix

services.xserver.desktopManager.pantheon.sessionPath

Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart.

Note that this should be a last resort; patching the package is preferred (see GPaste).

Type: list of package

Default

[ ]

Example

[ pkgs.gpaste ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/pantheon.nix

services.xserver.desktopManager.phosh.enable

Enable the Phone Shell. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/phosh.nix

services.xserver.desktopManager.phosh.group

The group to run the Phosh service. Type: string

Example

"users"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/phosh.nix

services.xserver.desktopManager.phosh.package

The phosh package to use. Type: package

Default

pkgs.phosh

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/phosh.nix

services.xserver.desktopManager.phosh.phocConfig

Configurations for the Phoc compositor.

Type: strings concatenated with "\n" or path or (submodule)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/phosh.nix

services.xserver.desktopManager.phosh.user

The user to run the Phosh service. Type: string

Example

"alice"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/phosh.nix

services.xserver.desktopManager.plasma5.bigscreen.enable

Enable support for running the Plasma Bigscreen session.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.plasma5.enable

Enable the Plasma 5 (KDE 5) desktop environment. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.plasma5.mobile.enable

Enable support for running the Plasma Mobile shell.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.plasma5.mobile.installRecommendedSoftware

Installs software recommended for use with Plasma Mobile, but which is not strictly required for Plasma Mobile to run.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.plasma5.notoPackage

The Noto fonts package to use. Type: package

Default

pkgs.noto-fonts

Example

noto-fonts-lgc-plus

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.plasma5.phononBackend

Phonon audio backend to install. Type: one of "gstreamer", "vlc"

Default

"vlc"

Example

"gstreamer"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.plasma5.runUsingSystemd

Use systemd to manage the Plasma session Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.plasma5.useQtScaling

Enable HiDPI scaling in Qt. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/plasma5.nix

services.xserver.desktopManager.retroarch.enable

Whether to enable RetroArch. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/retroarch.nix

services.xserver.desktopManager.retroarch.extraArgs

Extra arguments to pass to RetroArch. Type: list of string

Default

[ ]

Example

["--verbose""--host"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/retroarch.nix

services.xserver.desktopManager.retroarch.package

The retroarch package to use. Type: package

Default

pkgs.retroarch

Example

retroarch-full

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/retroarch.nix

services.xserver.desktopManager.runXdgAutostartIfNone

Whether to run XDG autostart files for sessions without a desktop manager (with only a window manager), these sessions usually don't handle XDG autostart files by default.

Some services like {option}i18n.inputMethod and {option}service.earlyoom use XDG autostart files to start. If this option is not set to true and you are using a window manager without a desktop manager, you need to manually start them or running dex somewhere.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/none.nix

services.xserver.desktopManager.surf-display.defaultWwwUri

Default URI to display. Type: string

Default

"${pkgs.surf-display}/share/surf-display/empty-page.html"

Example

"https://www.example.com/"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/surf-display.nix

services.xserver.desktopManager.surf-display.enable

Whether to enable surf-display as a kiosk browser session. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/surf-display.nix

services.xserver.desktopManager.surf-display.extraConfig

Extra configuration options to append to /etc/default/surf-display.

Type: strings concatenated with "\n"

Default

""

Example

`#!nix '' # Enforce fixed resolution for all displays (default: not set): DEFAULT_RESOLUTION="1920x1080"

# HTTP proxy URL, if needed (default: not set). HTTP_PROXY_URL="http://webcache:3128"

# Configure individual display screens with host specific parameters: DISPLAYS['display-host-0']="www_uri=https://www.displayserver.comany.net/display-1/index.html" DISPLAYS['display-host-1']="www_uri=https://www.displayserver.comany.net/display-2/index.html" DISPLAYS['display-host-2']="www_uri=https://www.displayserver.comany.net/display-3/index.html|res=1920x1280" DISPLAYS['display-host-3']="www_uri=https://www.displayserver.comany.net/display-4/index.html"|res=1280x1024" DISPLAYS['display-host-local-file']="www_uri=file:///usr/share/doc/surf-display/empty-page.html" ''`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/surf-display.nix

services.xserver.desktopManager.surf-display.hideIdlePointer

Hide idle mouse pointer. Type: string

Default

"yes"

Example

"no"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/surf-display.nix

services.xserver.desktopManager.surf-display.inactivityInterval

Setting for internal inactivity timer to restart surf-display if the user goes inactive/idle to get a fresh session for the next user of the kiosk.

If this value is set to zero, the whole feature of restarting due to inactivity is disabled.

Type: signed integer

Default

300

Example

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/surf-display.nix

services.xserver.desktopManager.surf-display.pointerButtonMap

Disable right and middle pointer device click in browser sessions while keeping scrolling wheels' functionality intact. See pointer subcommand on man xmodmap for details.

Type: string

Default

"1 0 0 4 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/surf-display.nix

services.xserver.desktopManager.surf-display.screensaverSettings

Screensaver settings, see man 1 xset for possible options.

Type: strings concatenated with " "

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/surf-display.nix

services.xserver.desktopManager.wallpaper.combineScreens

When set to true the wallpaper will stretch across all screens. When set to false the wallpaper is duplicated to all screens.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/default.nix

services.xserver.desktopManager.wallpaper.mode

The file {file}~/.background-image is used as a background image. This option specifies the placement of this image onto your desktop.

Possible values: center: Center the image on the background. If it is too small, it will be surrounded by a black border. fill: Like scale, but preserves aspect ratio by zooming the image until it fits. Either a horizontal or a vertical part of the image will be cut off. max: Like fill, but scale the image to the maximum size that fits the screen with black borders on one side. scale: Fit the file into the background without repeating it, cutting off stuff or using borders. But the aspect ratio is not preserved either. tile: Tile (repeat) the image in case it is too small for the screen.

Type: one of "center", "fill", "max", "scale", "tile"

Default

"scale"

Example

"fill"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/default.nix

services.xserver.desktopManager.xfce.enable

Enable the Xfce desktop environment. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/xfce.nix

services.xserver.desktopManager.xfce.enableScreensaver

Enable the XFCE screensaver. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/xfce.nix

services.xserver.desktopManager.xfce.enableXfwm

Enable the XFWM (default) window manager. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/xfce.nix

services.xserver.desktopManager.xfce.noDesktop

Don't install XFCE desktop components (xfdesktop and panel). Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/xfce.nix

services.xserver.desktopManager.xterm.enable

Enable a xterm terminal as a desktop manager. Type: boolean

Default

versionOlder config.system.stateVersion "19.09" && config.services.xserver.enable;

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/desktop-managers/xterm.nix

services.xserver.digimend.enable

Whether to enable the digimend drivers for Huion/XP-Pen/etc. tablets. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/digimend.nix

services.xserver.displayManager.gdm.autoLogin.delay

Seconds of inactivity after which the autologin will be performed.

Type: signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/gdm.nix

services.xserver.displayManager.gdm.autoSuspend

On the GNOME Display Manager login screen, suspend the machine after inactivity. (Does not affect automatic suspend while logged in, or at lock screen.)

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/gdm.nix

services.xserver.displayManager.gdm.banner

Optional message to display on the login screen.

Type: null or strings concatenated with "\n"

Default

null

Example

'' foo bar baz''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/gdm.nix

services.xserver.displayManager.gdm.debug

Whether to enable debugging messages in GDM. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/gdm.nix

services.xserver.displayManager.gdm.enable

Whether to enable GDM, the GNOME Display Manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/gdm.nix

services.xserver.displayManager.gdm.settings

Options passed to the gdm daemon. See here for supported options.

Type: attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default

{ }

Example

{debug = {enable = true;};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/gdm.nix

services.xserver.displayManager.gdm.wayland

Allow GDM to run on Wayland instead of Xserver.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/gdm.nix

services.xserver.displayManager.lightdm.autoLogin.timeout

Show the greeter for this many seconds before automatic login occurs.

Type: signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.background

The background image or color to use.

Type: path or string matching the pattern ^#[0-9]{6}$

Default

pkgs.nixos-artwork.wallpapers.simple-dark-gray-bottom.gnomeFilePath

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.enable

Whether to enable lightdm as the display manager.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.extraConfig

Extra lines to append to LightDM section. Type: strings concatenated with "\n"

Default

""

Example

'' user-authority-in-system-dir = true''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.extraSeatDefaults

Extra lines to append to SeatDefaults section. Type: strings concatenated with "\n"

Default

""

Example

'' greeter-show-manual-login=true''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.greeter.enable

If set to false, run lightdm in greeterless mode. This only works if autologin is enabled and autoLogin.timeout is zero.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.greeter.name

The name of a .desktop file in the directory specified in the 'package' option.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.greeter.package

The LightDM greeter to login via. The package should be a directory containing a .desktop file matching the name in the 'name' option.

Type: package

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm.nix

services.xserver.displayManager.lightdm.greeters.enso.blur

Whether or not to enable blur

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.brightness

Brightness

Type: signed integer

Default

7

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.cursorTheme.name

Name of the cursor theme to use for the lightdm-enso-os-greeter

Type: string

Default

"capitane-cursors"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.cursorTheme.package

The package path that contains the cursor theme given in the name option.

Type: package

Default

pkgs.capitaine-cursors

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.enable

Whether to enable enso-os-greeter as the lightdm greeter

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.extraConfig

Extra configuration that should be put in the greeter.conf configuration file

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.iconTheme.name

Name of the icon theme to use for the lightdm-enso-os-greeter

Type: string

Default

"ePapirus"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.iconTheme.package

The package path that contains the icon theme given in the name option.

Type: package

Default

pkgs.papirus-icon-theme

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.theme.name

Name of the theme to use for the lightdm-enso-os-greeter

Type: string

Default

"Adwaita"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.enso.theme.package

The package path that contains the theme given in the name option.

Type: package

Default

pkgs.gnome-themes-extra

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix

services.xserver.displayManager.lightdm.greeters.gtk.clock-format

Clock format string (as expected by strftime, e.g. "%H:%M") to use with the lightdm gtk greeter panel.

If set to null the default clock format is used.

Type: null or string

Default

null

Example

"%F"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.cursorTheme.name

Name of the cursor theme to use for the lightdm-gtk-greeter.

Type: string

Default

"Adwaita"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.cursorTheme.package

The package path that contains the cursor theme given in the name option.

Type: package

Default

pkgs.adwaita-icon-theme

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.cursorTheme.size

Size of the cursor theme to use for the lightdm-gtk-greeter.

Type: signed integer

Default

16

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.enable

Whether to enable lightdm-gtk-greeter as the lightdm greeter.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.extraConfig

Extra configuration that should be put in the lightdm-gtk-greeter.conf configuration file.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.iconTheme.name

Name of the icon theme to use for the lightdm-gtk-greeter.

Type: string

Default

"Adwaita"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.iconTheme.package

The package path that contains the icon theme given in the name option.

Type: package

Default

pkgs.adwaita-icon-theme

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.indicators

List of allowed indicator modules to use for the lightdm gtk greeter panel.

Built-in indicators include "~a11y", "~language", "~session", "~power", "~clock", "~host", "~spacer". Unity indicators can be represented by short name (e.g. "sound", "power"), service file name, or absolute path.

If set to null the default indicators are used.

Type: null or (list of string)

Default

null

Example

["~host""~spacer""~clock""~spacer""~session""~language""~a11y""~power"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.theme.name

Name of the theme to use for the lightdm-gtk-greeter.

Type: string

Default

"Adwaita"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.gtk.theme.package

The package path that contains the theme given in the name option.

Type: package

Default

pkgs.gnome-themes-extra

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix

services.xserver.displayManager.lightdm.greeters.lomiri.enable

Whether to enable lomiri's greeter as the lightdm greeter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/lomiri.nix

services.xserver.displayManager.lightdm.greeters.mini.enable

Whether to enable lightdm-mini-greeter as the lightdm greeter.

Note that this greeter starts only the default X session. You can configure the default X session using .

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix

services.xserver.displayManager.lightdm.greeters.mini.extraConfig

Extra configuration that should be put in the lightdm-mini-greeter.conf configuration file.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix

services.xserver.displayManager.lightdm.greeters.mini.user

The user to login as.

Type: string

Default

"root"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix

services.xserver.displayManager.lightdm.greeters.mobile.enable

Whether to enable lightdm-mobile-greeter as the lightdm greeter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/mobile.nix

services.xserver.displayManager.lightdm.greeters.pantheon.enable

Whether to enable elementary-greeter as the lightdm greeter.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix

services.xserver.displayManager.lightdm.greeters.slick.cursorTheme.name

Name of the cursor theme to use for the lightdm-slick-greeter.

Type: string

Default

"Adwaita"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.cursorTheme.package

The package path that contains the cursor theme given in the name option.

Type: package

Default

pkgs.adwaita-icon-theme

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.cursorTheme.size

Size of the cursor theme to use for the lightdm-slick-greeter.

Type: signed integer

Default

24

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.draw-user-backgrounds

Whether to enable draw user backgrounds. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.enable

Whether to enable lightdm-slick-greeter as the lightdm greeter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.extraConfig

Extra configuration that should be put in the lightdm-slick-greeter.conf configuration file.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.font.name

Name of the font to use.

Type: string

Default

"Ubuntu 11"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.font.package

The package path that contains the font given in the name option.

Type: package

Default

pkgs.ubuntu-classic

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.iconTheme.name

Name of the icon theme to use for the lightdm-slick-greeter.

Type: string

Default

"Adwaita"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.iconTheme.package

The package path that contains the icon theme given in the name option.

Type: package

Default

pkgs.adwaita-icon-theme

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.theme.name

Name of the theme to use for the lightdm-slick-greeter.

Type: string

Default

"Adwaita"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.slick.theme.package

The package path that contains the theme given in the name option.

Type: package

Default

pkgs.gnome-themes-extra

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix

services.xserver.displayManager.lightdm.greeters.tiny.enable

Whether to enable lightdm-tiny-greeter as the lightdm greeter.

Note that this greeter starts only the default X session. You can configure the default X session using .

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix

services.xserver.displayManager.lightdm.greeters.tiny.extraConfig

Section to describe style and ui.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix

services.xserver.displayManager.lightdm.greeters.tiny.label.pass

The string to represent the pass_text label.

Type: string

Default

"Password"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix

services.xserver.displayManager.lightdm.greeters.tiny.label.user

The string to represent the user_text label.

Type: string

Default

"Username"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix

services.xserver.displayManager.session

List of sessions supported with the command used to start each session. Each session script can set the {var}waitPID shell variable to make this script wait until the end of the user session. Each script is used to define either a window manager or a desktop manager. These can be differentiated by setting the attribute {var}manage either to "window" or "desktop".

The list of desktop manager and window manager should appear inside the display manager with the desktop manager name followed by the window manager name.

Type: list of (attribute set)

Default

[ ]

Example

[ { manage = "desktop";name = "xterm";start = '' ${pkgs.xterm}/bin/xterm -ls & waitPID=$! '';}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/default.nix

services.xserver.displayManager.sessionCommands

Shell commands executed just before the window or desktop manager is started. These commands are not currently sourced for Wayland sessions.

Type: strings concatenated with "\n"

Default

""

Example

'' xmessage "Hello World!" &''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/default.nix

services.xserver.displayManager.setupCommands

Shell commands executed just after the X server has started.

This option is only effective for display managers for which this feature is supported; currently these are LightDM, GDM and SDDM.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/default.nix

services.xserver.displayManager.startx.enable

Whether to enable the dummy "startx" pseudo-display manager, which allows users to start X manually via the "startx" command from a vt shell. The X server runs under the user's id, not as root. The user must provide a ~/.xinitrc file containing session startup commands, see startx(1). This is not automatically generated from the desktopManager and windowManager settings.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/startx.nix

services.xserver.displayManager.sx.enable

Whether to enable the "sx" pseudo-display manager, which allows users to start manually via the "sx" command from a vt shell. The X server runs under the user's id, not as root. The user must provide a ~/.config/sx/sxrc file containing session startup commands, see sx(1). This is not automatically generated from the desktopManager and windowManager settings. sx doesn't have a way to directly set X server flags, but it can be done by overriding its xorgserver dependency.

Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/sx.nix

services.xserver.displayManager.xpra.auth

Authentication to use when connecting to xpra Type: string

Default

"pam"

Example

"password:value=mysecret"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/xpra.nix

services.xserver.displayManager.xpra.bindTcp

Bind xpra to TCP Type: null or string

Default

"127.0.0.1:10000"

Example

"0.0.0.0:10000"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/xpra.nix

services.xserver.displayManager.xpra.desktop

Start a desktop environment instead of seamless mode Type: null or string

Default

null

Example

"gnome-shell"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/xpra.nix

services.xserver.displayManager.xpra.enable

Whether to enable xpra as display manager. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/xpra.nix

services.xserver.displayManager.xpra.extraOptions

Extra xpra options Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/xpra.nix

services.xserver.displayManager.xpra.pulseaudio

Whether to enable pulseaudio audio streaming. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/xpra.nix

services.xserver.displayManager.xserverArgs

List of arguments for the X server. Type: list of string

Default

[ ]

Example

["-ac""-logverbose""-verbose""-nolisten tcp"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/default.nix

services.xserver.displayManager.xserverBin

Path to the X server used by display managers. Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/display-managers/default.nix

services.xserver.imwheel.enable

Whether to enable IMWheel service. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/imwheel.nix

services.xserver.imwheel.extraOptions

Additional command-line arguments to pass to {command}imwheel.

Type: list of string

Default

["--buttons=45"]

Example

["--debug"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/imwheel.nix

services.xserver.imwheel.rules

Window class translation rules. /etc/X11/imwheelrc is generated based on this config which means this config is global for all users. See official man pages for more information.

Type: attribute set of string

Default

{ }

Example

{".*" = '' None, Up, Button4, 8 None, Down, Button5, 8 Shift_L, Up, Shift_L|Button4, 4 Shift_L, Down, Shift_L|Button5, 4 Control_L, Up, Control_L|Button4 Control_L, Down, Control_L|Button5 '';}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/imwheel.nix

services.xserver.synaptics.accelFactor

Cursor acceleration (how fast speed increases from minSpeed to maxSpeed). Type: null or string

Default

"0.001"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.additionalOptions

Additional options for synaptics touchpad driver.

Type: string

Default

""

Example

'' Option "RTCornerButton" "2" Option "RBCornerButton" "3"''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.buttonsMap

Remap touchpad buttons. Type: list of signed integer

Default

[123]

Example

[132]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.dev

Path for touchpad device. Set to null to apply to any auto-detected touchpad.

Type: null or string

Default

null

Example

"/dev/input/event0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.enable

Whether to enable touchpad support. Deprecated: Consider services.libinput.enable. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.fingersMap

Remap several-fingers taps. Type: list of signed integer

Default

[123]

Example

[132]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.horizEdgeScroll

Whether to enable horizontal edge drag-scrolling. Type: boolean

Default

! config.services.xserver.synaptics.horizTwoFingerScroll

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.horizTwoFingerScroll

Whether to enable horizontal two-finger drag-scrolling. Type: boolean

Default

config.services.xserver.synaptics.twoFingerScroll

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.horizontalScroll

Whether to enable horizontal scrolling (on touchpad) Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.maxSpeed

Cursor speed factor for highest-speed finger motion. Type: null or string

Default

"1.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.minSpeed

Cursor speed factor for precision finger motion. Type: null or string

Default

"0.6"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.palmDetect

Whether to enable palm detection (hardware support required) Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.palmMinWidth

Minimum finger width at which touch is considered a palm Type: null or signed integer

Default

null

Example

5

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.palmMinZ

Minimum finger pressure at which touch is considered a palm Type: null or signed integer

Default

null

Example

20

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.scrollDelta

Move distance of the finger for a scroll event. Type: null or signed integer

Default

null

Example

75

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.tapButtons

Whether to enable tap buttons. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.twoFingerScroll

Whether to enable two-finger drag-scrolling. Overridden by horizTwoFingerScroll and vertTwoFingerScroll. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.vertEdgeScroll

Whether to enable vertical edge drag-scrolling. Type: boolean

Default

! config.services.xserver.synaptics.vertTwoFingerScroll

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.synaptics.vertTwoFingerScroll

Whether to enable vertical two-finger drag-scrolling. Type: boolean

Default

config.services.xserver.synaptics.twoFingerScroll

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/synaptics.nix

services.xserver.wacom.enable

Whether to enable the Wacom touchscreen/digitizer/tablet. If you ever have any issues such as, try switching to terminal (ctrl-alt-F1) and back which will make Xorg reconfigure the device ?

If you're not satisfied by the default behaviour you can override {option}environment.etc."X11/xorg.conf.d/70-wacom.conf" in configuration.nix easily.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/hardware/wacom.nix

services.xserver.windowManager."2bwm".enable

Whether to enable 2bwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/2bwm.nix

services.xserver.windowManager.afterstep.enable

Whether to enable afterstep. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/afterstep.nix

services.xserver.windowManager.awesome.enable

Whether to enable Awesome window manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/awesome.nix

services.xserver.windowManager.awesome.luaModules

List of lua packages available for being used in the Awesome configuration. Type: list of package

Default

[ ]

Example

[ pkgs.luaPackages.vicious ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/awesome.nix

services.xserver.windowManager.awesome.noArgb

Disable client transparency support, which can be greatly detrimental to performance in some setups Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/awesome.nix

services.xserver.windowManager.awesome.package

The awesome package to use. Type: package

Default

pkgs.awesome

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/awesome.nix

services.xserver.windowManager.berry.enable

Whether to enable berry. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/berry.nix

services.xserver.windowManager.bspwm.configFile

Path to the bspwm configuration file. If null, $HOME/.config/bspwm/bspwmrc will be used.

Type: null or path

Default

null

Example

"${pkgs.bspwm}/share/doc/bspwm/examples/bspwmrc"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/bspwm.nix

services.xserver.windowManager.bspwm.enable

Whether to enable bspwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/bspwm.nix

services.xserver.windowManager.bspwm.package

The bspwm package to use. Type: package

Default

pkgs.bspwm

Example

bspwm-unstable

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/bspwm.nix

services.xserver.windowManager.bspwm.sxhkd.configFile

Path to the sxhkd configuration file. If null, $HOME/.config/sxhkd/sxhkdrc will be used.

Type: null or path

Default

null

Example

"${pkgs.bspwm}/share/doc/bspwm/examples/sxhkdrc"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/bspwm.nix

services.xserver.windowManager.bspwm.sxhkd.package

The sxhkd package to use. Type: package

Default

pkgs.sxhkd

Example

sxhkd-unstable

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/bspwm.nix

services.xserver.windowManager.clfswm.enable

Whether to enable clfswm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/clfswm.nix

services.xserver.windowManager.clfswm.package

The clfswm package to use. Type: package

Default

pkgs.sbclPackages.clfswm

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/clfswm.nix

services.xserver.windowManager.cwm.enable

Whether to enable cwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/cwm.nix

services.xserver.windowManager.dk.enable

Whether to enable dk. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/dk.nix

services.xserver.windowManager.dk.package

The dk package to use. Type: package

Default

pkgs.dk

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/dk.nix

services.xserver.windowManager.dwm.enable

Whether to enable dwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/dwm.nix

services.xserver.windowManager.dwm.package

The dwm package to use. Type: package

Default

pkgs.dwm

Example

pkgs.dwm.overrideAttrs (oldAttrs: rec {patches = [(super.fetchpatch {url = "https://dwm.suckless.org/patches/steam/dwm-steam-6.2.diff";sha256 = "sha256-f3lffBjz7+0Khyn9c9orzReoLTqBb/9gVGshYARGdVc=";})];})

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/dwm.nix

services.xserver.windowManager.e16.enable

Whether to enable e16. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/e16.nix

services.xserver.windowManager.evilwm.enable

Whether to enable evilwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/evilwm.nix

services.xserver.windowManager.exwm.enable

Whether to enable exwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/exwm.nix

services.xserver.windowManager.exwm.enableDefaultConfig

Enable an uncustomised exwm configuration. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/exwm.nix

services.xserver.windowManager.exwm.extraPackages

Extra packages available to Emacs. The value must be a function which receives the attrset defined in {var}emacs.pkgs as the sole argument.

Type: function that evaluates to a(n) list of package

Default

epkgs: []

Example

epkgs: [epkgs.emmsepkgs.magitepkgs.proofgeneral]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/exwm.nix

services.xserver.windowManager.exwm.loadScript

Emacs lisp code to be run after loading the user's init file. If enableDefaultConfig is true, this will be run before loading the default config.

Type: strings concatenated with "\n"

Default

"(require 'exwm)"

Example

'' (require 'exwm) (exwm-enable)''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/exwm.nix

services.xserver.windowManager.fluxbox.enable

Whether to enable fluxbox. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/fluxbox.nix

services.xserver.windowManager.fvwm2.enable

Whether to enable Fvwm2 window manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/fvwm2.nix

services.xserver.windowManager.fvwm2.gestures

Whether or not to enable libstroke for gesture support Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/fvwm2.nix

services.xserver.windowManager.fvwm3.enable

Whether to enable Fvwm3 window manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/fvwm3.nix

services.xserver.windowManager.hackedbox.enable

Whether to enable hackedbox. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/hackedbox.nix

services.xserver.windowManager.herbstluftwm.configFile

Path to the herbstluftwm configuration file. If left at the default value, $XDG_CONFIG_HOME/herbstluftwm/autostart will be used.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/herbstluftwm.nix

services.xserver.windowManager.herbstluftwm.enable

Whether to enable herbstluftwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/herbstluftwm.nix

services.xserver.windowManager.herbstluftwm.package

The herbstluftwm package to use. Type: package

Default

pkgs.herbstluftwm

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/herbstluftwm.nix

services.xserver.windowManager.hypr.enable

Whether to enable hypr. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/hypr.nix

services.xserver.windowManager.i3.configFile

Path to the i3 configuration file. If left at the default value, $HOME/.i3/config will be used.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/i3.nix

services.xserver.windowManager.i3.enable

Whether to enable i3 window manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/i3.nix

services.xserver.windowManager.i3.extraPackages

Extra packages to be installed system wide.

Type: list of package

Default

with pkgs; [dmenui3statusi3lock]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/i3.nix

services.xserver.windowManager.i3.extraSessionCommands

Shell commands executed just before i3 is started.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/i3.nix

services.xserver.windowManager.i3.package

The i3 package to use. Type: package

Default

pkgs.i3

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/i3.nix

services.xserver.windowManager.i3.updateSessionEnvironment

Whether to run dbus-update-activation-environment and systemctl import-environment before session start. Required for xdg portals to function properly.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/i3.nix

services.xserver.windowManager.icewm.enable

Whether to enable icewm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/icewm.nix

services.xserver.windowManager.jwm.enable

Whether to enable jwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/jwm.nix

services.xserver.windowManager.katriawm.enable

Whether to enable katriawm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/katriawm.nix

services.xserver.windowManager.katriawm.package

The katriawm package to use. Type: package

Default

pkgs.katriawm

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/katriawm.nix

services.xserver.windowManager.leftwm.enable

Whether to enable leftwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/leftwm.nix

services.xserver.windowManager.lwm.enable

Whether to enable lwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/lwm.nix

services.xserver.windowManager.metacity.enable

Whether to enable metacity. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/metacity.nix

services.xserver.windowManager.mlvwm.configFile

Path to the mlvwm configuration file. If left at the default value, $HOME/.mlvwmrc will be used.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/mlvwm.nix

services.xserver.windowManager.mlvwm.enable

Whether to enable Macintosh-like Virtual Window Manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/mlvwm.nix

services.xserver.windowManager.mwm.enable

Whether to enable mwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/mwm.nix

services.xserver.windowManager.nimdow.enable

Whether to enable nimdow. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/nimdow.nix

services.xserver.windowManager.nimdow.package

nimdow package to use Type: package

Default

"pkgs.nimdow"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/nimdow.nix

services.xserver.windowManager.notion.enable

Whether to enable notion. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/notion.nix

services.xserver.windowManager.openbox.enable

Whether to enable openbox. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/openbox.nix

services.xserver.windowManager.pekwm.enable

Whether to enable pekwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/pekwm.nix

services.xserver.windowManager.qtile.configFile

Path to the qtile configuration file. If null, $XDG_CONFIG_HOME/qtile/config.py will be used.

Type: null or path

Default

null

Example

./your_config.py

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/qtile.nix

services.xserver.windowManager.qtile.enable

Whether to enable qtile. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/qtile.nix

services.xserver.windowManager.qtile.extraPackages

Extra Python packages available to Qtile. An example would be to include python3Packages.qtile-extras for additional unofficial widgets.

Type: function that evaluates to a(n) list of package

Default

python3Packages: with python3Packages; [];

Example

python3Packages: with python3Packages; [qtile-extras];

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/qtile.nix

services.xserver.windowManager.qtile.package

The qtile-unwrapped package to use. Type: package

Default

pkgs.qtile-unwrapped

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/qtile.nix

services.xserver.windowManager.ragnarwm.enable

Whether to enable ragnarwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/ragnarwm.nix

services.xserver.windowManager.ragnarwm.package

The ragnarwm package to use. Type: package

Default

pkgs.ragnarwm

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/ragnarwm.nix

services.xserver.windowManager.ratpoison.enable

Whether to enable ratpoison. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/ratpoison.nix

services.xserver.windowManager.sawfish.enable

Whether to enable sawfish. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/sawfish.nix

services.xserver.windowManager.smallwm.enable

Whether to enable smallwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/smallwm.nix

services.xserver.windowManager.spectrwm.enable

Whether to enable spectrwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/spectrwm.nix

services.xserver.windowManager.stumpwm.enable

Whether to enable stumpwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/stumpwm.nix

services.xserver.windowManager.tinywm.enable

Whether to enable tinywm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/tinywm.nix

services.xserver.windowManager.twm.enable

Whether to enable twm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/twm.nix

services.xserver.windowManager.windowlab.enable

Whether to enable windowlab. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/windowlab.nix

services.xserver.windowManager.windowmaker.enable

Whether to enable windowmaker. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/windowmaker.nix

services.xserver.windowManager.wmderland.enable

Whether to enable wmderland. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/wmderland.nix

services.xserver.windowManager.wmderland.extraPackages

Extra packages to be installed system wide.

Type: list of package

Default

with pkgs; [rofidunstlighthsetrootfehrxvt-unicode]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/wmderland.nix

services.xserver.windowManager.wmderland.extraSessionCommands

Shell commands executed just before wmderland is started.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/wmderland.nix

services.xserver.windowManager.wmii.enable

Whether to enable wmii. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/wmii.nix

services.xserver.windowManager.xmonad.config

Configuration from which XMonad gets compiled. If no value is specified, a vanilla xmonad binary is put in PATH, which will attempt to recompile and exec your xmonad config from $HOME/.xmonad. This setup is then analogous to other (non-NixOS) linux distributions.

If you do set this option, you likely want to use "launch" as your entry point for xmonad (as in the example), to avoid xmonad's recompilation logic on startup. Doing so will render the default "mod+q" restart key binding dysfunctional though, because that attempts to call your binary with the "--restart" command line option, unless you implement that yourself. You way mant to bind "mod+q" to (restart "xmonad" True) instead, which will just restart xmonad from PATH. This allows e.g. switching to the new xmonad binary after rebuilding your system with nixos-rebuild. For the same reason, ghc is not added to the environment when this option is set, unless {option}enableConfiguredRecompile is set to true.

If you actually want to run xmonad with a config specified here, but also be able to recompile and restart it from a copy of that source in $HOME/.xmonad on the fly, set {option}enableConfiguredRecompile to true and implement something like "compileRestart" from the example. This should allow you to switch at will between the local xmonad and the one NixOS puts in your PATH.

Type: null or path or string

Default

null

Example

`#!nix '' import XMonad import XMonad.Util.EZConfig (additionalKeys) import Control.Monad (when) import Text.Printf (printf) import System.Posix.Process (executeFile) import System.Info (arch,os) import System.Environment (getArgs) import System.FilePath (())

compiledConfig = printf "xmonad-%s-%s" arch os

myConfig = defaultConfig { modMask = mod4Mask -- Use Super instead of Alt , terminal = "urxvt" } additionalKeys [ ( (mod4Mask,xK_r), compileRestart True) , ( (mod4Mask,xK_q), restart "xmonad" True ) ]

compileRestart resume = do dirs <- asks directories whenX (recompile dirs True) $ do when resume writeStateToFile catchIO ( do args <- getArgs executeFile (cacheDir dirs compiledConfig) False args Nothing )

main = getDirectories >>= launch myConfig


{- For versions before 0.17.0 use this instead -}


-- compileRestart resume = -- whenX (recompile True) $ -- when resume writeStateToFile -- *> catchIO -- ( do -- dir <- getXMonadDataDir -- args <- getArgs -- executeFile (dir compiledConfig) False args Nothing -- ) -- -- main = launch myConfig


''`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.xmonad.enable

Whether to enable xmonad. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.xmonad.enableConfiguredRecompile

Enable recompilation even if {option}config is set to a non-null value. This adds the necessary Haskell dependencies (GHC with packages) to the xmonad binary's environment.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.xmonad.enableContribAndExtras

Enable xmonad-{contrib,extras} in Xmonad. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.xmonad.extraPackages

Extra packages available to ghc when rebuilding Xmonad. The value must be a function which receives the attrset defined in {var}haskellPackages as the sole argument.

Type: function that evaluates to a(n) list of package

Default

self: []

Example

haskellPackages: [haskellPackages.xmonad-contribhaskellPackages.monad-logger]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.xmonad.ghcArgs

Command line arguments passed to the compiler (ghc) invocation when xmonad.config is set.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.xmonad.haskellPackages

haskellPackages used to build Xmonad and other packages. This can be used to change the GHC version used to build Xmonad and the packages listed in {var}extraPackages.

Type: attribute set

Default

pkgs.haskellPackages

Example

pkgs.haskell.packages.ghc810

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.xmonad.xmonadCliArgs

Command line arguments passed to the xmonad binary.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/xmonad.nix

services.xserver.windowManager.yeahwm.enable

Whether to enable yeahwm. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/window-managers/yeahwm.nix

services.xserver.xautolock.enable

Whether to enable xautolock. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.enableNotifier

Whether to enable the notifier feature of xautolock. This publishes a notification before the autolock.

Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.extraOptions

Additional command-line arguments to pass to {command}xautolock.

Type: list of string

Default

[ ]

Example

["-detectsleep"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.killer

The script to use when nothing has happened for as long as {option}killtime

Type: null or string

Default

null

Example

"/run/current-system/systemd/bin/systemctl suspend"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.killtime

Minutes xautolock waits until it executes the script specified in {option}killer (Has to be at least 10 minutes)

Type: signed integer

Default

20

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.locker

The script to use when automatically locking the computer.

Type: string

Default

"${pkgs.xlockmore}/bin/xlock"

Example

"${pkgs.i3lock}/bin/i3lock -i /path/to/img"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.notifier

Notification script to be used to warn about the pending autolock.

Type: null or string

Default

null

Example

"${pkgs.libnotify}/bin/notify-send 'Locking in 10 seconds'"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.notify

Time (in seconds) before the actual lock when the notification about the pending lock should be published.

Type: signed integer

Default

10

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.nowlocker

The script to use when manually locking the computer with {command}xautolock -locknow.

Type: null or string

Default

null

Example

"${pkgs.i3lock}/bin/i3lock -i /path/to/img"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xautolock.time

Idle time (in minutes) to wait until xautolock locks the computer.

Type: signed integer

Default

15

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xautolock.nix

services.xserver.xkb.extraLayouts

Extra custom layouts that will be included in the xkb configuration. Information on how to create a new layout can be found here: https://www.x.org/releases/current/doc/xorg-docs/input/XKB-Enhancing.html#Defining_New_Layouts. For more examples see https://wiki.archlinux.org/index.php/X_KeyBoard_extension#Basic_examples

Type: attribute set of (submodule)

Default

{ }

Example

{mine = {description = "My custom xkb layout.";languages = [ "eng" ];symbolsFile = /path/to/my/layout;};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.xkb.extraLayouts.<name>.compatFile

The path to the xkb compat file. This file sets the compatibility state, used to preserve compatibility with xkb-unaware programs. It must contain a xkb_compat "name" { ... } block.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.xkb.extraLayouts.<name>.description

A short description of the layout. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.xkb.extraLayouts.<name>.geometryFile

The path to the xkb geometry file. This (completely optional) file describes the physical layout of keyboard, which maybe be used by programs to depict it. It must contain a xkb_geometry "name" { ... } block.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.xkb.extraLayouts.<name>.keycodesFile

The path to the xkb keycodes file. This file specifies the range and the interpretation of the raw keycodes sent by the keyboard. It must contain a xkb_keycodes "name" { ... } block.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.xkb.extraLayouts.<name>.languages

A list of languages provided by the layout. (Use ISO 639-2 codes, for example: "eng" for english)

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.xkb.extraLayouts.<name>.symbolsFile

The path to the xkb symbols file. This is the most important file: it defines which symbol or action maps to each key and must contain a xkb_symbols "name" { ... } block.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.xkb.extraLayouts.<name>.typesFile

The path to the xkb types file. This file specifies the key types that can be associated with the various keyboard keys. It must contain a xkb_types "name" { ... } block.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/extra-layouts.nix

services.xserver.autoRepeatDelay

Sets the autorepeat delay (length of time in milliseconds that a key must be depressed before autorepeat starts).

Type: null or signed integer

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.autoRepeatInterval

Sets the autorepeat interval (length of time in milliseconds that should elapse between autorepeat-generated keystrokes).

Type: null or signed integer

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.autorun

Whether to start the X server automatically.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.config

The contents of the configuration file of the X server ({file}xorg.conf).

This option is set by multiple modules, and the configs are concatenated together.

In Xorg configs the last config entries take precedence, so you may want to use lib.mkAfter on this option to override NixOS's defaults.

Type: strings concatenated with "\n"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.defaultDepth

Default colour depth. Type: signed integer

Default

0

Example

8

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.deviceSection

Contents of the first Device section of the X server configuration file. Type: strings concatenated with "\n"

Default

""

Example

"VideoRAM 131072"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.display

Display number for the X server. Type: null or signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.dpi

Force global DPI resolution to use for X server. It's recommended to use this only when DPI is detected incorrectly; also consider using Monitor section in configuration file instead.

Type: null or signed integer

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.enable

Whether to enable the X server.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.enableCtrlAltBackspace

Whether to enable the DontZap option, which binds Ctrl+Alt+Backspace to forcefully kill X. This can lead to data loss and is disabled by default.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.enableTCP

Whether to allow the X server to accept TCP connections.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.excludePackages

Which X11 packages to exclude from the default environment Type: list of package

Default

[ ]

Example

[ pkgs.xterm ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.exportConfiguration

Whether to symlink the X server configuration under {file}/etc/X11/xorg.conf.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.extraConfig

Additional contents (sections) included in the X server configuration file Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.extraDisplaySettings

Lines to be added to every Display subsection of the Screen section. Type: strings concatenated with "\n"

Default

""

Example

"Virtual 2048 2048"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.filesSection

Contents of the first Files section of the X server configuration file. Type: strings concatenated with "\n"

Default

""

Example

"FontPath \"/path/to/my/fonts\""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.fontPath

Set the X server FontPath. Defaults to null, which means the compiled in defaults will be used. See man xorg.conf for details.

Type: null or string

Default

null

Example

"unix/:7100"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.inputClassSections

Content of additional InputClass sections of the X server configuration file. Type: list of strings concatenated with "\n"

Default

[ ]

Example

[ '' Identifier "Trackpoint Wheel Emulation" MatchProduct "ThinkPad USB Keyboard with TrackPoint" Option "EmulateWheel" "true" Option "EmulateWheelButton" "2" Option "Emulate3Buttons" "false" '']

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.logFile

Controls the file Xorg logs to.

The default of /dev/null is set so that systemd services (like displayManagers) only log to the journal and don't create their own log files.

Setting this to null will not pass the -logfile argument to Xorg which allows it to log to its default logfile locations instead (see man Xorg). You probably only want this behaviour when running Xorg manually (e.g. via startx).

Type: null or string

Default

"/dev/null"

Example

"/var/log/Xorg.0.log"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.moduleSection

Contents of the Module section of the X server configuration file. Type: strings concatenated with "\n"

Default

""

Example

'' SubSection "extmod" EndSubsection''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.modules

Packages to be added to the module search path of the X server. Type: list of path

Default

[ ]

Example

[ pkgs.xf86_input_wacom ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.monitorSection

Contents of the first Monitor section of the X server configuration file. Type: strings concatenated with "\n"

Default

""

Example

"HorizSync 28-49"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.resolutions

The screen resolutions for the X server. The first element is the default resolution. If this list is empty, the X server will automatically configure the resolution.

Type: list of (attribute set)

Default

[ ]

Example

[{x = 1600;y = 1200;}{x = 1024;y = 786;}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.screenSection

Contents of the first Screen section of the X server configuration file. Type: strings concatenated with "\n"

Default

""

Example

'' Option "RandRRotation" "on"''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.serverFlagsSection

Contents of the ServerFlags section of the X server configuration file. Type: strings concatenated with "\n"

Default

""

Example

'' Option "BlankTime" "0" Option "StandbyTime" "0" Option "SuspendTime" "0" Option "OffTime" "0"''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.serverLayoutSection

Contents of the ServerLayout section of the X server configuration file. Type: strings concatenated with "\n"

Default

""

Example

'' Option "AIGLX" "true"''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.terminateOnReset

Whether to terminate X upon server reset.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.tty

Virtual console for the X server. Type: null or signed integer

Default

7

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.updateDbusEnvironment

Whether to update the DBus activation environment after launching the desktop manager.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.upscaleDefaultCursor

Upscale the default X cursor to be more visible on high-density displays. Requires config.services.xserver.dpi to be set.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.verbose

Controls verbosity of X logging.

Type: null or signed integer

Default

3

Example

7

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.videoDriver

The name of the video driver for your graphics card. This option is obsolete; please set the {option}services.xserver.videoDrivers instead.

Type: null or string

Default

null

Example

"i810"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.videoDrivers

The names of the video drivers the configuration supports. They will be tried in order until one that supports your card is found. Don't combine those with "incompatible" OpenGL implementations, e.g. free ones (mesa-based) with proprietary ones.

For unfree "nvidia*", the supported GPU lists are on https://www.nvidia.com/object/unix.html

Type: list of string

Default

["modesetting""fbdev"]

Example

["nvidia""amdgpu"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.virtualScreen

Virtual screen size for Xrandr.

Type: null or (attribute set)

Default

null

Example

{x = 2048;y = 2048;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xkb.dir

Path used for -xkbdir xserver parameter.

Type: path

Default

"${pkgs.xkeyboard_config}/etc/X11/xkb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xkb.layout

X keyboard layout, or multiple keyboard layouts separated by commas.

Type: string

Default

"us"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xkb.model

X keyboard model.

Type: string

Default

"pc104"

Example

"presario"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xkb.options

X keyboard options; layout switching goes here.

Type: strings concatenated with ","

Default

"terminate:ctrl_alt_bksp"

Example

"grp:caps_toggle,grp_led:scroll"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xkb.variant

X keyboard variant.

Type: string

Default

""

Example

"colemak"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xrandrHeads

Multiple monitor configuration, just specify a list of XRandR outputs. The individual elements should be either simple strings or an attribute set of output options.

If the element is a string, it is denoting the physical output for a monitor, if it's an attribute set, you must at least provide the {option}output option.

The monitors will be mapped from left to right in the order of the list.

By default, the first monitor will be set as the primary monitor if none of the elements contain an option that has set {option}primary to true.

::: {.note} Only one monitor is allowed to be primary. :::

Be careful using this option with multiple graphic adapters or with drivers that have poor support for XRandR, unexpected things might happen with those.

Type: list of ((submodule) or string convertible to it)

Default

[ ]

Example

["HDMI-0"{output = "DVI-0";primary = true;}{monitorConfig = "Option \"Rotate\" \"left\"";output = "DVI-1";}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xrandrHeads.*.monitorConfig

Extra lines to append to the Monitor section verbatim. Available options are documented in the MONITOR section in {manpage}xorg.conf(5).

Type: strings concatenated with "\n"

Default

""

Example

'' DisplaySize 408 306 Option "DPMS" "false"''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xrandrHeads.*.output

The output name of the monitor, as shown by {manpage}xrandr(1) invoked without arguments.

Type: string

Example

"DVI-0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix

services.xserver.xrandrHeads.*.primary

Whether this head is treated as the primary monitor,

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/x11/xserver.nix