diff options
Diffstat (limited to 'nixos/modules/services/x11')
101 files changed, 406 insertions, 422 deletions
diff --git a/nixos/modules/services/x11/clight.nix b/nixos/modules/services/x11/clight.nix index 0f66e191fe281..40a0f3e065d09 100644 --- a/nixos/modules/services/x11/clight.nix +++ b/nixos/modules/services/x11/clight.nix @@ -28,13 +28,13 @@ let cfg.settings)); in { options.services.clight = { - enable = mkEnableOption (lib.mdDoc "clight"); + enable = mkEnableOption "clight"; temperature = { day = mkOption { type = types.int; default = 5500; - description = lib.mdDoc '' + description = '' Colour temperature to use during the day, between `1000` and `25000` K. ''; @@ -42,7 +42,7 @@ in { night = mkOption { type = types.int; default = 3700; - description = lib.mdDoc '' + description = '' Colour temperature to use at night, between `1000` and `25000` K. ''; @@ -56,7 +56,7 @@ in { type = with types; attrsOf (nullOr (either collectionTypes (attrsOf collectionTypes))); default = {}; example = { captures = 20; gamma_long_transition = true; ac_capture_timeouts = [ 120 300 60 ]; }; - description = lib.mdDoc '' + description = '' Additional configuration to extend clight.conf. See <https://github.com/FedeDP/Clight/blob/master/Extra/clight.conf> for a sample configuration file. diff --git a/nixos/modules/services/x11/colord.nix b/nixos/modules/services/x11/colord.nix index cb7b9096e5db6..31ccee6aa33f4 100644 --- a/nixos/modules/services/x11/colord.nix +++ b/nixos/modules/services/x11/colord.nix @@ -11,7 +11,7 @@ in { options = { services.colord = { - enable = mkEnableOption (lib.mdDoc "colord, the color management daemon"); + enable = mkEnableOption "colord, the color management daemon"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/budgie.nix b/nixos/modules/services/x11/desktop-managers/budgie.nix index d6e6bb2fa14e8..75ee82f1f948a 100644 --- a/nixos/modules/services/x11/desktop-managers/budgie.nix +++ b/nixos/modules/services/x11/desktop-managers/budgie.nix @@ -1,7 +1,7 @@ { lib, pkgs, config, utils, ... }: let - inherit (lib) concatMapStrings literalExpression mdDoc mkDefault mkEnableOption mkIf mkOption types; + inherit (lib) concatMapStrings literalExpression mkDefault mkEnableOption mkIf mkOption types; cfg = config.services.xserver.desktopManager.budgie; @@ -50,10 +50,10 @@ in { options = { services.xserver.desktopManager.budgie = { - enable = mkEnableOption (mdDoc "the Budgie desktop"); + enable = mkEnableOption "the Budgie desktop"; sessionPath = mkOption { - description = lib.mdDoc '' + description = '' Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart. @@ -65,19 +65,19 @@ in { }; extraGSettingsOverrides = mkOption { - description = mdDoc "Additional GSettings overrides."; + description = "Additional GSettings overrides."; type = types.lines; default = ""; }; extraGSettingsOverridePackages = mkOption { - description = mdDoc "List of packages for which GSettings are overridden."; + description = "List of packages for which GSettings are overridden."; type = types.listOf types.path; default = []; }; extraPlugins = mkOption { - description = mdDoc "Extra plugins for the Budgie desktop"; + description = "Extra plugins for the Budgie desktop"; type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.budgiePlugins.budgie-analogue-clock-applet ]"; @@ -85,7 +85,7 @@ in { }; environment.budgie.excludePackages = mkOption { - description = mdDoc "Which packages Budgie should exclude from the default environment."; + description = "Which packages Budgie should exclude from the default environment."; type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.mate-terminal ]"; diff --git a/nixos/modules/services/x11/desktop-managers/cde.nix b/nixos/modules/services/x11/desktop-managers/cde.nix index ad4b5d27f9d90..ae9a8ce223924 100644 --- a/nixos/modules/services/x11/desktop-managers/cde.nix +++ b/nixos/modules/services/x11/desktop-managers/cde.nix @@ -7,7 +7,7 @@ let cfg = xcfg.desktopManager.cde; in { options.services.xserver.desktopManager.cde = { - enable = mkEnableOption (lib.mdDoc "Common Desktop Environment"); + enable = mkEnableOption "Common Desktop Environment"; extraPackages = mkOption { type = with types; listOf package; @@ -19,7 +19,7 @@ in { xclock bitmap xlsfonts xfd xrefresh xload xwininfo xdpyinfo xwd xwud ] ''; - description = lib.mdDoc '' + description = '' Extra packages to be installed system wide. ''; }; diff --git a/nixos/modules/services/x11/desktop-managers/cinnamon.nix b/nixos/modules/services/x11/desktop-managers/cinnamon.nix index 6983b51376fd4..8c29b41c8cf80 100644 --- a/nixos/modules/services/x11/desktop-managers/cinnamon.nix +++ b/nixos/modules/services/x11/desktop-managers/cinnamon.nix @@ -18,17 +18,17 @@ in { options = { services.cinnamon = { - apps.enable = mkEnableOption (lib.mdDoc "Cinnamon default applications"); + apps.enable = mkEnableOption "Cinnamon default applications"; }; services.xserver.desktopManager.cinnamon = { - enable = mkEnableOption (lib.mdDoc "the cinnamon desktop manager"); + enable = mkEnableOption "the cinnamon desktop manager"; sessionPath = mkOption { default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.gnome.gpaste ]"; - description = lib.mdDoc '' + description = '' Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart. @@ -39,13 +39,13 @@ in extraGSettingsOverrides = mkOption { default = ""; type = types.lines; - description = lib.mdDoc "Additional gsettings overrides."; + description = "Additional gsettings overrides."; }; extraGSettingsOverridePackages = mkOption { default = []; type = types.listOf types.path; - description = lib.mdDoc "List of packages for which gsettings are overridden."; + description = "List of packages for which gsettings are overridden."; }; }; @@ -53,7 +53,7 @@ in default = []; example = literalExpression "[ pkgs.cinnamon.blueberry ]"; type = types.listOf types.package; - description = lib.mdDoc "Which packages cinnamon should exclude from the default environment"; + description = "Which packages cinnamon should exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/deepin.nix b/nixos/modules/services/x11/desktop-managers/deepin.nix index 61f6fece58708..680ce7b9a93e6 100644 --- a/nixos/modules/services/x11/desktop-managers/deepin.nix +++ b/nixos/modules/services/x11/desktop-managers/deepin.nix @@ -15,23 +15,23 @@ in options = { services.xserver.desktopManager.deepin = { - enable = mkEnableOption (lib.mdDoc "Deepin desktop manager"); + enable = mkEnableOption "Deepin desktop manager"; extraGSettingsOverrides = mkOption { default = ""; type = types.lines; - description = lib.mdDoc "Additional gsettings overrides."; + description = "Additional gsettings overrides."; }; extraGSettingsOverridePackages = mkOption { default = [ ]; type = types.listOf types.path; - description = lib.mdDoc "List of packages for which gsettings are overridden."; + description = "List of packages for which gsettings are overridden."; }; }; environment.deepin.excludePackages = mkOption { default = [ ]; type = types.listOf types.package; - description = lib.mdDoc "List of default packages to exclude from the configuration"; + description = "List of default packages to exclude from the configuration"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/default.nix b/nixos/modules/services/x11/desktop-managers/default.nix index 896d8dcbff40f..621a44ad123cc 100644 --- a/nixos/modules/services/x11/desktop-managers/default.nix +++ b/nixos/modules/services/x11/desktop-managers/default.nix @@ -33,7 +33,7 @@ in type = types.enum [ "center" "fill" "max" "scale" "tile" ]; default = "scale"; example = "fill"; - description = lib.mdDoc '' + description = '' The file {file}`~/.background-image` is used as a background image. This option specifies the placement of this image onto your desktop. @@ -49,7 +49,7 @@ in combineScreens = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' When set to `true` the wallpaper will stretch across all screens. When set to `false` the wallpaper is duplicated to all screens. ''; @@ -64,7 +64,7 @@ in bgSupport = true; start = "..."; }; - description = lib.mdDoc '' + description = '' Internal option used to add some common line to desktop manager scripts before forwarding the value to the `displayManager`. @@ -86,7 +86,7 @@ in type = types.nullOr types.str; default = null; example = "none"; - description = lib.mdDoc '' + description = '' **Deprecated**, please use [](#opt-services.displayManager.defaultSession) instead. Default desktop manager loaded if none have been chosen. diff --git a/nixos/modules/services/x11/desktop-managers/enlightenment.nix b/nixos/modules/services/x11/desktop-managers/enlightenment.nix index d241c63436faa..09f90e1cd4df8 100644 --- a/nixos/modules/services/x11/desktop-managers/enlightenment.nix +++ b/nixos/modules/services/x11/desktop-managers/enlightenment.nix @@ -29,7 +29,7 @@ in services.xserver.desktopManager.enlightenment.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the Enlightenment desktop environment."; + description = "Enable the Enlightenment desktop environment."; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/gnome.nix b/nixos/modules/services/x11/desktop-managers/gnome.nix index cc959bcf7bd58..95c79cf96108c 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome.nix +++ b/nixos/modules/services/x11/desktop-managers/gnome.nix @@ -137,25 +137,25 @@ in options = { services.gnome = { - core-os-services.enable = mkEnableOption (lib.mdDoc "essential services for GNOME3"); - core-shell.enable = mkEnableOption (lib.mdDoc "GNOME Shell services"); - core-utilities.enable = mkEnableOption (lib.mdDoc "GNOME core utilities"); - core-developer-tools.enable = mkEnableOption (lib.mdDoc "GNOME core developer tools"); - games.enable = mkEnableOption (lib.mdDoc "GNOME games"); + core-os-services.enable = mkEnableOption "essential services for GNOME3"; + core-shell.enable = mkEnableOption "GNOME Shell services"; + core-utilities.enable = mkEnableOption "GNOME core utilities"; + core-developer-tools.enable = mkEnableOption "GNOME core developer tools"; + games.enable = mkEnableOption "GNOME games"; }; services.xserver.desktopManager.gnome = { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable GNOME desktop manager."; + description = "Enable GNOME desktop manager."; }; sessionPath = mkOption { default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.gnome.gpaste ]"; - description = lib.mdDoc '' + description = '' Additional list of packages to be added to the session search path. Useful for GNOME Shell extensions or GSettings-conditional autostart. @@ -173,44 +173,44 @@ in favorite-apps=[ 'firefox.desktop', 'org.gnome.Calendar.desktop' ] ''' ''; - description = lib.mdDoc "List of desktop files to put as favorite apps into gnome-shell. These need to be installed somehow globally."; + description = "List of desktop files to put as favorite apps into gnome-shell. These need to be installed somehow globally."; }; extraGSettingsOverrides = mkOption { default = ""; type = types.lines; - description = lib.mdDoc "Additional gsettings overrides."; + description = "Additional gsettings overrides."; }; extraGSettingsOverridePackages = mkOption { default = []; type = types.listOf types.path; - description = lib.mdDoc "List of packages for which gsettings are overridden."; + description = "List of packages for which gsettings are overridden."; }; - debug = mkEnableOption (lib.mdDoc "gnome-session debug messages"); + debug = mkEnableOption "gnome-session debug messages"; flashback = { - enableMetacity = mkEnableOption (lib.mdDoc "the standard GNOME Flashback session with Metacity"); + enableMetacity = mkEnableOption "the standard GNOME Flashback session with Metacity"; customSessions = mkOption { type = types.listOf (types.submodule { options = { wmName = mkOption { type = types.strMatching "[a-zA-Z0-9_-]+"; - description = lib.mdDoc "A unique identifier for the window manager."; + description = "A unique identifier for the window manager."; example = "xmonad"; }; wmLabel = mkOption { type = types.str; - description = lib.mdDoc "The name of the window manager to show in the session chooser."; + description = "The name of the window manager to show in the session chooser."; example = "XMonad"; }; wmCommand = mkOption { type = types.str; - description = lib.mdDoc "The executable of the window manager to use."; + description = "The executable of the window manager to use."; example = literalExpression ''"''${pkgs.haskellPackages.xmonad}/bin/xmonad"''; }; @@ -218,19 +218,19 @@ in type = types.bool; default = true; example = false; - description = lib.mdDoc "Whether to enable the GNOME panel in this session."; + description = "Whether to enable the GNOME panel in this session."; }; }; }); default = []; - description = lib.mdDoc "Other GNOME Flashback sessions to enable."; + description = "Other GNOME Flashback sessions to enable."; }; panelModulePackages = mkOption { default = [ pkgs.gnome.gnome-applets ]; defaultText = literalExpression "[ pkgs.gnome.gnome-applets ]"; type = types.listOf types.package; - description = lib.mdDoc '' + description = '' 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`. @@ -243,7 +243,7 @@ in default = []; example = literalExpression "[ pkgs.gnome.totem ]"; type = types.listOf types.package; - description = lib.mdDoc "Which packages gnome should exclude from the default environment"; + description = "Which packages gnome should exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/kodi.nix b/nixos/modules/services/x11/desktop-managers/kodi.nix index 452f571d49e67..b7c0af210b143 100644 --- a/nixos/modules/services/x11/desktop-managers/kodi.nix +++ b/nixos/modules/services/x11/desktop-managers/kodi.nix @@ -12,7 +12,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the kodi multimedia center."; + description = "Enable the kodi multimedia center."; }; package = mkPackageOption pkgs "kodi" { diff --git a/nixos/modules/services/x11/desktop-managers/lumina.nix b/nixos/modules/services/x11/desktop-managers/lumina.nix index 9df9fe42a1ff6..72411e8fcb5eb 100644 --- a/nixos/modules/services/x11/desktop-managers/lumina.nix +++ b/nixos/modules/services/x11/desktop-managers/lumina.nix @@ -19,7 +19,7 @@ in services.xserver.desktopManager.lumina.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the Lumina desktop manager"; + description = "Enable the Lumina desktop manager"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/lxqt.nix b/nixos/modules/services/x11/desktop-managers/lxqt.nix index 3d02deba6fc79..3fce3283e71ff 100644 --- a/nixos/modules/services/x11/desktop-managers/lxqt.nix +++ b/nixos/modules/services/x11/desktop-managers/lxqt.nix @@ -18,14 +18,14 @@ in services.xserver.desktopManager.lxqt.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the LXQt desktop manager"; + description = "Enable the LXQt desktop manager"; }; environment.lxqt.excludePackages = mkOption { default = []; example = literalExpression "[ pkgs.lxqt.qterminal ]"; type = types.listOf types.package; - description = lib.mdDoc "Which LXQt packages to exclude from the default environment"; + description = "Which LXQt packages to exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/mate.nix b/nixos/modules/services/x11/desktop-managers/mate.nix index e475442b9ef47..520d40d67908c 100644 --- a/nixos/modules/services/x11/desktop-managers/mate.nix +++ b/nixos/modules/services/x11/desktop-managers/mate.nix @@ -16,33 +16,33 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the MATE desktop environment"; + description = "Enable the MATE desktop environment"; }; - debug = mkEnableOption (lib.mdDoc "mate-session debug messages"); + debug = mkEnableOption "mate-session debug messages"; extraPanelApplets = mkOption { default = [ ]; example = literalExpression "with pkgs.mate; [ mate-applets ]"; type = types.listOf types.package; - description = lib.mdDoc "Extra applets to add to mate-panel."; + description = "Extra applets to add to mate-panel."; }; extraCajaExtensions = mkOption { default = [ ]; example = lib.literalExpression "with pkgs.mate; [ caja-extensions ]"; type = types.listOf types.package; - description = lib.mdDoc "Extra extensions to add to caja."; + description = "Extra extensions to add to caja."; }; - enableWaylandSession = mkEnableOption (lib.mdDoc "MATE Wayland session"); + enableWaylandSession = mkEnableOption "MATE Wayland session"; }; environment.mate.excludePackages = mkOption { default = []; example = literalExpression "[ pkgs.mate.mate-terminal pkgs.mate.pluma ]"; type = types.listOf types.package; - description = lib.mdDoc "Which MATE packages to exclude from the default environment"; + description = "Which MATE packages to exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/none.nix b/nixos/modules/services/x11/desktop-managers/none.nix index 074b729cc3f35..f5b5e3104101e 100644 --- a/nixos/modules/services/x11/desktop-managers/none.nix +++ b/nixos/modules/services/x11/desktop-managers/none.nix @@ -8,7 +8,7 @@ in services.xserver.desktopManager.runXdgAutostartIfNone = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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. diff --git a/nixos/modules/services/x11/desktop-managers/pantheon.nix b/nixos/modules/services/x11/desktop-managers/pantheon.nix index 2115f8f0ab235..57ccbaccb0c68 100644 --- a/nixos/modules/services/x11/desktop-managers/pantheon.nix +++ b/nixos/modules/services/x11/desktop-managers/pantheon.nix @@ -27,10 +27,10 @@ in services.pantheon = { contractor = { - enable = mkEnableOption (lib.mdDoc "contractor, a desktop-wide extension service used by Pantheon"); + enable = mkEnableOption "contractor, a desktop-wide extension service used by Pantheon"; }; - apps.enable = mkEnableOption (lib.mdDoc "Pantheon default applications"); + apps.enable = mkEnableOption "Pantheon default applications"; }; @@ -38,14 +38,14 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the pantheon desktop manager"; + description = "Enable the pantheon desktop manager"; }; sessionPath = mkOption { default = []; type = types.listOf types.package; example = literalExpression "[ pkgs.gnome.gpaste ]"; - description = lib.mdDoc '' + description = '' Additional list of packages to be added to the session search path. Useful for GSettings-conditional autostart. @@ -56,28 +56,28 @@ in extraWingpanelIndicators = mkOption { default = null; type = with types; nullOr (listOf package); - description = lib.mdDoc "Indicators to add to Wingpanel."; + description = "Indicators to add to Wingpanel."; }; extraSwitchboardPlugs = mkOption { default = null; type = with types; nullOr (listOf package); - description = lib.mdDoc "Plugs to add to Switchboard."; + description = "Plugs to add to Switchboard."; }; extraGSettingsOverrides = mkOption { default = ""; type = types.lines; - description = lib.mdDoc "Additional gsettings overrides."; + description = "Additional gsettings overrides."; }; extraGSettingsOverridePackages = mkOption { default = []; type = types.listOf types.path; - description = lib.mdDoc "List of packages for which gsettings are overridden."; + description = "List of packages for which gsettings are overridden."; }; - debug = mkEnableOption (lib.mdDoc "gnome-session debug messages"); + debug = mkEnableOption "gnome-session debug messages"; }; @@ -85,7 +85,7 @@ in default = []; example = literalExpression "[ pkgs.pantheon.elementary-camera ]"; type = types.listOf types.package; - description = lib.mdDoc "Which packages pantheon should exclude from the default environment"; + description = "Which packages pantheon should exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/phosh.nix b/nixos/modules/services/x11/desktop-managers/phosh.nix index 41107788db0a5..e8494b2c017c9 100644 --- a/nixos/modules/services/x11/desktop-managers/phosh.nix +++ b/nixos/modules/services/x11/desktop-managers/phosh.nix @@ -24,7 +24,7 @@ let phocConfigType = types.submodule { options = { xwayland = mkOption { - description = lib.mdDoc '' + description = '' Whether to enable XWayland support. To start XWayland immediately, use `immediate`. @@ -33,14 +33,14 @@ let default = "false"; }; cursorTheme = mkOption { - description = lib.mdDoc '' + description = '' Cursor theme to use in Phosh. ''; type = types.str; default = "default"; }; outputs = mkOption { - description = lib.mdDoc '' + description = '' Output configurations. ''; type = types.attrsOf phocOutputType; @@ -56,7 +56,7 @@ let phocOutputType = types.submodule { options = { modeline = mkOption { - description = lib.mdDoc '' + description = '' One or more modelines. ''; type = types.either types.str (types.listOf types.str); @@ -67,7 +67,7 @@ let ]; }; mode = mkOption { - description = lib.mdDoc '' + description = '' Default video mode. ''; type = types.nullOr types.str; @@ -75,7 +75,7 @@ let example = "768x1024"; }; scale = mkOption { - description = lib.mdDoc '' + description = '' Display scaling factor. ''; type = types.nullOr ( @@ -89,7 +89,7 @@ let example = 2; }; rotate = mkOption { - description = lib.mdDoc '' + description = '' Screen transformation. ''; type = types.enum [ @@ -132,25 +132,25 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the Phone Shell."; + description = "Enable the Phone Shell."; }; package = mkPackageOption pkgs "phosh" { }; user = mkOption { - description = lib.mdDoc "The user to run the Phosh service."; + description = "The user to run the Phosh service."; type = types.str; example = "alice"; }; group = mkOption { - description = lib.mdDoc "The group to run the Phosh service."; + description = "The group to run the Phosh service."; type = types.str; example = "users"; }; phocConfig = mkOption { - description = lib.mdDoc '' + description = '' Configurations for the Phoc compositor. ''; type = types.oneOf [ types.lines types.path phocConfigType ]; diff --git a/nixos/modules/services/x11/desktop-managers/plasma5.nix b/nixos/modules/services/x11/desktop-managers/plasma5.nix index bb6e5873deff9..56fcd70dc9516 100644 --- a/nixos/modules/services/x11/desktop-managers/plasma5.nix +++ b/nixos/modules/services/x11/desktop-managers/plasma5.nix @@ -84,24 +84,24 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the Plasma 5 (KDE 5) desktop environment."; + description = "Enable the Plasma 5 (KDE 5) desktop environment."; }; phononBackend = mkOption { type = types.enum [ "gstreamer" "vlc" ]; default = "vlc"; example = "gstreamer"; - description = lib.mdDoc "Phonon audio backend to install."; + description = "Phonon audio backend to install."; }; useQtScaling = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable HiDPI scaling in Qt."; + description = "Enable HiDPI scaling in Qt."; }; runUsingSystemd = mkOption { - description = lib.mdDoc "Use systemd to manage the Plasma session"; + description = "Use systemd to manage the Plasma session"; type = types.bool; default = true; }; @@ -128,7 +128,7 @@ in mobile.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable support for running the Plasma Mobile shell. ''; }; @@ -136,7 +136,7 @@ in mobile.installRecommendedSoftware = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Installs software recommended for use with Plasma Mobile, but which is not strictly required for Plasma Mobile to run. ''; @@ -145,13 +145,13 @@ in bigscreen.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable support for running the Plasma Bigscreen session. ''; }; }; environment.plasma5.excludePackages = mkOption { - description = lib.mdDoc "List of default packages to exclude from the configuration"; + description = "List of default packages to exclude from the configuration"; type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.plasma5Packages.oxygen ]"; diff --git a/nixos/modules/services/x11/desktop-managers/retroarch.nix b/nixos/modules/services/x11/desktop-managers/retroarch.nix index 9db637191b542..3ee7b7795f6c9 100644 --- a/nixos/modules/services/x11/desktop-managers/retroarch.nix +++ b/nixos/modules/services/x11/desktop-managers/retroarch.nix @@ -6,7 +6,7 @@ let cfg = config.services.xserver.desktopManager.retroarch; in { options.services.xserver.desktopManager.retroarch = { - enable = mkEnableOption (lib.mdDoc "RetroArch"); + enable = mkEnableOption "RetroArch"; package = mkPackageOption pkgs "retroarch" { example = "retroarch-full"; @@ -16,7 +16,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "--verbose" "--host" ]; - description = lib.mdDoc "Extra arguments to pass to RetroArch."; + description = "Extra arguments to pass to RetroArch."; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/surf-display.nix b/nixos/modules/services/x11/desktop-managers/surf-display.nix index e5f2c76f4ac25..10c4a1d21b0a5 100644 --- a/nixos/modules/services/x11/desktop-managers/surf-display.nix +++ b/nixos/modules/services/x11/desktop-managers/surf-display.nix @@ -45,21 +45,21 @@ let in { options = { services.xserver.desktopManager.surf-display = { - enable = mkEnableOption (lib.mdDoc "surf-display as a kiosk browser session"); + enable = mkEnableOption "surf-display as a kiosk browser session"; defaultWwwUri = mkOption { type = types.str; default = "${pkgs.surf-display}/share/surf-display/empty-page.html"; defaultText = literalExpression ''"''${pkgs.surf-display}/share/surf-display/empty-page.html"''; example = "https://www.example.com/"; - description = lib.mdDoc "Default URI to display."; + description = "Default URI to display."; }; inactivityInterval = mkOption { type = types.int; default = 300; example = 0; - description = lib.mdDoc '' + description = '' 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. @@ -72,7 +72,7 @@ in { screensaverSettings = mkOption { type = types.separatedString " "; default = ""; - description = lib.mdDoc '' + description = '' Screensaver settings, see `man 1 xset` for possible options. ''; }; @@ -80,7 +80,7 @@ in { pointerButtonMap = mkOption { type = types.str; 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"; - description = lib.mdDoc '' + description = '' Disable right and middle pointer device click in browser sessions while keeping scrolling wheels' functionality intact. See pointer subcommand on `man xmodmap` for details. @@ -91,7 +91,7 @@ in { type = types.str; default = "yes"; example = "no"; - description = lib.mdDoc "Hide idle mouse pointer."; + description = "Hide idle mouse pointer."; }; extraConfig = mkOption { @@ -111,7 +111,7 @@ in { 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" ''; - description = lib.mdDoc '' + description = '' Extra configuration options to append to `/etc/default/surf-display`. ''; }; diff --git a/nixos/modules/services/x11/desktop-managers/xfce.nix b/nixos/modules/services/x11/desktop-managers/xfce.nix index 3ba27b2015075..a764e84d6068d 100644 --- a/nixos/modules/services/x11/desktop-managers/xfce.nix +++ b/nixos/modules/services/x11/desktop-managers/xfce.nix @@ -49,25 +49,25 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable the Xfce desktop environment."; + description = "Enable the Xfce desktop environment."; }; noDesktop = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Don't install XFCE desktop components (xfdesktop and panel)."; + description = "Don't install XFCE desktop components (xfdesktop and panel)."; }; enableXfwm = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Enable the XFWM (default) window manager."; + description = "Enable the XFWM (default) window manager."; }; enableScreensaver = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Enable the XFCE screensaver."; + description = "Enable the XFCE screensaver."; }; }; @@ -75,7 +75,7 @@ in default = []; example = literalExpression "[ pkgs.xfce.xfce4-volumed-pulse ]"; type = types.listOf types.package; - description = lib.mdDoc "Which packages XFCE should exclude from the default environment"; + description = "Which packages XFCE should exclude from the default environment"; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/xterm.nix b/nixos/modules/services/x11/desktop-managers/xterm.nix index 2b439effabe52..3424ee1b0e113 100644 --- a/nixos/modules/services/x11/desktop-managers/xterm.nix +++ b/nixos/modules/services/x11/desktop-managers/xterm.nix @@ -16,7 +16,7 @@ in type = types.bool; default = versionOlder config.system.stateVersion "19.09" && xSessionEnabled; defaultText = literalExpression ''versionOlder config.system.stateVersion "19.09" && config.services.xserver.enable;''; - description = lib.mdDoc "Enable a xterm terminal as a desktop manager."; + description = "Enable a xterm terminal as a desktop manager."; }; }; diff --git a/nixos/modules/services/x11/display-managers/default.nix b/nixos/modules/services/x11/display-managers/default.nix index 129bafefabe99..4c62e964c34c4 100644 --- a/nixos/modules/services/x11/display-managers/default.nix +++ b/nixos/modules/services/x11/display-managers/default.nix @@ -140,25 +140,25 @@ in internal = true; default = "${xorg.xauth}/bin/xauth"; defaultText = literalExpression ''"''${pkgs.xorg.xauth}/bin/xauth"''; - description = lib.mdDoc "Path to the {command}`xauth` program used by display managers."; + description = "Path to the {command}`xauth` program used by display managers."; }; xserverBin = mkOption { type = types.path; - description = lib.mdDoc "Path to the X server used by display managers."; + description = "Path to the X server used by display managers."; }; xserverArgs = mkOption { type = types.listOf types.str; default = []; example = [ "-ac" "-logverbose" "-verbose" "-nolisten tcp" ]; - description = lib.mdDoc "List of arguments for the X server."; + description = "List of arguments for the X server."; }; setupCommands = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Shell commands executed just after the X server has started. This option is only effective for display managers for which this feature @@ -173,7 +173,7 @@ in '' xmessage "Hello World!" & ''; - description = lib.mdDoc '' + description = '' Shell commands executed just before the window or desktop manager is started. These commands are not currently sourced for Wayland sessions. ''; @@ -193,7 +193,7 @@ in } ] ''; - description = lib.mdDoc '' + description = '' 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 @@ -212,7 +212,7 @@ in importedVariables = mkOption { type = types.listOf (types.strMatching "[a-zA-Z_][a-zA-Z0-9_]*"); visible = false; - description = lib.mdDoc '' + description = '' Environment variables to import into the systemd user environment. ''; }; diff --git a/nixos/modules/services/x11/display-managers/gdm.nix b/nixos/modules/services/x11/display-managers/gdm.nix index 6bdfe9ea6f8cd..107a2f1647925 100644 --- a/nixos/modules/services/x11/display-managers/gdm.nix +++ b/nixos/modules/services/x11/display-managers/gdm.nix @@ -65,15 +65,15 @@ in services.xserver.displayManager.gdm = { - enable = mkEnableOption (lib.mdDoc "GDM, the GNOME Display Manager"); + enable = mkEnableOption "GDM, the GNOME Display Manager"; - debug = mkEnableOption (lib.mdDoc "debugging messages in GDM"); + debug = mkEnableOption "debugging messages in GDM"; # Auto login options specific to GDM autoLogin.delay = mkOption { type = types.int; default = 0; - description = lib.mdDoc '' + description = '' Seconds of inactivity after which the autologin will be performed. ''; }; @@ -81,14 +81,14 @@ in wayland = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Allow GDM to run on Wayland instead of Xserver. ''; }; autoSuspend = mkOption { default = true; - description = lib.mdDoc '' + description = '' On the GNOME Display Manager login screen, suspend the machine after inactivity. (Does not affect automatic suspend while logged in, or at lock screen.) ''; @@ -103,7 +103,7 @@ in bar baz ''; - description = lib.mdDoc '' + description = '' Optional message to display on the login screen. ''; }; @@ -114,7 +114,7 @@ in example = { debug.enable = true; }; - description = lib.mdDoc '' + description = '' Options passed to the gdm daemon. See [here](https://help.gnome.org/admin/gdm/stable/configuration.html.en#daemonconfig) for supported options. ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix index 412bcc4091b3f..930ee96b384d5 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix @@ -26,7 +26,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable enso-os-greeter as the lightdm greeter ''; }; @@ -36,7 +36,7 @@ in { type = types.package; default = pkgs.gnome.gnome-themes-extra; defaultText = literalExpression "pkgs.gnome.gnome-themes-extra"; - description = lib.mdDoc '' + description = '' The package path that contains the theme given in the name option. ''; }; @@ -44,7 +44,7 @@ in { name = mkOption { type = types.str; default = "Adwaita"; - description = lib.mdDoc '' + description = '' Name of the theme to use for the lightdm-enso-os-greeter ''; }; @@ -55,7 +55,7 @@ in { type = types.package; default = pkgs.papirus-icon-theme; defaultText = literalExpression "pkgs.papirus-icon-theme"; - description = lib.mdDoc '' + description = '' The package path that contains the icon theme given in the name option. ''; }; @@ -63,7 +63,7 @@ in { name = mkOption { type = types.str; default = "ePapirus"; - description = lib.mdDoc '' + description = '' Name of the icon theme to use for the lightdm-enso-os-greeter ''; }; @@ -74,7 +74,7 @@ in { type = types.package; default = pkgs.capitaine-cursors; defaultText = literalExpression "pkgs.capitaine-cursors"; - description = lib.mdDoc '' + description = '' The package path that contains the cursor theme given in the name option. ''; }; @@ -82,7 +82,7 @@ in { name = mkOption { type = types.str; default = "capitane-cursors"; - description = lib.mdDoc '' + description = '' Name of the cursor theme to use for the lightdm-enso-os-greeter ''; }; @@ -91,7 +91,7 @@ in { blur = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether or not to enable blur ''; }; @@ -99,7 +99,7 @@ in { brightness = mkOption { type = types.int; default = 7; - description = lib.mdDoc '' + description = '' Brightness ''; }; @@ -107,7 +107,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra configuration that should be put in the greeter.conf configuration file ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix index c050367e74df6..30940da103a96 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix @@ -38,7 +38,7 @@ in enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable lightdm-gtk-greeter as the lightdm greeter. ''; }; @@ -49,7 +49,7 @@ in type = types.package; default = pkgs.gnome.gnome-themes-extra; defaultText = literalExpression "pkgs.gnome.gnome-themes-extra"; - description = lib.mdDoc '' + description = '' The package path that contains the theme given in the name option. ''; }; @@ -57,7 +57,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = lib.mdDoc '' + description = '' Name of the theme to use for the lightdm-gtk-greeter. ''; }; @@ -70,7 +70,7 @@ in type = types.package; default = pkgs.gnome.adwaita-icon-theme; defaultText = literalExpression "pkgs.gnome.adwaita-icon-theme"; - description = lib.mdDoc '' + description = '' The package path that contains the icon theme given in the name option. ''; }; @@ -78,7 +78,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = lib.mdDoc '' + description = '' Name of the icon theme to use for the lightdm-gtk-greeter. ''; }; @@ -91,7 +91,7 @@ in type = types.package; default = pkgs.gnome.adwaita-icon-theme; defaultText = literalExpression "pkgs.gnome.adwaita-icon-theme"; - description = lib.mdDoc '' + description = '' The package path that contains the cursor theme given in the name option. ''; }; @@ -99,7 +99,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = lib.mdDoc '' + description = '' Name of the cursor theme to use for the lightdm-gtk-greeter. ''; }; @@ -107,7 +107,7 @@ in size = mkOption { type = types.int; default = 16; - description = lib.mdDoc '' + description = '' Size of the cursor theme to use for the lightdm-gtk-greeter. ''; }; @@ -117,7 +117,7 @@ in type = types.nullOr types.str; default = null; example = "%F"; - description = lib.mdDoc '' + description = '' Clock format string (as expected by strftime, e.g. "%H:%M") to use with the lightdm gtk greeter panel. @@ -129,7 +129,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "~host" "~spacer" "~clock" "~spacer" "~session" "~language" "~a11y" "~power" ]; - description = lib.mdDoc '' + description = '' List of allowed indicator modules to use for the lightdm gtk greeter panel. @@ -145,7 +145,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra configuration that should be put in the lightdm-gtk-greeter.conf configuration file. ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix index 8702d0b97ed2e..05e21c7211fa2 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix @@ -55,7 +55,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable lightdm-mini-greeter as the lightdm greeter. Note that this greeter starts only the default X session. @@ -67,7 +67,7 @@ in user = mkOption { type = types.str; default = "root"; - description = lib.mdDoc '' + description = '' The user to login as. ''; }; @@ -75,7 +75,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra configuration that should be put in the lightdm-mini-greeter.conf configuration file. ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/mobile.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/mobile.nix index 31cc9b3deaa17..e67d8e1dcb894 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/mobile.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/mobile.nix @@ -9,9 +9,8 @@ in { options = { services.xserver.displayManager.lightdm.greeters.mobile = { - enable = mkEnableOption (lib.mdDoc - "lightdm-mobile-greeter as the lightdm greeter" - ); + enable = mkEnableOption + "lightdm-mobile-greeter as the lightdm greeter"; }; }; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix index 10707e001e82d..f18e4a914e579 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix @@ -21,7 +21,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable elementary-greeter as the lightdm greeter. ''; }; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix index ee9b4016c8ef2..299d3bae5f06f 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/slick.nix @@ -28,14 +28,14 @@ in { options = { services.xserver.displayManager.lightdm.greeters.slick = { - enable = mkEnableOption (lib.mdDoc "lightdm-slick-greeter as the lightdm greeter"); + enable = mkEnableOption "lightdm-slick-greeter as the lightdm greeter"; theme = { package = mkOption { type = types.package; default = pkgs.gnome.gnome-themes-extra; defaultText = literalExpression "pkgs.gnome.gnome-themes-extra"; - description = lib.mdDoc '' + description = '' The package path that contains the theme given in the name option. ''; }; @@ -43,7 +43,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = lib.mdDoc '' + description = '' Name of the theme to use for the lightdm-slick-greeter. ''; }; @@ -54,7 +54,7 @@ in type = types.package; default = pkgs.gnome.adwaita-icon-theme; defaultText = literalExpression "pkgs.gnome.adwaita-icon-theme"; - description = lib.mdDoc '' + description = '' The package path that contains the icon theme given in the name option. ''; }; @@ -62,7 +62,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = lib.mdDoc '' + description = '' Name of the icon theme to use for the lightdm-slick-greeter. ''; }; @@ -73,7 +73,7 @@ in type = types.package; default = pkgs.ubuntu_font_family; defaultText = literalExpression "pkgs.ubuntu_font_family"; - description = lib.mdDoc '' + description = '' The package path that contains the font given in the name option. ''; }; @@ -81,7 +81,7 @@ in name = mkOption { type = types.str; default = "Ubuntu 11"; - description = lib.mdDoc '' + description = '' Name of the font to use. ''; }; @@ -92,7 +92,7 @@ in type = types.package; default = pkgs.gnome.adwaita-icon-theme; defaultText = literalExpression "pkgs.gnome.adwaita-icon-theme"; - description = lib.mdDoc '' + description = '' The package path that contains the cursor theme given in the name option. ''; }; @@ -100,7 +100,7 @@ in name = mkOption { type = types.str; default = "Adwaita"; - description = lib.mdDoc '' + description = '' Name of the cursor theme to use for the lightdm-slick-greeter. ''; }; @@ -108,18 +108,18 @@ in size = mkOption { type = types.int; default = 24; - description = lib.mdDoc '' + description = '' Size of the cursor theme to use for the lightdm-slick-greeter. ''; }; }; - draw-user-backgrounds = mkEnableOption (lib.mdDoc "draw user backgrounds"); + draw-user-backgrounds = mkEnableOption "draw user backgrounds"; extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra configuration that should be put in the lightdm-slick-greeter.conf configuration file. ''; diff --git a/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix b/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix index b2ea8e6d94f21..835cf049e4ee5 100644 --- a/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix +++ b/nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix @@ -17,7 +17,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable lightdm-tiny-greeter as the lightdm greeter. Note that this greeter starts only the default X session. @@ -30,7 +30,7 @@ in user = mkOption { type = types.str; default = "Username"; - description = lib.mdDoc '' + description = '' The string to represent the user_text label. ''; }; @@ -38,7 +38,7 @@ in pass = mkOption { type = types.str; default = "Password"; - description = lib.mdDoc '' + description = '' The string to represent the pass_text label. ''; }; @@ -48,7 +48,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Section to describe style and ui. ''; }; diff --git a/nixos/modules/services/x11/display-managers/lightdm.nix b/nixos/modules/services/x11/display-managers/lightdm.nix index cb6365bace352..63561934be082 100644 --- a/nixos/modules/services/x11/display-managers/lightdm.nix +++ b/nixos/modules/services/x11/display-managers/lightdm.nix @@ -105,7 +105,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable lightdm as the display manager. ''; }; @@ -114,14 +114,14 @@ in enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' If set to false, run lightdm in greeterless mode. This only works if autologin is enabled and autoLogin.timeout is zero. ''; }; package = mkOption { type = types.package; - description = lib.mdDoc '' + description = '' The LightDM greeter to login via. The package should be a directory containing a .desktop file matching the name in the 'name' option. ''; @@ -129,7 +129,7 @@ in }; name = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The name of a .desktop file in the directory specified in the 'package' option. ''; @@ -142,14 +142,14 @@ in example = '' user-authority-in-system-dir = true ''; - description = lib.mdDoc "Extra lines to append to LightDM section."; + description = "Extra lines to append to LightDM section."; }; background = mkOption { type = types.either types.path (types.strMatching "^#[0-9]\{6\}$"); # Manual cannot depend on packages, we are actually setting the default in config below. defaultText = literalExpression "pkgs.nixos-artwork.wallpapers.simple-dark-gray-bottom.gnomeFilePath"; - description = lib.mdDoc '' + description = '' The background image or color to use. ''; }; @@ -160,14 +160,14 @@ in example = '' greeter-show-manual-login=true ''; - description = lib.mdDoc "Extra lines to append to SeatDefaults section."; + description = "Extra lines to append to SeatDefaults section."; }; # Configuration for automatic login specific to LightDM autoLogin.timeout = mkOption { type = types.int; default = 0; - description = lib.mdDoc '' + description = '' Show the greeter for this many seconds before automatic login occurs. ''; }; diff --git a/nixos/modules/services/x11/display-managers/startx.nix b/nixos/modules/services/x11/display-managers/startx.nix index f4bb7a89d03b6..a48566ae06841 100644 --- a/nixos/modules/services/x11/display-managers/startx.nix +++ b/nixos/modules/services/x11/display-managers/startx.nix @@ -17,7 +17,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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. diff --git a/nixos/modules/services/x11/display-managers/sx.nix b/nixos/modules/services/x11/display-managers/sx.nix index 6a7fc1a040e7a..e309773643009 100644 --- a/nixos/modules/services/x11/display-managers/sx.nix +++ b/nixos/modules/services/x11/display-managers/sx.nix @@ -7,8 +7,8 @@ let cfg = config.services.xserver.displayManager.sx; in { options = { services.xserver.displayManager.sx = { - enable = mkEnableOption (lib.mdDoc "sx pseudo-display manager") // { - description = lib.mdDoc '' + enable = mkEnableOption "sx pseudo-display manager" // { + description = '' 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 diff --git a/nixos/modules/services/x11/display-managers/xpra.nix b/nixos/modules/services/x11/display-managers/xpra.nix index ce80e013e81e2..b2ed100fc5abe 100644 --- a/nixos/modules/services/x11/display-managers/xpra.nix +++ b/nixos/modules/services/x11/display-managers/xpra.nix @@ -16,34 +16,34 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whether to enable xpra as display manager."; + description = "Whether to enable xpra as display manager."; }; bindTcp = mkOption { default = "127.0.0.1:10000"; example = "0.0.0.0:10000"; type = types.nullOr types.str; - description = lib.mdDoc "Bind xpra to TCP"; + description = "Bind xpra to TCP"; }; desktop = mkOption { type = types.nullOr types.str; default = null; example = "gnome-shell"; - description = lib.mdDoc "Start a desktop environment instead of seamless mode"; + description = "Start a desktop environment instead of seamless mode"; }; auth = mkOption { type = types.str; default = "pam"; example = "password:value=mysecret"; - description = lib.mdDoc "Authentication to use when connecting to xpra"; + description = "Authentication to use when connecting to xpra"; }; - pulseaudio = mkEnableOption (lib.mdDoc "pulseaudio audio streaming"); + pulseaudio = mkEnableOption "pulseaudio audio streaming"; extraOptions = mkOption { - description = lib.mdDoc "Extra xpra options"; + description = "Extra xpra options"; default = []; type = types.listOf types.str; }; diff --git a/nixos/modules/services/x11/extra-layouts.nix b/nixos/modules/services/x11/extra-layouts.nix index ab7e39739eeb3..758abc5750cb0 100644 --- a/nixos/modules/services/x11/extra-layouts.nix +++ b/nixos/modules/services/x11/extra-layouts.nix @@ -9,13 +9,12 @@ let options = { description = mkOption { type = types.str; - description = lib.mdDoc "A short description of the layout."; + description = "A short description of the layout."; }; languages = mkOption { type = types.listOf types.str; - description = - lib.mdDoc '' + description = '' A list of languages provided by the layout. (Use ISO 639-2 codes, for example: "eng" for english) ''; @@ -24,7 +23,7 @@ let compatFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' The path to the xkb compat file. This file sets the compatibility state, used to preserve compatibility with xkb-unaware programs. @@ -35,7 +34,7 @@ let geometryFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' 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. @@ -46,7 +45,7 @@ let keycodesFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' The path to the xkb keycodes file. This file specifies the range and the interpretation of the raw keycodes sent by the keyboard. @@ -57,7 +56,7 @@ let symbolsFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' 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 @@ -68,7 +67,7 @@ let typesFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' The path to the xkb types file. This file specifies the key types that can be associated with the various keyboard keys. @@ -111,7 +110,7 @@ in }; } ''; - description = lib.mdDoc '' + description = '' 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>. diff --git a/nixos/modules/services/x11/fractalart.nix b/nixos/modules/services/x11/fractalart.nix index f7fc1ec962287..448248a58794d 100644 --- a/nixos/modules/services/x11/fractalart.nix +++ b/nixos/modules/services/x11/fractalart.nix @@ -8,21 +8,21 @@ in { type = types.bool; default = false; example = true; - description = lib.mdDoc "Enable FractalArt for generating colorful wallpapers on login"; + description = "Enable FractalArt for generating colorful wallpapers on login"; }; width = mkOption { type = types.nullOr types.int; default = null; example = 1920; - description = lib.mdDoc "Screen width"; + description = "Screen width"; }; height = mkOption { type = types.nullOr types.int; default = null; example = 1080; - description = lib.mdDoc "Screen height"; + description = "Screen height"; }; }; diff --git a/nixos/modules/services/x11/gdk-pixbuf.nix b/nixos/modules/services/x11/gdk-pixbuf.nix index 9c088e4cc4237..9e89d9f96c4af 100644 --- a/nixos/modules/services/x11/gdk-pixbuf.nix +++ b/nixos/modules/services/x11/gdk-pixbuf.nix @@ -13,7 +13,7 @@ in services.xserver.gdk-pixbuf.modulePackages = lib.mkOption { type = lib.types.listOf lib.types.package; default = [ ]; - description = lib.mdDoc "Packages providing GDK-Pixbuf modules, for cache generation."; + description = "Packages providing GDK-Pixbuf modules, for cache generation."; }; }; diff --git a/nixos/modules/services/x11/hardware/cmt.nix b/nixos/modules/services/x11/hardware/cmt.nix index a44221141c3c6..55d3d840ee092 100644 --- a/nixos/modules/services/x11/hardware/cmt.nix +++ b/nixos/modules/services/x11/hardware/cmt.nix @@ -15,12 +15,12 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable chrome multitouch input (cmt). Touchpad drivers that are configured for chromebooks."; + description = "Enable chrome multitouch input (cmt). Touchpad drivers that are configured for chromebooks."; }; models = mkOption { type = types.enum [ "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"; - description = lib.mdDoc '' + description = '' 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>. ''; diff --git a/nixos/modules/services/x11/hardware/digimend.nix b/nixos/modules/services/x11/hardware/digimend.nix index f82aac41a3202..b1b1682f00b27 100644 --- a/nixos/modules/services/x11/hardware/digimend.nix +++ b/nixos/modules/services/x11/hardware/digimend.nix @@ -16,7 +16,7 @@ in services.xserver.digimend = { - enable = mkEnableOption (lib.mdDoc "the digimend drivers for Huion/XP-Pen/etc. tablets"); + enable = mkEnableOption "the digimend drivers for Huion/XP-Pen/etc. tablets"; }; diff --git a/nixos/modules/services/x11/hardware/libinput.nix b/nixos/modules/services/x11/hardware/libinput.nix index 0ea21eb1dce3a..54ff7d85a0331 100644 --- a/nixos/modules/services/x11/hardware/libinput.nix +++ b/nixos/modules/services/x11/hardware/libinput.nix @@ -11,8 +11,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "/dev/input/event0"; - description = - lib.mdDoc '' + description = '' Path for ${deviceType} device. Set to `null` to apply to any auto-detected ${deviceType}. ''; @@ -22,8 +21,7 @@ let cfg = config.services.xserver.libinput; type = types.enum [ "flat" "adaptive" ]; default = "adaptive"; example = "flat"; - description = - lib.mdDoc '' + description = '' Sets the pointer acceleration profile to the given profile. Permitted values are `adaptive`, `flat`. Not all devices support this option or all profiles. @@ -39,15 +37,14 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "-0.5"; - description = lib.mdDoc "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; + description = "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; }; buttonMapping = mkOption { type = types.nullOr types.str; default = null; example = "1 6 3 4 5 0 7"; - description = - lib.mdDoc '' + description = '' Sets the logical button mapping for this device, see XSetPointerMapping(3). The string must be a space-separated list of button mappings in the order of the logical buttons on the device, starting with button 1. The default mapping is "1 2 3 ... 32". A mapping of 0 deac‐ @@ -61,8 +58,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "0.5 0 0 0 0.8 0.1 0 0 1"; - description = - lib.mdDoc '' + description = '' A string of 9 space-separated floating point numbers. Sets the calibration matrix to the 3x3 matrix where the first row is (abc), the second row is (def) and the third row is (ghi). ''; @@ -72,8 +68,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr (types.enum [ "none" "buttonareas" "clickfinger" ]); default = null; example = "buttonareas"; - description = - lib.mdDoc '' + description = '' Enables a click method. Permitted values are `none`, `buttonareas`, `clickfinger`. Not all devices support all methods, if an option is unsupported, @@ -84,14 +79,13 @@ let cfg = config.services.xserver.libinput; leftHanded = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enables left-handed button orientation, i.e. swapping left and right buttons."; + description = "Enables left-handed button orientation, i.e. swapping left and right buttons."; }; middleEmulation = mkOption { type = types.bool; default = true; - description = - lib.mdDoc '' + description = '' Enables middle button emulation. When enabled, pressing the left and right buttons simultaneously produces a middle mouse button click. ''; @@ -100,15 +94,14 @@ let cfg = config.services.xserver.libinput; naturalScrolling = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enables or disables natural scrolling behavior."; + description = "Enables or disables natural scrolling behavior."; }; scrollButton = mkOption { type = types.nullOr types.int; default = null; example = 1; - description = - lib.mdDoc '' + description = '' Designates a button as scroll button. If the ScrollMethod is button and the button is logically held down, x/y axis movement is converted into scroll events. ''; @@ -118,8 +111,7 @@ let cfg = config.services.xserver.libinput; type = types.enum [ "twofinger" "edge" "button" "none" ]; default = "twofinger"; example = "edge"; - description = - lib.mdDoc '' + description = '' Specify the scrolling method: `twofinger`, `edge`, `button`, or `none` ''; @@ -128,8 +120,7 @@ let cfg = config.services.xserver.libinput; horizontalScrolling = mkOption { type = types.bool; default = true; - description = - lib.mdDoc '' + description = '' Enables or disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll events from libinput. This does not disable horizontal scroll events from libinput; it merely discards the horizontal axis from any scroll events. @@ -140,8 +131,7 @@ let cfg = config.services.xserver.libinput; type = types.enum [ "disabled" "enabled" "disabled-on-external-mouse" ]; default = "enabled"; example = "disabled"; - description = - lib.mdDoc '' + description = '' Sets the send events mode to `disabled`, `enabled`, or `disabled-on-external-mouse` ''; @@ -150,8 +140,7 @@ let cfg = config.services.xserver.libinput; tapping = mkOption { type = types.bool; default = true; - description = - lib.mdDoc '' + description = '' Enables or disables tap-to-click behavior. ''; }; @@ -159,7 +148,7 @@ let cfg = config.services.xserver.libinput; tappingButtonMap = mkOption { type = types.nullOr (types.enum [ "lrm" "lmr" ]); default = null; - description = lib.mdDoc '' + description = '' Set the button mapping for 1/2/3-finger taps to left/right/middle or left/middle/right, respectively. ''; }; @@ -167,8 +156,7 @@ let cfg = config.services.xserver.libinput; tappingDragLock = mkOption { type = types.bool; default = true; - description = - lib.mdDoc '' + description = '' Enables or disables drag lock during tapping behavior. When enabled, a finger up during tap- and-drag will not immediately release the button. If the finger is set down again within the timeout, the dragging process continues. @@ -179,7 +167,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "0.5 0 0 0 0.8 0.1 0 0 1"; - description = lib.mdDoc '' + description = '' A string of 9 space-separated floating point numbers. Sets the transformation matrix to the 3x3 matrix where the first row is (abc), the second row is (def) and the third row is (ghi). ''; @@ -188,8 +176,7 @@ let cfg = config.services.xserver.libinput; disableWhileTyping = mkOption { type = types.bool; default = false; - description = - lib.mdDoc '' + description = '' Disable input method while typing. ''; }; @@ -201,7 +188,7 @@ let cfg = config.services.xserver.libinput; '' Option "DragLockButtons" "L1 B1 L2 B2" ''; - description = lib.mdDoc '' + description = '' Additional options for libinput ${deviceType} driver. See {manpage}`libinput(4)` for available options."; @@ -260,7 +247,7 @@ in { options = { services.xserver.libinput = { - enable = mkEnableOption (lib.mdDoc "libinput") // { + enable = mkEnableOption "libinput" // { default = config.services.xserver.enable; defaultText = lib.literalExpression "config.services.xserver.enable"; }; diff --git a/nixos/modules/services/x11/hardware/synaptics.nix b/nixos/modules/services/x11/hardware/synaptics.nix index 7b45222ac64c3..4dfa917d8fb4a 100644 --- a/nixos/modules/services/x11/hardware/synaptics.nix +++ b/nixos/modules/services/x11/hardware/synaptics.nix @@ -30,15 +30,14 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whether to enable touchpad support. Deprecated: Consider services.xserver.libinput.enable."; + description = "Whether to enable touchpad support. Deprecated: Consider services.xserver.libinput.enable."; }; dev = mkOption { type = types.nullOr types.str; default = null; example = "/dev/input/event0"; - description = - lib.mdDoc '' + description = '' Path for touchpad device. Set to null to apply to any auto-detected touchpad. ''; @@ -47,73 +46,73 @@ in { accelFactor = mkOption { type = types.nullOr types.str; default = "0.001"; - description = lib.mdDoc "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; + description = "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; }; minSpeed = mkOption { type = types.nullOr types.str; default = "0.6"; - description = lib.mdDoc "Cursor speed factor for precision finger motion."; + description = "Cursor speed factor for precision finger motion."; }; maxSpeed = mkOption { type = types.nullOr types.str; default = "1.0"; - description = lib.mdDoc "Cursor speed factor for highest-speed finger motion."; + description = "Cursor speed factor for highest-speed finger motion."; }; scrollDelta = mkOption { type = types.nullOr types.int; default = null; example = 75; - description = lib.mdDoc "Move distance of the finger for a scroll event."; + description = "Move distance of the finger for a scroll event."; }; twoFingerScroll = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whether to enable two-finger drag-scrolling. Overridden by horizTwoFingerScroll and vertTwoFingerScroll."; + description = "Whether to enable two-finger drag-scrolling. Overridden by horizTwoFingerScroll and vertTwoFingerScroll."; }; horizTwoFingerScroll = mkOption { type = types.bool; default = cfg.twoFingerScroll; defaultText = literalExpression "config.${opt.twoFingerScroll}"; - description = lib.mdDoc "Whether to enable horizontal two-finger drag-scrolling."; + description = "Whether to enable horizontal two-finger drag-scrolling."; }; vertTwoFingerScroll = mkOption { type = types.bool; default = cfg.twoFingerScroll; defaultText = literalExpression "config.${opt.twoFingerScroll}"; - description = lib.mdDoc "Whether to enable vertical two-finger drag-scrolling."; + description = "Whether to enable vertical two-finger drag-scrolling."; }; horizEdgeScroll = mkOption { type = types.bool; default = ! cfg.horizTwoFingerScroll; defaultText = literalExpression "! config.${opt.horizTwoFingerScroll}"; - description = lib.mdDoc "Whether to enable horizontal edge drag-scrolling."; + description = "Whether to enable horizontal edge drag-scrolling."; }; vertEdgeScroll = mkOption { type = types.bool; default = ! cfg.vertTwoFingerScroll; defaultText = literalExpression "! config.${opt.vertTwoFingerScroll}"; - description = lib.mdDoc "Whether to enable vertical edge drag-scrolling."; + description = "Whether to enable vertical edge drag-scrolling."; }; tapButtons = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Whether to enable tap buttons."; + description = "Whether to enable tap buttons."; }; buttonsMap = mkOption { type = types.listOf types.int; default = [1 2 3]; example = [1 3 2]; - description = lib.mdDoc "Remap touchpad buttons."; + description = "Remap touchpad buttons."; apply = map toString; }; @@ -121,34 +120,34 @@ in { type = types.listOf types.int; default = [1 2 3]; example = [1 3 2]; - description = lib.mdDoc "Remap several-fingers taps."; + description = "Remap several-fingers taps."; apply = map toString; }; palmDetect = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whether to enable palm detection (hardware support required)"; + description = "Whether to enable palm detection (hardware support required)"; }; palmMinWidth = mkOption { type = types.nullOr types.int; default = null; example = 5; - description = lib.mdDoc "Minimum finger width at which touch is considered a palm"; + description = "Minimum finger width at which touch is considered a palm"; }; palmMinZ = mkOption { type = types.nullOr types.int; default = null; example = 20; - description = lib.mdDoc "Minimum finger pressure at which touch is considered a palm"; + description = "Minimum finger pressure at which touch is considered a palm"; }; horizontalScroll = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Whether to enable horizontal scrolling (on touchpad)"; + description = "Whether to enable horizontal scrolling (on touchpad)"; }; additionalOptions = mkOption { @@ -158,7 +157,7 @@ in { Option "RTCornerButton" "2" Option "RBCornerButton" "3" ''; - description = lib.mdDoc '' + description = '' Additional options for synaptics touchpad driver. ''; }; diff --git a/nixos/modules/services/x11/hardware/wacom.nix b/nixos/modules/services/x11/hardware/wacom.nix index 4994e5c1a2cc7..4517788f56d5c 100644 --- a/nixos/modules/services/x11/hardware/wacom.nix +++ b/nixos/modules/services/x11/hardware/wacom.nix @@ -17,7 +17,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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 ? diff --git a/nixos/modules/services/x11/imwheel.nix b/nixos/modules/services/x11/imwheel.nix index bd2bcb7bcd06c..311cbc6f73334 100644 --- a/nixos/modules/services/x11/imwheel.nix +++ b/nixos/modules/services/x11/imwheel.nix @@ -6,13 +6,13 @@ in { options = { services.xserver.imwheel = { - enable = mkEnableOption (lib.mdDoc "IMWheel service"); + enable = mkEnableOption "IMWheel service"; extraOptions = mkOption { type = types.listOf types.str; default = [ "--buttons=45" ]; example = [ "--debug" ]; - description = lib.mdDoc '' + description = '' Additional command-line arguments to pass to {command}`imwheel`. ''; @@ -33,7 +33,7 @@ in '''; } ''; - description = lib.mdDoc '' + description = '' Window class translation rules. /etc/X11/imwheelrc is generated based on this config which means this config is global for all users. diff --git a/nixos/modules/services/x11/picom.nix b/nixos/modules/services/x11/picom.nix index de0a8f4d5bcd3..fe07ab515ef25 100644 --- a/nixos/modules/services/x11/picom.nix +++ b/nixos/modules/services/x11/picom.nix @@ -56,7 +56,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether or not to enable Picom as the X.org composite manager. ''; }; @@ -66,7 +66,7 @@ in { fade = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Fade windows in and out. ''; }; @@ -75,7 +75,7 @@ in { type = types.ints.positive; default = 10; example = 5; - description = lib.mdDoc '' + description = '' Time between fade animation step (in ms). ''; }; @@ -84,7 +84,7 @@ in { type = pairOf (types.numbers.between 0.01 1); default = [ 0.028 0.03 ]; example = [ 0.04 0.04 ]; - description = lib.mdDoc '' + description = '' Opacity change between fade steps (in and out). ''; }; @@ -97,7 +97,7 @@ in { "name ~= 'Firefox$'" "focused = 1" ]; - description = lib.mdDoc '' + description = '' List of conditions of windows that should not be faded. See `picom(1)` man page for more examples. ''; @@ -106,7 +106,7 @@ in { shadow = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Draw window shadows. ''; }; @@ -115,7 +115,7 @@ in { type = pairOf types.int; default = [ (-15) (-15) ]; example = [ (-10) (-15) ]; - description = lib.mdDoc '' + description = '' Left and right offset for shadows (in pixels). ''; }; @@ -124,7 +124,7 @@ in { type = types.numbers.between 0 1; default = 0.75; example = 0.8; - description = lib.mdDoc '' + description = '' Window shadows opacity. ''; }; @@ -137,7 +137,7 @@ in { "name ~= 'Firefox$'" "focused = 1" ]; - description = lib.mdDoc '' + description = '' List of conditions of windows that should have no shadow. See `picom(1)` man page for more examples. ''; @@ -147,7 +147,7 @@ in { type = types.numbers.between 0 1; default = 1.0; example = 0.8; - description = lib.mdDoc '' + description = '' Opacity of active windows. ''; }; @@ -156,7 +156,7 @@ in { type = types.numbers.between 0.1 1; default = 1.0; example = 0.8; - description = lib.mdDoc '' + description = '' Opacity of inactive windows. ''; }; @@ -165,7 +165,7 @@ in { type = types.numbers.between 0 1; default = 1.0; example = 0.8; - description = lib.mdDoc '' + description = '' Opacity of dropdown and popup menu. ''; }; @@ -183,7 +183,7 @@ in { } ''; example = {}; - description = lib.mdDoc '' + description = '' Rules for specific window types. ''; }; @@ -195,7 +195,7 @@ in { "95:class_g = 'URxvt' && !_NET_WM_STATE@:32a" "0:_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'" ]; - description = lib.mdDoc '' + description = '' Rules that control the opacity of windows, in format PERCENT:PATTERN. ''; }; @@ -203,7 +203,7 @@ in { backend = mkOption { type = types.enum [ "egl" "glx" "xrender" "xr_glx_hybrid" ]; default = "xrender"; - description = lib.mdDoc '' + description = '' Backend to use: `egl`, `glx`, `xrender` or `xr_glx_hybrid`. ''; }; @@ -221,7 +221,7 @@ in { if isBool x then x else warn msg res; - description = lib.mdDoc '' + description = '' Enable vertical synchronization. Chooses the best method (drm, opengl, opengl-oml, opengl-swc, opengl-mswc) automatically. The bool value should be used, the others are just for backwards compatibility. @@ -255,7 +255,7 @@ in { deviation = 5.0; }; ''; - description = lib.mdDoc '' + description = '' Picom settings. Use this option to configure Picom settings not exposed in a NixOS option or to bypass one. For the available options see the CONFIGURATION FILES section at `picom(1)`. diff --git a/nixos/modules/services/x11/redshift.nix b/nixos/modules/services/x11/redshift.nix index 80605eb11407a..b0b22e6782784 100644 --- a/nixos/modules/services/x11/redshift.nix +++ b/nixos/modules/services/x11/redshift.nix @@ -29,7 +29,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable Redshift to change your screen's colour temperature depending on the time of day. ''; @@ -39,7 +39,7 @@ in { day = mkOption { type = types.int; default = 5500; - description = lib.mdDoc '' + description = '' Colour temperature to use during the day, between `1000` and `25000` K. ''; @@ -47,7 +47,7 @@ in { night = mkOption { type = types.int; default = 3700; - description = lib.mdDoc '' + description = '' Colour temperature to use at night, between `1000` and `25000` K. ''; @@ -58,7 +58,7 @@ in { day = mkOption { type = types.str; default = "1"; - description = lib.mdDoc '' + description = '' Screen brightness to apply during the day, between `0.1` and `1.0`. ''; @@ -66,7 +66,7 @@ in { night = mkOption { type = types.str; default = "1"; - description = lib.mdDoc '' + description = '' Screen brightness to apply during the night, between `0.1` and `1.0`. ''; @@ -79,7 +79,7 @@ in { type = types.str; default = "/bin/redshift"; example = "/bin/redshift-gtk"; - description = lib.mdDoc '' + description = '' Redshift executable to use within the package. ''; }; @@ -88,7 +88,7 @@ in { type = types.listOf types.str; default = []; example = [ "-v" "-m randr" ]; - description = lib.mdDoc '' + description = '' Additional command-line arguments to pass to {command}`redshift`. ''; diff --git a/nixos/modules/services/x11/touchegg.nix b/nixos/modules/services/x11/touchegg.nix index 54918245f1569..660ec0b8f706f 100644 --- a/nixos/modules/services/x11/touchegg.nix +++ b/nixos/modules/services/x11/touchegg.nix @@ -11,7 +11,7 @@ in { ###### interface options.services.touchegg = { - enable = mkEnableOption (lib.mdDoc "touchegg, a multi-touch gesture recognizer"); + enable = mkEnableOption "touchegg, a multi-touch gesture recognizer"; package = mkPackageOption pkgs "touchegg" { }; }; diff --git a/nixos/modules/services/x11/unclutter-xfixes.nix b/nixos/modules/services/x11/unclutter-xfixes.nix index 9255c8124788d..a302eee1bad93 100644 --- a/nixos/modules/services/x11/unclutter-xfixes.nix +++ b/nixos/modules/services/x11/unclutter-xfixes.nix @@ -8,7 +8,7 @@ in { options.services.unclutter-xfixes = { enable = mkOption { - description = lib.mdDoc "Enable unclutter-xfixes to hide your mouse cursor when inactive."; + description = "Enable unclutter-xfixes to hide your mouse cursor when inactive."; type = types.bool; default = false; }; @@ -16,19 +16,19 @@ in { package = mkPackageOption pkgs "unclutter-xfixes" { }; timeout = mkOption { - description = lib.mdDoc "Number of seconds before the cursor is marked inactive."; + description = "Number of seconds before the cursor is marked inactive."; type = types.int; default = 1; }; threshold = mkOption { - description = lib.mdDoc "Minimum number of pixels considered cursor movement."; + description = "Minimum number of pixels considered cursor movement."; type = types.int; default = 1; }; extraOptions = mkOption { - description = lib.mdDoc "More arguments to pass to the unclutter-xfixes command."; + description = "More arguments to pass to the unclutter-xfixes command."; type = types.listOf types.str; default = []; example = [ "exclude-root" "ignore-scrolling" "fork" ]; diff --git a/nixos/modules/services/x11/unclutter.nix b/nixos/modules/services/x11/unclutter.nix index ecf7e2668cec7..7f07bb8582bc7 100644 --- a/nixos/modules/services/x11/unclutter.nix +++ b/nixos/modules/services/x11/unclutter.nix @@ -8,7 +8,7 @@ in { options.services.unclutter = { enable = mkOption { - description = lib.mdDoc "Enable unclutter to hide your mouse cursor when inactive"; + description = "Enable unclutter to hide your mouse cursor when inactive"; type = types.bool; default = false; }; @@ -16,32 +16,32 @@ in { package = mkPackageOption pkgs "unclutter" { }; keystroke = mkOption { - description = lib.mdDoc "Wait for a keystroke before hiding the cursor"; + description = "Wait for a keystroke before hiding the cursor"; type = types.bool; default = false; }; timeout = mkOption { - description = lib.mdDoc "Number of seconds before the cursor is marked inactive"; + description = "Number of seconds before the cursor is marked inactive"; type = types.int; default = 1; }; threshold = mkOption { - description = lib.mdDoc "Minimum number of pixels considered cursor movement"; + description = "Minimum number of pixels considered cursor movement"; type = types.int; default = 1; }; excluded = mkOption { - description = lib.mdDoc "Names of windows where unclutter should not apply"; + description = "Names of windows where unclutter should not apply"; type = types.listOf types.str; default = []; example = [ "" ]; }; extraOptions = mkOption { - description = lib.mdDoc "More arguments to pass to the unclutter command"; + description = "More arguments to pass to the unclutter command"; type = types.listOf types.str; default = []; example = [ "noevent" "grab" ]; diff --git a/nixos/modules/services/x11/urserver.nix b/nixos/modules/services/x11/urserver.nix index d0b6e0775e5d2..0beb62eb766a3 100644 --- a/nixos/modules/services/x11/urserver.nix +++ b/nixos/modules/services/x11/urserver.nix @@ -5,7 +5,7 @@ let cfg = config.services.urserver; in { - options.services.urserver.enable = lib.mkEnableOption (lib.mdDoc "urserver"); + options.services.urserver.enable = lib.mkEnableOption "urserver"; config = lib.mkIf cfg.enable { diff --git a/nixos/modules/services/x11/urxvtd.nix b/nixos/modules/services/x11/urxvtd.nix index bab9f43b09524..618db85d477bd 100644 --- a/nixos/modules/services/x11/urxvtd.nix +++ b/nixos/modules/services/x11/urxvtd.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable urxvtd, the urxvt terminal daemon. To use urxvtd, run "urxvtc". ''; diff --git a/nixos/modules/services/x11/window-managers/2bwm.nix b/nixos/modules/services/x11/window-managers/2bwm.nix index 8483a74b9f6c8..fdbdf35b0f5af 100644 --- a/nixos/modules/services/x11/window-managers/2bwm.nix +++ b/nixos/modules/services/x11/window-managers/2bwm.nix @@ -13,7 +13,7 @@ in ###### interface options = { - services.xserver.windowManager."2bwm".enable = mkEnableOption (lib.mdDoc "2bwm"); + services.xserver.windowManager."2bwm".enable = mkEnableOption "2bwm"; }; diff --git a/nixos/modules/services/x11/window-managers/afterstep.nix b/nixos/modules/services/x11/window-managers/afterstep.nix index a060635979715..ba88a64c702a6 100644 --- a/nixos/modules/services/x11/window-managers/afterstep.nix +++ b/nixos/modules/services/x11/window-managers/afterstep.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.afterstep.enable = mkEnableOption (lib.mdDoc "afterstep"); + services.xserver.windowManager.afterstep.enable = mkEnableOption "afterstep"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/awesome.nix b/nixos/modules/services/x11/window-managers/awesome.nix index 0478f326825f2..20a33fa87d4d8 100644 --- a/nixos/modules/services/x11/window-managers/awesome.nix +++ b/nixos/modules/services/x11/window-managers/awesome.nix @@ -21,12 +21,12 @@ in services.xserver.windowManager.awesome = { - enable = mkEnableOption (lib.mdDoc "Awesome window manager"); + enable = mkEnableOption "Awesome window manager"; luaModules = mkOption { default = []; type = types.listOf types.package; - description = lib.mdDoc "List of lua packages available for being used in the Awesome configuration."; + description = "List of lua packages available for being used in the Awesome configuration."; example = literalExpression "[ pkgs.luaPackages.vicious ]"; }; @@ -35,7 +35,7 @@ in noArgb = mkOption { default = false; type = types.bool; - description = lib.mdDoc "Disable client transparency support, which can be greatly detrimental to performance in some setups"; + description = "Disable client transparency support, which can be greatly detrimental to performance in some setups"; }; }; diff --git a/nixos/modules/services/x11/window-managers/berry.nix b/nixos/modules/services/x11/window-managers/berry.nix index eb5528602677f..0d2285e7a60eb 100644 --- a/nixos/modules/services/x11/window-managers/berry.nix +++ b/nixos/modules/services/x11/window-managers/berry.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.berry.enable = mkEnableOption (lib.mdDoc "berry"); + services.xserver.windowManager.berry.enable = mkEnableOption "berry"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/bspwm.nix b/nixos/modules/services/x11/window-managers/bspwm.nix index cd8852cdfdee5..b7feeab52a56b 100644 --- a/nixos/modules/services/x11/window-managers/bspwm.nix +++ b/nixos/modules/services/x11/window-managers/bspwm.nix @@ -9,7 +9,7 @@ in { options = { services.xserver.windowManager.bspwm = { - enable = mkEnableOption (lib.mdDoc "bspwm"); + enable = mkEnableOption "bspwm"; package = mkPackageOption pkgs "bspwm" { example = "bspwm-unstable"; @@ -18,7 +18,7 @@ in type = with types; nullOr path; example = literalExpression ''"''${pkgs.bspwm}/share/doc/bspwm/examples/bspwmrc"''; default = null; - description = lib.mdDoc '' + description = '' Path to the bspwm configuration file. If null, $HOME/.config/bspwm/bspwmrc will be used. ''; @@ -32,7 +32,7 @@ in type = with types; nullOr path; example = literalExpression ''"''${pkgs.bspwm}/share/doc/bspwm/examples/sxhkdrc"''; default = null; - description = lib.mdDoc '' + description = '' Path to the sxhkd configuration file. If null, $HOME/.config/sxhkd/sxhkdrc will be used. ''; diff --git a/nixos/modules/services/x11/window-managers/clfswm.nix b/nixos/modules/services/x11/window-managers/clfswm.nix index 4d47c50c87efd..5500c77a038be 100644 --- a/nixos/modules/services/x11/window-managers/clfswm.nix +++ b/nixos/modules/services/x11/window-managers/clfswm.nix @@ -9,7 +9,7 @@ in { options = { services.xserver.windowManager.clfswm = { - enable = mkEnableOption (lib.mdDoc "clfswm"); + enable = mkEnableOption "clfswm"; package = mkPackageOption pkgs [ "lispPackages" "clfswm" ] { }; }; }; diff --git a/nixos/modules/services/x11/window-managers/cwm.nix b/nixos/modules/services/x11/window-managers/cwm.nix index 9a143e7bccc39..03375a226bb6b 100644 --- a/nixos/modules/services/x11/window-managers/cwm.nix +++ b/nixos/modules/services/x11/window-managers/cwm.nix @@ -7,7 +7,7 @@ let in { options = { - services.xserver.windowManager.cwm.enable = mkEnableOption (lib.mdDoc "cwm"); + services.xserver.windowManager.cwm.enable = mkEnableOption "cwm"; }; config = mkIf cfg.enable { services.xserver.windowManager.session = singleton diff --git a/nixos/modules/services/x11/window-managers/default.nix b/nixos/modules/services/x11/window-managers/default.nix index 527c95bb14ac3..ec54e4cc12a9e 100644 --- a/nixos/modules/services/x11/window-managers/default.nix +++ b/nixos/modules/services/x11/window-managers/default.nix @@ -62,7 +62,7 @@ in name = "wmii"; start = "..."; }]; - description = lib.mdDoc '' + description = '' Internal option used to add some common line to window manager scripts before forwarding the value to the `displayManager`. @@ -76,7 +76,7 @@ in type = types.nullOr types.str; default = null; example = "wmii"; - description = lib.mdDoc '' + description = '' **Deprecated**, please use [](#opt-services.displayManager.defaultSession) instead. Default window manager loaded if none have been chosen. diff --git a/nixos/modules/services/x11/window-managers/dk.nix b/nixos/modules/services/x11/window-managers/dk.nix index 441fc18af4b1b..afd35ae477a64 100644 --- a/nixos/modules/services/x11/window-managers/dk.nix +++ b/nixos/modules/services/x11/window-managers/dk.nix @@ -7,7 +7,7 @@ in { options = { services.xserver.windowManager.dk = { - enable = lib.mkEnableOption (lib.mdDoc "dk"); + enable = lib.mkEnableOption "dk"; package = lib.mkPackageOption pkgs "dk" { }; }; diff --git a/nixos/modules/services/x11/window-managers/dwm.nix b/nixos/modules/services/x11/window-managers/dwm.nix index b5c7d37653edf..c81a834a06796 100644 --- a/nixos/modules/services/x11/window-managers/dwm.nix +++ b/nixos/modules/services/x11/window-managers/dwm.nix @@ -14,7 +14,7 @@ in options = { services.xserver.windowManager.dwm = { - enable = mkEnableOption (lib.mdDoc "dwm"); + enable = mkEnableOption "dwm"; package = mkPackageOption pkgs "dwm" { example = '' pkgs.dwm.overrideAttrs (oldAttrs: rec { diff --git a/nixos/modules/services/x11/window-managers/e16.nix b/nixos/modules/services/x11/window-managers/e16.nix index 000feea12c2c7..3e1a22c4dabd8 100644 --- a/nixos/modules/services/x11/window-managers/e16.nix +++ b/nixos/modules/services/x11/window-managers/e16.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.e16.enable = mkEnableOption (lib.mdDoc "e16"); + services.xserver.windowManager.e16.enable = mkEnableOption "e16"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/evilwm.nix b/nixos/modules/services/x11/window-managers/evilwm.nix index 842f84c2cfbea..6f1db2110f879 100644 --- a/nixos/modules/services/x11/window-managers/evilwm.nix +++ b/nixos/modules/services/x11/window-managers/evilwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.evilwm.enable = mkEnableOption (lib.mdDoc "evilwm"); + services.xserver.windowManager.evilwm.enable = mkEnableOption "evilwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/exwm.nix b/nixos/modules/services/x11/window-managers/exwm.nix index a97ed74ae8814..406b6be5b92c2 100644 --- a/nixos/modules/services/x11/window-managers/exwm.nix +++ b/nixos/modules/services/x11/window-managers/exwm.nix @@ -18,7 +18,7 @@ in { options = { services.xserver.windowManager.exwm = { - enable = mkEnableOption (lib.mdDoc "exwm"); + enable = mkEnableOption "exwm"; loadScript = mkOption { default = "(require 'exwm)"; type = types.lines; @@ -26,7 +26,7 @@ in (require 'exwm) (exwm-enable) ''; - description = lib.mdDoc '' + description = '' 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. @@ -35,7 +35,7 @@ in enableDefaultConfig = mkOption { default = true; type = lib.types.bool; - description = lib.mdDoc "Enable an uncustomised exwm configuration."; + description = "Enable an uncustomised exwm configuration."; }; extraPackages = mkOption { type = types.functionTo (types.listOf types.package); @@ -48,7 +48,7 @@ in epkgs.proofgeneral ] ''; - description = lib.mdDoc '' + description = '' Extra packages available to Emacs. The value must be a function which receives the attrset defined in {var}`emacs.pkgs` as the sole argument. diff --git a/nixos/modules/services/x11/window-managers/fluxbox.nix b/nixos/modules/services/x11/window-managers/fluxbox.nix index 24165fb6fb07e..b409335702aff 100644 --- a/nixos/modules/services/x11/window-managers/fluxbox.nix +++ b/nixos/modules/services/x11/window-managers/fluxbox.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.fluxbox.enable = mkEnableOption (lib.mdDoc "fluxbox"); + services.xserver.windowManager.fluxbox.enable = mkEnableOption "fluxbox"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/fvwm2.nix b/nixos/modules/services/x11/window-managers/fvwm2.nix index aaf3c5c46906a..909b3a475a9c2 100644 --- a/nixos/modules/services/x11/window-managers/fvwm2.nix +++ b/nixos/modules/services/x11/window-managers/fvwm2.nix @@ -19,12 +19,12 @@ in options = { services.xserver.windowManager.fvwm2 = { - enable = mkEnableOption (lib.mdDoc "Fvwm2 window manager"); + enable = mkEnableOption "Fvwm2 window manager"; gestures = mkOption { default = false; type = types.bool; - description = lib.mdDoc "Whether or not to enable libstroke for gesture support"; + description = "Whether or not to enable libstroke for gesture support"; }; }; }; diff --git a/nixos/modules/services/x11/window-managers/fvwm3.nix b/nixos/modules/services/x11/window-managers/fvwm3.nix index 50c76b67eea34..43111f917d494 100644 --- a/nixos/modules/services/x11/window-managers/fvwm3.nix +++ b/nixos/modules/services/x11/window-managers/fvwm3.nix @@ -13,7 +13,7 @@ in options = { services.xserver.windowManager.fvwm3 = { - enable = mkEnableOption (lib.mdDoc "Fvwm3 window manager"); + enable = mkEnableOption "Fvwm3 window manager"; }; }; diff --git a/nixos/modules/services/x11/window-managers/hackedbox.nix b/nixos/modules/services/x11/window-managers/hackedbox.nix index 61e911961f517..641cf1bdcbe23 100644 --- a/nixos/modules/services/x11/window-managers/hackedbox.nix +++ b/nixos/modules/services/x11/window-managers/hackedbox.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.hackedbox.enable = mkEnableOption (lib.mdDoc "hackedbox"); + services.xserver.windowManager.hackedbox.enable = mkEnableOption "hackedbox"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/herbstluftwm.nix b/nixos/modules/services/x11/window-managers/herbstluftwm.nix index 16ebc2bfe1d30..7edaf4e980ec4 100644 --- a/nixos/modules/services/x11/window-managers/herbstluftwm.nix +++ b/nixos/modules/services/x11/window-managers/herbstluftwm.nix @@ -9,14 +9,14 @@ in { options = { services.xserver.windowManager.herbstluftwm = { - enable = mkEnableOption (lib.mdDoc "herbstluftwm"); + enable = mkEnableOption "herbstluftwm"; package = mkPackageOption pkgs "herbstluftwm" { }; configFile = mkOption { default = null; type = with types; nullOr path; - description = lib.mdDoc '' + description = '' Path to the herbstluftwm configuration file. If left at the default value, $XDG_CONFIG_HOME/herbstluftwm/autostart will be used. diff --git a/nixos/modules/services/x11/window-managers/hypr.nix b/nixos/modules/services/x11/window-managers/hypr.nix index 4c1fea71f93e4..18111f8741a20 100644 --- a/nixos/modules/services/x11/window-managers/hypr.nix +++ b/nixos/modules/services/x11/window-managers/hypr.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.hypr.enable = mkEnableOption (lib.mdDoc "hypr"); + services.xserver.windowManager.hypr.enable = mkEnableOption "hypr"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/i3.nix b/nixos/modules/services/x11/window-managers/i3.nix index e824d91812a71..4b2fb40585a70 100644 --- a/nixos/modules/services/x11/window-managers/i3.nix +++ b/nixos/modules/services/x11/window-managers/i3.nix @@ -12,12 +12,12 @@ in { options.services.xserver.windowManager.i3 = { - enable = mkEnableOption (lib.mdDoc "i3 window manager"); + enable = mkEnableOption "i3 window manager"; configFile = mkOption { default = null; type = with types; nullOr path; - description = lib.mdDoc '' + description = '' Path to the i3 configuration file. If left at the default value, $HOME/.i3/config will be used. ''; @@ -26,7 +26,7 @@ in updateSessionEnvironment = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to run dbus-update-activation-environment and systemctl import-environment before session start. Required for xdg portals to function properly. ''; @@ -35,7 +35,7 @@ in extraSessionCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands executed just before i3 is started. ''; }; @@ -52,7 +52,7 @@ in i3lock ] ''; - description = lib.mdDoc '' + description = '' Extra packages to be installed system wide. ''; }; diff --git a/nixos/modules/services/x11/window-managers/icewm.nix b/nixos/modules/services/x11/window-managers/icewm.nix index e3cb5cc3be2ba..cb2f92d8a42c2 100644 --- a/nixos/modules/services/x11/window-managers/icewm.nix +++ b/nixos/modules/services/x11/window-managers/icewm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.icewm.enable = mkEnableOption (lib.mdDoc "icewm"); + services.xserver.windowManager.icewm.enable = mkEnableOption "icewm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/jwm.nix b/nixos/modules/services/x11/window-managers/jwm.nix index 40758029bc658..0e8dab2e9224d 100644 --- a/nixos/modules/services/x11/window-managers/jwm.nix +++ b/nixos/modules/services/x11/window-managers/jwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.jwm.enable = mkEnableOption (lib.mdDoc "jwm"); + services.xserver.windowManager.jwm.enable = mkEnableOption "jwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/katriawm.nix b/nixos/modules/services/x11/window-managers/katriawm.nix index 106631792ff4e..db04f6b43e529 100644 --- a/nixos/modules/services/x11/window-managers/katriawm.nix +++ b/nixos/modules/services/x11/window-managers/katriawm.nix @@ -1,14 +1,14 @@ { config, lib, pkgs, ... }: let - inherit (lib) mdDoc mkEnableOption mkIf mkPackageOption singleton; + inherit (lib) mkEnableOption mkIf mkPackageOption singleton; cfg = config.services.xserver.windowManager.katriawm; in { ###### interface options = { services.xserver.windowManager.katriawm = { - enable = mkEnableOption (mdDoc "katriawm"); + enable = mkEnableOption "katriawm"; package = mkPackageOption pkgs "katriawm" {}; }; }; diff --git a/nixos/modules/services/x11/window-managers/leftwm.nix b/nixos/modules/services/x11/window-managers/leftwm.nix index 2571735ba8bf9..3ef40df95df2c 100644 --- a/nixos/modules/services/x11/window-managers/leftwm.nix +++ b/nixos/modules/services/x11/window-managers/leftwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.leftwm.enable = mkEnableOption (lib.mdDoc "leftwm"); + services.xserver.windowManager.leftwm.enable = mkEnableOption "leftwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/lwm.nix b/nixos/modules/services/x11/window-managers/lwm.nix index 517abb23d4af6..e2aa062fd13be 100644 --- a/nixos/modules/services/x11/window-managers/lwm.nix +++ b/nixos/modules/services/x11/window-managers/lwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.lwm.enable = mkEnableOption (lib.mdDoc "lwm"); + services.xserver.windowManager.lwm.enable = mkEnableOption "lwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/metacity.nix b/nixos/modules/services/x11/window-managers/metacity.nix index 1f69147af5bc4..600afe759b2c9 100644 --- a/nixos/modules/services/x11/window-managers/metacity.nix +++ b/nixos/modules/services/x11/window-managers/metacity.nix @@ -10,7 +10,7 @@ in { options = { - services.xserver.windowManager.metacity.enable = mkEnableOption (lib.mdDoc "metacity"); + services.xserver.windowManager.metacity.enable = mkEnableOption "metacity"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/x11/window-managers/mlvwm.nix b/nixos/modules/services/x11/window-managers/mlvwm.nix index fe0433c24b60f..08dd04020296d 100644 --- a/nixos/modules/services/x11/window-managers/mlvwm.nix +++ b/nixos/modules/services/x11/window-managers/mlvwm.nix @@ -8,12 +8,12 @@ in { options.services.xserver.windowManager.mlvwm = { - enable = mkEnableOption (lib.mdDoc "Macintosh-like Virtual Window Manager"); + enable = mkEnableOption "Macintosh-like Virtual Window Manager"; configFile = mkOption { default = null; type = with types; nullOr path; - description = lib.mdDoc '' + description = '' Path to the mlvwm configuration file. If left at the default value, $HOME/.mlvwmrc will be used. ''; diff --git a/nixos/modules/services/x11/window-managers/mwm.nix b/nixos/modules/services/x11/window-managers/mwm.nix index 9f8dc0939e5ea..31f7b725f747d 100644 --- a/nixos/modules/services/x11/window-managers/mwm.nix +++ b/nixos/modules/services/x11/window-managers/mwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.mwm.enable = mkEnableOption (lib.mdDoc "mwm"); + services.xserver.windowManager.mwm.enable = mkEnableOption "mwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/nimdow.nix b/nixos/modules/services/x11/window-managers/nimdow.nix index 9cee4bb271a5a..2ac9ace63ce46 100644 --- a/nixos/modules/services/x11/window-managers/nimdow.nix +++ b/nixos/modules/services/x11/window-managers/nimdow.nix @@ -7,12 +7,12 @@ let in { options = { - services.xserver.windowManager.nimdow.enable = mkEnableOption (lib.mdDoc "nimdow"); + services.xserver.windowManager.nimdow.enable = mkEnableOption "nimdow"; services.xserver.windowManager.nimdow.package = mkOption { type = types.package; default = pkgs.nimdow; defaultText = "pkgs.nimdow"; - description = lib.mdDoc "nimdow package to use"; + description = "nimdow package to use"; }; }; diff --git a/nixos/modules/services/x11/window-managers/notion.nix b/nixos/modules/services/x11/window-managers/notion.nix index 0015e90a41c5e..4ece0d241c90c 100644 --- a/nixos/modules/services/x11/window-managers/notion.nix +++ b/nixos/modules/services/x11/window-managers/notion.nix @@ -8,7 +8,7 @@ in { options = { - services.xserver.windowManager.notion.enable = mkEnableOption (lib.mdDoc "notion"); + services.xserver.windowManager.notion.enable = mkEnableOption "notion"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/x11/window-managers/openbox.nix b/nixos/modules/services/x11/window-managers/openbox.nix index bf5a500f431ab..165772d1aa097 100644 --- a/nixos/modules/services/x11/window-managers/openbox.nix +++ b/nixos/modules/services/x11/window-managers/openbox.nix @@ -7,7 +7,7 @@ in { options = { - services.xserver.windowManager.openbox.enable = mkEnableOption (lib.mdDoc "openbox"); + services.xserver.windowManager.openbox.enable = mkEnableOption "openbox"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/x11/window-managers/pekwm.nix b/nixos/modules/services/x11/window-managers/pekwm.nix index 8818f568647a4..850335ce7ddfa 100644 --- a/nixos/modules/services/x11/window-managers/pekwm.nix +++ b/nixos/modules/services/x11/window-managers/pekwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.pekwm.enable = mkEnableOption (lib.mdDoc "pekwm"); + services.xserver.windowManager.pekwm.enable = mkEnableOption "pekwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/qtile.nix b/nixos/modules/services/x11/window-managers/qtile.nix index 1da61f5fa5e77..78152283a0a58 100644 --- a/nixos/modules/services/x11/window-managers/qtile.nix +++ b/nixos/modules/services/x11/window-managers/qtile.nix @@ -9,7 +9,7 @@ in { options.services.xserver.windowManager.qtile = { - enable = mkEnableOption (lib.mdDoc "qtile"); + enable = mkEnableOption "qtile"; package = mkPackageOption pkgs "qtile-unwrapped" { }; @@ -17,7 +17,7 @@ in type = with types; nullOr path; default = null; example = literalExpression "./your_config.py"; - description = lib.mdDoc '' + description = '' Path to the qtile configuration file. If null, $XDG_CONFIG_HOME/qtile/config.py will be used. ''; @@ -26,7 +26,7 @@ in backend = mkOption { type = types.enum [ "x11" "wayland" ]; default = "x11"; - description = lib.mdDoc '' + description = '' Backend to use in qtile: `x11` or `wayland`. ''; }; @@ -37,7 +37,7 @@ in defaultText = literalExpression '' python3Packages: with python3Packages; []; ''; - description = lib.mdDoc '' + description = '' Extra Python packages available to Qtile. An example would be to include `python3Packages.qtile-extras` for additional unofficial widgets. diff --git a/nixos/modules/services/x11/window-managers/ragnarwm.nix b/nixos/modules/services/x11/window-managers/ragnarwm.nix index 0f4c2660b1e07..3f550fb723256 100644 --- a/nixos/modules/services/x11/window-managers/ragnarwm.nix +++ b/nixos/modules/services/x11/window-managers/ragnarwm.nix @@ -10,7 +10,7 @@ in options = { services.xserver.windowManager.ragnarwm = { - enable = mkEnableOption (lib.mdDoc "ragnarwm"); + enable = mkEnableOption "ragnarwm"; package = mkPackageOption pkgs "ragnarwm" { }; }; }; diff --git a/nixos/modules/services/x11/window-managers/ratpoison.nix b/nixos/modules/services/x11/window-managers/ratpoison.nix index 1de0fad3e54d8..0d58481d45791 100644 --- a/nixos/modules/services/x11/window-managers/ratpoison.nix +++ b/nixos/modules/services/x11/window-managers/ratpoison.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.ratpoison.enable = mkEnableOption (lib.mdDoc "ratpoison"); + services.xserver.windowManager.ratpoison.enable = mkEnableOption "ratpoison"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/sawfish.nix b/nixos/modules/services/x11/window-managers/sawfish.nix index 1945a1af6763b..b988b5e1829e6 100644 --- a/nixos/modules/services/x11/window-managers/sawfish.nix +++ b/nixos/modules/services/x11/window-managers/sawfish.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.sawfish.enable = mkEnableOption (lib.mdDoc "sawfish"); + services.xserver.windowManager.sawfish.enable = mkEnableOption "sawfish"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/smallwm.nix b/nixos/modules/services/x11/window-managers/smallwm.nix index e92b18690d8a1..091ba4f92b94d 100644 --- a/nixos/modules/services/x11/window-managers/smallwm.nix +++ b/nixos/modules/services/x11/window-managers/smallwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.smallwm.enable = mkEnableOption (lib.mdDoc "smallwm"); + services.xserver.windowManager.smallwm.enable = mkEnableOption "smallwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/spectrwm.nix b/nixos/modules/services/x11/window-managers/spectrwm.nix index c464803a0b6a9..a1dc298d24269 100644 --- a/nixos/modules/services/x11/window-managers/spectrwm.nix +++ b/nixos/modules/services/x11/window-managers/spectrwm.nix @@ -9,7 +9,7 @@ in { options = { - services.xserver.windowManager.spectrwm.enable = mkEnableOption (lib.mdDoc "spectrwm"); + services.xserver.windowManager.spectrwm.enable = mkEnableOption "spectrwm"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/x11/window-managers/stumpwm.nix b/nixos/modules/services/x11/window-managers/stumpwm.nix index c6fc49f5821bb..fa6844e672f5a 100644 --- a/nixos/modules/services/x11/window-managers/stumpwm.nix +++ b/nixos/modules/services/x11/window-managers/stumpwm.nix @@ -8,7 +8,7 @@ in { options = { - services.xserver.windowManager.stumpwm.enable = mkEnableOption (lib.mdDoc "stumpwm"); + services.xserver.windowManager.stumpwm.enable = mkEnableOption "stumpwm"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/x11/window-managers/tinywm.nix b/nixos/modules/services/x11/window-managers/tinywm.nix index 7418a6ddc7606..8e5d9b9170cab 100644 --- a/nixos/modules/services/x11/window-managers/tinywm.nix +++ b/nixos/modules/services/x11/window-managers/tinywm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.tinywm.enable = mkEnableOption (lib.mdDoc "tinywm"); + services.xserver.windowManager.tinywm.enable = mkEnableOption "tinywm"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/twm.nix b/nixos/modules/services/x11/window-managers/twm.nix index 231817a26e667..fc09901aae3b0 100644 --- a/nixos/modules/services/x11/window-managers/twm.nix +++ b/nixos/modules/services/x11/window-managers/twm.nix @@ -13,7 +13,7 @@ in ###### interface options = { - services.xserver.windowManager.twm.enable = mkEnableOption (lib.mdDoc "twm"); + services.xserver.windowManager.twm.enable = mkEnableOption "twm"; }; diff --git a/nixos/modules/services/x11/window-managers/windowlab.nix b/nixos/modules/services/x11/window-managers/windowlab.nix index 9a0646b6ee7d3..fb891a39fa412 100644 --- a/nixos/modules/services/x11/window-managers/windowlab.nix +++ b/nixos/modules/services/x11/window-managers/windowlab.nix @@ -7,7 +7,7 @@ in { options = { services.xserver.windowManager.windowlab.enable = - lib.mkEnableOption (lib.mdDoc "windowlab"); + lib.mkEnableOption "windowlab"; }; config = lib.mkIf cfg.enable { diff --git a/nixos/modules/services/x11/window-managers/windowmaker.nix b/nixos/modules/services/x11/window-managers/windowmaker.nix index a679e2b5bc80d..b62723758056e 100644 --- a/nixos/modules/services/x11/window-managers/windowmaker.nix +++ b/nixos/modules/services/x11/window-managers/windowmaker.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.windowmaker.enable = mkEnableOption (lib.mdDoc "windowmaker"); + services.xserver.windowManager.windowmaker.enable = mkEnableOption "windowmaker"; }; ###### implementation diff --git a/nixos/modules/services/x11/window-managers/wmderland.nix b/nixos/modules/services/x11/window-managers/wmderland.nix index ed515741f62e8..56b6922096517 100644 --- a/nixos/modules/services/x11/window-managers/wmderland.nix +++ b/nixos/modules/services/x11/window-managers/wmderland.nix @@ -8,12 +8,12 @@ in { options.services.xserver.windowManager.wmderland = { - enable = mkEnableOption (lib.mdDoc "wmderland"); + enable = mkEnableOption "wmderland"; extraSessionCommands = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands executed just before wmderland is started. ''; }; @@ -38,7 +38,7 @@ in rxvt-unicode ] ''; - description = lib.mdDoc '' + description = '' Extra packages to be installed system wide. ''; }; diff --git a/nixos/modules/services/x11/window-managers/wmii.nix b/nixos/modules/services/x11/window-managers/wmii.nix index 090aa31610ab6..9b50a99bf23f1 100644 --- a/nixos/modules/services/x11/window-managers/wmii.nix +++ b/nixos/modules/services/x11/window-managers/wmii.nix @@ -7,7 +7,7 @@ let in { options = { - services.xserver.windowManager.wmii.enable = mkEnableOption (lib.mdDoc "wmii"); + services.xserver.windowManager.wmii.enable = mkEnableOption "wmii"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/x11/window-managers/xmonad.nix b/nixos/modules/services/x11/window-managers/xmonad.nix index 2962f2851fa91..7feb3a0b520fa 100644 --- a/nixos/modules/services/x11/window-managers/xmonad.nix +++ b/nixos/modules/services/x11/window-managers/xmonad.nix @@ -41,14 +41,14 @@ in { options = { services.xserver.windowManager.xmonad = { - enable = mkEnableOption (lib.mdDoc "xmonad"); + enable = mkEnableOption "xmonad"; haskellPackages = mkOption { default = pkgs.haskellPackages; defaultText = literalExpression "pkgs.haskellPackages"; example = literalExpression "pkgs.haskell.packages.ghc810"; type = types.attrs; - description = lib.mdDoc '' + description = '' 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 @@ -66,7 +66,7 @@ in { haskellPackages.monad-logger ] ''; - description = lib.mdDoc '' + description = '' 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. @@ -76,13 +76,13 @@ in { enableContribAndExtras = mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc "Enable xmonad-{contrib,extras} in Xmonad."; + description = "Enable xmonad-{contrib,extras} in Xmonad."; }; config = mkOption { default = null; type = with lib.types; nullOr (either path str); - description = lib.mdDoc '' + description = '' 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. @@ -162,7 +162,7 @@ in { enableConfiguredRecompile = mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc '' + description = '' 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. @@ -172,7 +172,7 @@ in { xmonadCliArgs = mkOption { default = []; type = with lib.types; listOf str; - description = lib.mdDoc '' + description = '' Command line arguments passed to the xmonad binary. ''; }; @@ -180,7 +180,7 @@ in { ghcArgs = mkOption { default = []; type = with lib.types; listOf str; - description = lib.mdDoc '' + description = '' Command line arguments passed to the compiler (ghc) invocation when xmonad.config is set. ''; diff --git a/nixos/modules/services/x11/window-managers/yeahwm.nix b/nixos/modules/services/x11/window-managers/yeahwm.nix index 9b40cecace269..351bd7dfe48b4 100644 --- a/nixos/modules/services/x11/window-managers/yeahwm.nix +++ b/nixos/modules/services/x11/window-managers/yeahwm.nix @@ -8,7 +8,7 @@ in { ###### interface options = { - services.xserver.windowManager.yeahwm.enable = mkEnableOption (lib.mdDoc "yeahwm"); + services.xserver.windowManager.yeahwm.enable = mkEnableOption "yeahwm"; }; ###### implementation diff --git a/nixos/modules/services/x11/xautolock.nix b/nixos/modules/services/x11/xautolock.nix index 5b8b748a086bf..04f3821e7508c 100644 --- a/nixos/modules/services/x11/xautolock.nix +++ b/nixos/modules/services/x11/xautolock.nix @@ -8,9 +8,9 @@ in { options = { services.xserver.xautolock = { - enable = mkEnableOption (lib.mdDoc "xautolock"); - enableNotifier = mkEnableOption (lib.mdDoc "xautolock.notify") // { - description = lib.mdDoc '' + enable = mkEnableOption "xautolock"; + enableNotifier = mkEnableOption "xautolock.notify" // { + description = '' Whether to enable the notifier feature of xautolock. This publishes a notification before the autolock. ''; @@ -20,7 +20,7 @@ in default = 15; type = types.int; - description = lib.mdDoc '' + description = '' Idle time (in minutes) to wait until xautolock locks the computer. ''; }; @@ -31,7 +31,7 @@ in example = literalExpression ''"''${pkgs.i3lock}/bin/i3lock -i /path/to/img"''; type = types.str; - description = lib.mdDoc '' + description = '' The script to use when automatically locking the computer. ''; }; @@ -41,7 +41,7 @@ in example = literalExpression ''"''${pkgs.i3lock}/bin/i3lock -i /path/to/img"''; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' The script to use when manually locking the computer with {command}`xautolock -locknow`. ''; }; @@ -50,7 +50,7 @@ in default = 10; type = types.int; - description = lib.mdDoc '' + description = '' Time (in seconds) before the actual lock when the notification about the pending lock should be published. ''; }; @@ -60,7 +60,7 @@ in example = literalExpression ''"''${pkgs.libnotify}/bin/notify-send 'Locking in 10 seconds'"''; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' Notification script to be used to warn about the pending autolock. ''; }; @@ -70,7 +70,7 @@ in example = "/run/current-system/systemd/bin/systemctl suspend"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' The script to use when nothing has happened for as long as {option}`killtime` ''; }; @@ -79,7 +79,7 @@ in default = 20; # default according to `man xautolock` type = types.int; - description = lib.mdDoc '' + description = '' Minutes xautolock waits until it executes the script specified in {option}`killer` (Has to be at least 10 minutes) ''; @@ -89,7 +89,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "-detectsleep" ]; - description = lib.mdDoc '' + description = '' Additional command-line arguments to pass to {command}`xautolock`. ''; diff --git a/nixos/modules/services/x11/xbanish.nix b/nixos/modules/services/x11/xbanish.nix index de893fae75a1f..b95fac68f1658 100644 --- a/nixos/modules/services/x11/xbanish.nix +++ b/nixos/modules/services/x11/xbanish.nix @@ -7,10 +7,10 @@ let cfg = config.services.xbanish; in { options.services.xbanish = { - enable = mkEnableOption (lib.mdDoc "xbanish"); + enable = mkEnableOption "xbanish"; arguments = mkOption { - description = lib.mdDoc "Arguments to pass to xbanish command"; + description = "Arguments to pass to xbanish command"; default = ""; example = "-d -i shift"; type = types.str; diff --git a/nixos/modules/services/x11/xfs.nix b/nixos/modules/services/x11/xfs.nix index 591bf461496e9..ea7cfa1aa43c5 100644 --- a/nixos/modules/services/x11/xfs.nix +++ b/nixos/modules/services/x11/xfs.nix @@ -19,7 +19,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whether to enable the X Font Server."; + description = "Whether to enable the X Font Server."; }; }; diff --git a/nixos/modules/services/x11/xserver.nix b/nixos/modules/services/x11/xserver.nix index b9d39aa2b2ef2..e13c273746701 100644 --- a/nixos/modules/services/x11/xserver.nix +++ b/nixos/modules/services/x11/xserver.nix @@ -37,7 +37,7 @@ let output = mkOption { type = types.str; example = "DVI-0"; - description = lib.mdDoc '' + description = '' The output name of the monitor, as shown by {manpage}`xrandr(1)` invoked without arguments. ''; @@ -46,7 +46,7 @@ let primary = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether this head is treated as the primary monitor, ''; }; @@ -58,7 +58,7 @@ let DisplaySize 408 306 Option "DPMS" "false" ''; - description = lib.mdDoc '' + description = '' Extra lines to append to the `Monitor` section verbatim. Available options are documented in the MONITOR section in {manpage}`xorg.conf(5)`. @@ -210,7 +210,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable the X server. ''; }; @@ -218,7 +218,7 @@ in autorun = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to start the X server automatically. ''; }; @@ -227,13 +227,13 @@ in default = []; example = literalExpression "[ pkgs.xterm ]"; type = types.listOf types.package; - description = lib.mdDoc "Which X11 packages to exclude from the default environment"; + description = "Which X11 packages to exclude from the default environment"; }; exportConfiguration = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to symlink the X server configuration under {file}`/etc/X11/xorg.conf`. ''; @@ -242,7 +242,7 @@ in enableTCP = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to allow the X server to accept TCP connections. ''; }; @@ -250,7 +250,7 @@ in autoRepeatDelay = mkOption { type = types.nullOr types.int; default = null; - description = lib.mdDoc '' + description = '' Sets the autorepeat delay (length of time in milliseconds that a key must be depressed before autorepeat starts). ''; }; @@ -258,7 +258,7 @@ in autoRepeatInterval = mkOption { type = types.nullOr types.int; default = null; - description = lib.mdDoc '' + description = '' Sets the autorepeat interval (length of time in milliseconds that should elapse between autorepeat-generated keystrokes). ''; }; @@ -276,21 +276,21 @@ in ''' ] ''; - description = lib.mdDoc "Content of additional InputClass sections of the X server configuration file."; + description = "Content of additional InputClass sections of the X server configuration file."; }; modules = mkOption { type = types.listOf types.path; default = []; example = literalExpression "[ pkgs.xf86_input_wacom ]"; - description = lib.mdDoc "Packages to be added to the module search path of the X server."; + description = "Packages to be added to the module search path of the X server."; }; resolutions = mkOption { type = types.listOf types.attrs; default = []; example = [ { x = 1600; y = 1200; } { x = 1024; y = 786; } ]; - description = lib.mdDoc '' + description = '' 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. @@ -311,7 +311,7 @@ in path = [ "xorg" n ]; title = removePrefix "xf86video" n; }) pkgs.xorg); - description = lib.mdDoc '' + description = '' The names of the video drivers the configuration supports. They will be tried in order until one that supports your card is found. @@ -327,7 +327,7 @@ in type = types.nullOr types.str; default = null; example = "i810"; - description = lib.mdDoc '' + description = '' The name of the video driver for your graphics card. This option is obsolete; please set the {option}`services.xserver.videoDrivers` instead. @@ -337,7 +337,7 @@ in drivers = mkOption { type = types.listOf types.attrs; internal = true; - description = lib.mdDoc '' + description = '' A list of attribute sets specifying drivers to be loaded by the X11 server. ''; @@ -346,7 +346,7 @@ in dpi = mkOption { type = types.nullOr types.int; default = null; - description = lib.mdDoc '' + description = '' 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. @@ -356,7 +356,7 @@ in updateDbusEnvironment = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to update the DBus activation environment after launching the desktop manager. ''; @@ -366,7 +366,7 @@ in layout = mkOption { type = types.str; default = "us"; - description = lib.mdDoc '' + description = '' X keyboard layout, or multiple keyboard layouts separated by commas. ''; }; @@ -375,7 +375,7 @@ in type = types.str; default = "pc104"; example = "presario"; - description = lib.mdDoc '' + description = '' X keyboard model. ''; }; @@ -384,7 +384,7 @@ in type = types.commas; default = "terminate:ctrl_alt_bksp"; example = "grp:caps_toggle,grp_led:scroll"; - description = lib.mdDoc '' + description = '' X keyboard options; layout switching goes here. ''; }; @@ -393,7 +393,7 @@ in type = types.str; default = ""; example = "colemak"; - description = lib.mdDoc '' + description = '' X keyboard variant. ''; }; @@ -402,7 +402,7 @@ in type = types.path; default = "${pkgs.xkeyboard_config}/etc/X11/xkb"; defaultText = literalExpression ''"''${pkgs.xkeyboard_config}/etc/X11/xkb"''; - description = lib.mdDoc '' + description = '' Path used for -xkbdir xserver parameter. ''; }; @@ -410,7 +410,7 @@ in config = mkOption { type = types.lines; - description = lib.mdDoc '' + description = '' The contents of the configuration file of the X server ({file}`xorg.conf`). @@ -427,14 +427,14 @@ in type = types.lines; default = ""; example = ''FontPath "/path/to/my/fonts"''; - description = lib.mdDoc "Contents of the first `Files` section of the X server configuration file."; + description = "Contents of the first `Files` section of the X server configuration file."; }; deviceSection = mkOption { type = types.lines; default = ""; example = "VideoRAM 131072"; - description = lib.mdDoc "Contents of the first Device section of the X server configuration file."; + description = "Contents of the first Device section of the X server configuration file."; }; screenSection = mkOption { @@ -443,20 +443,20 @@ in example = '' Option "RandRRotation" "on" ''; - description = lib.mdDoc "Contents of the first Screen section of the X server configuration file."; + description = "Contents of the first Screen section of the X server configuration file."; }; monitorSection = mkOption { type = types.lines; default = ""; example = "HorizSync 28-49"; - description = lib.mdDoc "Contents of the first Monitor section of the X server configuration file."; + description = "Contents of the first Monitor section of the X server configuration file."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc "Additional contents (sections) included in the X server configuration file"; + description = "Additional contents (sections) included in the X server configuration file"; }; xrandrHeads = mkOption { @@ -476,7 +476,7 @@ in firstPrimary = head heads // { primary = true; }; newHeads = singleton firstPrimary ++ tail heads; in if heads != [] && !hasPrimary then newHeads else heads; - description = lib.mdDoc '' + description = '' 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. @@ -512,7 +512,7 @@ in Option "SuspendTime" "0" Option "OffTime" "0" ''; - description = lib.mdDoc "Contents of the ServerFlags section of the X server configuration file."; + description = "Contents of the ServerFlags section of the X server configuration file."; }; moduleSection = mkOption { @@ -523,7 +523,7 @@ in SubSection "extmod" EndSubsection ''; - description = lib.mdDoc "Contents of the Module section of the X server configuration file."; + description = "Contents of the Module section of the X server configuration file."; }; serverLayoutSection = mkOption { @@ -533,28 +533,28 @@ in '' Option "AIGLX" "true" ''; - description = lib.mdDoc "Contents of the ServerLayout section of the X server configuration file."; + description = "Contents of the ServerLayout section of the X server configuration file."; }; extraDisplaySettings = mkOption { type = types.lines; default = ""; example = "Virtual 2048 2048"; - description = lib.mdDoc "Lines to be added to every Display subsection of the Screen section."; + description = "Lines to be added to every Display subsection of the Screen section."; }; defaultDepth = mkOption { type = types.int; default = 0; example = 8; - description = lib.mdDoc "Default colour depth."; + description = "Default colour depth."; }; fontPath = mkOption { type = types.nullOr types.str; default = null; example = "unix/:7100"; - description = lib.mdDoc '' + description = '' Set the X server FontPath. Defaults to null, which means the compiled in defaults will be used. See man xorg.conf for details. @@ -564,20 +564,20 @@ in tty = mkOption { type = types.nullOr types.int; default = 7; - description = lib.mdDoc "Virtual console for the X server."; + description = "Virtual console for the X server."; }; display = mkOption { type = types.nullOr types.int; default = 0; - description = lib.mdDoc "Display number for the X server."; + description = "Display number for the X server."; }; virtualScreen = mkOption { type = types.nullOr types.attrs; default = null; example = { x = 2048; y = 2048; }; - description = lib.mdDoc '' + description = '' Virtual screen size for Xrandr. ''; }; @@ -586,7 +586,7 @@ in type = types.nullOr types.str; default = "/dev/null"; example = "/var/log/Xorg.0.log"; - description = lib.mdDoc '' + description = '' 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. @@ -599,7 +599,7 @@ in type = types.nullOr types.int; default = 3; example = 7; - description = lib.mdDoc '' + description = '' Controls verbosity of X logging. ''; }; @@ -607,7 +607,7 @@ in enableCtrlAltBackspace = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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. @@ -617,7 +617,7 @@ in terminateOnReset = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to terminate X upon server reset. ''; }; @@ -625,7 +625,7 @@ in upscaleDefaultCursor = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Upscale the default X cursor to be more visible on high-density displays. Requires `config.services.xserver.dpi` to be set. ''; |