diff options
Diffstat (limited to 'nixos/modules/services/x11/xserver.nix')
| -rw-r--r-- | nixos/modules/services/x11/xserver.nix | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/nixos/modules/services/x11/xserver.nix b/nixos/modules/services/x11/xserver.nix index efe1a13fd5da5..dc48f3ac030ab 100644 --- a/nixos/modules/services/x11/xserver.nix +++ b/nixos/modules/services/x11/xserver.nix @@ -37,16 +37,16 @@ let output = mkOption { type = types.str; example = "DVI-0"; - description = '' + description = lib.mdDoc '' The output name of the monitor, as shown by - <citerefentry><refentrytitle>xrandr</refentrytitle><manvolnum>1</manvolnum></citerefentry> invoked without arguments. + {manpage}`xrandr(1)` invoked without arguments. ''; }; primary = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this head is treated as the primary monitor, ''; }; @@ -58,10 +58,10 @@ let DisplaySize 408 306 Option "DPMS" "false" ''; - description = '' - Extra lines to append to the <literal>Monitor</literal> section + description = lib.mdDoc '' + Extra lines to append to the `Monitor` section verbatim. Available options are documented in the MONITOR section in - <citerefentry><refentrytitle>xorg.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + {manpage}`xorg.conf(5)`. ''; }; }; @@ -165,7 +165,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the X server. ''; }; @@ -173,7 +173,7 @@ in autorun = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to start the X server automatically. ''; }; @@ -182,22 +182,22 @@ in default = []; example = literalExpression "[ pkgs.xterm ]"; type = types.listOf types.package; - description = "Which X11 packages to exclude from the default environment"; + description = lib.mdDoc "Which X11 packages to exclude from the default environment"; }; exportConfiguration = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to symlink the X server configuration under - <filename>/etc/X11/xorg.conf</filename>. + {file}`/etc/X11/xorg.conf`. ''; }; enableTCP = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to allow the X server to accept TCP connections. ''; }; @@ -205,7 +205,7 @@ in autoRepeatDelay = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Sets the autorepeat delay (length of time in milliseconds that a key must be depressed before autorepeat starts). ''; }; @@ -213,7 +213,7 @@ in autoRepeatInterval = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Sets the autorepeat interval (length of time in milliseconds that should elapse between autorepeat-generated keystrokes). ''; }; @@ -231,21 +231,21 @@ in ''' ] ''; - description = "Content of additional InputClass sections of the X server configuration file."; + description = lib.mdDoc "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 = "Packages to be added to the module search path of the X server."; + description = lib.mdDoc "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 = '' + description = lib.mdDoc '' 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. @@ -266,7 +266,7 @@ in path = [ "xorg" n ]; title = removePrefix "xf86video" n; }) pkgs.xorg); - description = '' + description = lib.mdDoc '' The names of the video drivers the configuration supports. They will be tried in order until one that supports your card is found. @@ -282,10 +282,10 @@ in type = types.nullOr types.str; default = null; example = "i810"; - description = '' + description = lib.mdDoc '' The name of the video driver for your graphics card. This option is obsolete; please set the - <option>services.xserver.videoDrivers</option> instead. + {option}`services.xserver.videoDrivers` instead. ''; }; @@ -301,17 +301,17 @@ in dpi = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Force global DPI resolution to use for X server. It's recommended to use this only when DPI is detected incorrectly; also consider using - <literal>Monitor</literal> section in configuration file instead. + `Monitor` section in configuration file instead. ''; }; updateDbusEnvironment = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to update the DBus activation environment after launching the desktop manager. ''; @@ -320,7 +320,7 @@ in layout = mkOption { type = types.str; default = "us"; - description = '' + description = lib.mdDoc '' Keyboard layout, or multiple keyboard layouts separated by commas. ''; }; @@ -329,7 +329,7 @@ in type = types.str; default = "pc104"; example = "presario"; - description = '' + description = lib.mdDoc '' Keyboard model. ''; }; @@ -338,7 +338,7 @@ in type = types.commas; default = "terminate:ctrl_alt_bksp"; example = "grp:caps_toggle,grp_led:scroll"; - description = '' + description = lib.mdDoc '' X keyboard options; layout switching goes here. ''; }; @@ -347,7 +347,7 @@ in type = types.str; default = ""; example = "colemak"; - description = '' + description = lib.mdDoc '' X keyboard variant. ''; }; @@ -356,22 +356,22 @@ in type = types.path; default = "${pkgs.xkeyboard_config}/etc/X11/xkb"; defaultText = literalExpression ''"''${pkgs.xkeyboard_config}/etc/X11/xkb"''; - description = '' + description = lib.mdDoc '' Path used for -xkbdir xserver parameter. ''; }; config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' The contents of the configuration file of the X server - (<filename>xorg.conf</filename>). + ({file}`xorg.conf`). This option is set by multiple modules, and the configs are concatenated together. In Xorg configs the last config entries take precedence, - so you may want to use <literal>lib.mkAfter</literal> on this option + so you may want to use `lib.mkAfter` on this option to override NixOS's defaults. ''; }; @@ -380,14 +380,14 @@ in type = types.lines; default = ""; example = ''FontPath "/path/to/my/fonts"''; - description = "Contents of the first <literal>Files</literal> section of the X server configuration file."; + description = lib.mdDoc "Contents of the first `Files` section of the X server configuration file."; }; deviceSection = mkOption { type = types.lines; default = ""; example = "VideoRAM 131072"; - description = "Contents of the first Device section of the X server configuration file."; + description = lib.mdDoc "Contents of the first Device section of the X server configuration file."; }; screenSection = mkOption { @@ -396,20 +396,20 @@ in example = '' Option "RandRRotation" "on" ''; - description = "Contents of the first Screen section of the X server configuration file."; + description = lib.mdDoc "Contents of the first Screen section of the X server configuration file."; }; monitorSection = mkOption { type = types.lines; default = ""; example = "HorizSync 28-49"; - description = "Contents of the first Monitor section of the X server configuration file."; + description = lib.mdDoc "Contents of the first Monitor section of the X server configuration file."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Additional contents (sections) included in the X server configuration file"; + description = lib.mdDoc "Additional contents (sections) included in the X server configuration file"; }; xrandrHeads = mkOption { @@ -463,7 +463,7 @@ in Option "SuspendTime" "0" Option "OffTime" "0" ''; - description = "Contents of the ServerFlags section of the X server configuration file."; + description = lib.mdDoc "Contents of the ServerFlags section of the X server configuration file."; }; moduleSection = mkOption { @@ -474,7 +474,7 @@ in SubSection "extmod" EndSubsection ''; - description = "Contents of the Module section of the X server configuration file."; + description = lib.mdDoc "Contents of the Module section of the X server configuration file."; }; serverLayoutSection = mkOption { @@ -484,28 +484,28 @@ in '' Option "AIGLX" "true" ''; - description = "Contents of the ServerLayout section of the X server configuration file."; + description = lib.mdDoc "Contents of the ServerLayout section of the X server configuration file."; }; extraDisplaySettings = mkOption { type = types.lines; default = ""; example = "Virtual 2048 2048"; - description = "Lines to be added to every Display subsection of the Screen section."; + description = lib.mdDoc "Lines to be added to every Display subsection of the Screen section."; }; defaultDepth = mkOption { type = types.int; default = 0; example = 8; - description = "Default colour depth."; + description = lib.mdDoc "Default colour depth."; }; fontPath = mkOption { type = types.nullOr types.str; default = null; example = "unix/:7100"; - description = '' + description = lib.mdDoc '' Set the X server FontPath. Defaults to null, which means the compiled in defaults will be used. See man xorg.conf for details. @@ -515,20 +515,20 @@ in tty = mkOption { type = types.nullOr types.int; default = 7; - description = "Virtual console for the X server."; + description = lib.mdDoc "Virtual console for the X server."; }; display = mkOption { type = types.nullOr types.int; default = 0; - description = "Display number for the X server."; + description = lib.mdDoc "Display number for the X server."; }; virtualScreen = mkOption { type = types.nullOr types.attrs; default = null; example = { x = 2048; y = 2048; }; - description = '' + description = lib.mdDoc '' Virtual screen size for Xrandr. ''; }; @@ -537,12 +537,12 @@ in type = types.nullOr types.str; default = "/dev/null"; example = "/var/log/Xorg.0.log"; - description = '' + description = lib.mdDoc '' Controls the file Xorg logs to. - The default of <literal>/dev/null</literal> is set so that systemd services (like <literal>displayManagers</literal>) only log to the journal and don't create their own log files. + The default of `/dev/null` is set so that systemd services (like `displayManagers`) only log to the journal and don't create their own log files. - Setting this to <literal>null</literal> will not pass the <literal>-logfile</literal> argument to Xorg which allows it to log to its default logfile locations instead (see <literal>man Xorg</literal>). You probably only want this behaviour when running Xorg manually (e.g. via <literal>startx</literal>). + Setting this to `null` will not pass the `-logfile` argument to Xorg which allows it to log to its default logfile locations instead (see `man Xorg`). You probably only want this behaviour when running Xorg manually (e.g. via `startx`). ''; }; @@ -550,7 +550,7 @@ in type = types.nullOr types.int; default = 3; example = 7; - description = '' + description = lib.mdDoc '' Controls verbosity of X logging. ''; }; @@ -558,7 +558,7 @@ in useGlamor = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use the Glamor module for 2D acceleration, if possible. ''; @@ -567,7 +567,7 @@ in enableCtrlAltBackspace = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' 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. @@ -577,7 +577,7 @@ in terminateOnReset = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to terminate X upon server reset. ''; }; |