movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 13:40:28 +03:00
Code Activity

nixos: remove all uses of lib.mdDoc

Browse source 
these changes were generated with nixq 0.0.2, by running

  nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix

two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.

Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
This commit is contained in:
stuebinm 2024-04-13 14:54:15 +02:00 • committed by Jonathan Ringer
parent 1dd996e59a
commit 6afb255d97
1701 changed files with 13694 additions and 13865 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/programs/_1password-gui.nix
View file

@ -16,13 +16,13 @@ in
options = {
programs._1password-gui = {
enable = mkEnableOption (lib.mdDoc "the 1Password GUI application");
enable = mkEnableOption "the 1Password GUI application";
polkitPolicyOwners = mkOption {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''["user1" "user2" "user3"]'';
description = lib.mdDoc ''
description = ''
A list of users who should be able to integrate 1Password with polkit-based authentication mechanisms.
'';
};

2
nixos/modules/programs/_1password.nix
View file

@ -16,7 +16,7 @@ in
options = {
programs._1password = {
enable = mkEnableOption (lib.mdDoc "the 1Password CLI tool");
enable = mkEnableOption "the 1Password CLI tool";
package = mkPackageOption pkgs "1Password CLI" {
default = [ "_1password" ];

2
nixos/modules/programs/adb.nix
View file

@ -11,7 +11,7 @@ with lib;
enable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Whether to configure system to use Android Debug Bridge (adb).
To grant access to a user, it must be part of adbusers group:
`users.users.alice.extraGroups = ["adbusers"];`

4
nixos/modules/programs/alvr.nix
View file

@ -8,14 +8,14 @@ in
{
options = {
programs.alvr = {
enable = mkEnableOption (lib.mdDoc "ALVR, the VR desktop streamer");
enable = mkEnableOption "ALVR, the VR desktop streamer";
package = mkPackageOption pkgs "alvr" { };
openFirewall = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to open the default ports in the firewall for the ALVR server.
'';
};

2
nixos/modules/programs/appgate-sdp.nix
View file

@ -5,7 +5,7 @@ with lib;
{
options = {
programs.appgate-sdp = {
enable = mkEnableOption (lib.mdDoc "the AppGate SDP VPN client");
enable = mkEnableOption "the AppGate SDP VPN client";
};
};

18
nixos/modules/programs/atop.nix
View file

@ -14,7 +14,7 @@ in
programs.atop = rec {
enable = mkEnableOption (lib.mdDoc "Atop, a tool for monitoring system resources");
enable = mkEnableOption "Atop, a tool for monitoring system resources";
package = mkPackageOption pkgs "atop" { };
@ -22,7 +22,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to install and enable the netatop kernel module.
Note: this sets the kernel taint flag "O" for loading out-of-tree modules.
'';
@ -31,7 +31,7 @@ in
type = types.package;
default = config.boot.kernelPackages.netatop;
defaultText = literalExpression "config.boot.kernelPackages.netatop";
description = lib.mdDoc ''
description = ''
Which package to use for netatop.
'';
};
@ -40,7 +40,7 @@ in
atopgpu.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to install and enable the atopgpud daemon to get information about
NVIDIA gpus.
'';
@ -49,7 +49,7 @@ in
setuidWrapper.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to install a setuid wrapper for Atop. This is required to use some of
the features as non-root user (e.g.: ipc information, netatop, atopgpu).
Atop tries to drop the root privileges shortly after starting.
@ -59,7 +59,7 @@ in
atopService.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable the atop service responsible for storing statistics for
long-term analysis.
'';
@ -67,7 +67,7 @@ in
atopRotateTimer.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable the atop-rotate timer, which restarts the atop service
daily to make sure the data files are rotate.
'';
@ -75,7 +75,7 @@ in
atopacctService.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable the atopacct service which manages process accounting.
This allows Atop to gather data about processes that disappeared in between
two refresh intervals.
@ -88,7 +88,7 @@ in
flags = "a1f";
interval = 5;
};
description = lib.mdDoc ''
description = ''
Parameters to be written to {file}`/etc/atoprc`.
'';
};

4
nixos/modules/programs/ausweisapp.nix
View file

@ -7,10 +7,10 @@ let
in
{
options.programs.ausweisapp = {
enable = mkEnableOption (lib.mdDoc "AusweisApp");
enable = mkEnableOption "AusweisApp";
openFirewall = mkOption {
description = lib.mdDoc ''
description = ''
Whether to open the required firewall ports for the Smartphone as Card Reader (SaC) functionality of AusweisApp.
'';
default = false;

2
nixos/modules/programs/autojump.nix
View file

@ -13,7 +13,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable autojump.
'';
};

2
nixos/modules/programs/bandwhich.nix
View file

@ -11,7 +11,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to add bandwhich to the global environment and configure a
setcap wrapper for it.
'';

2
nixos/modules/programs/bash-my-aws.nix
View file

@ -13,7 +13,7 @@ in
{
options = {
programs.bash-my-aws = {
enable = mkEnableOption (lib.mdDoc "bash-my-aws");
enable = mkEnableOption "bash-my-aws";
};
};

2
nixos/modules/programs/bash/bash-completion.nix
View file

@ -7,7 +7,7 @@ let
in
{
options = {
programs.bash.enableCompletion = mkEnableOption (lib.mdDoc "Bash completion for all interactive bash shells") // {
programs.bash.enableCompletion = mkEnableOption "Bash completion for all interactive bash shells" // {
default = true;
};
};

12
nixos/modules/programs/bash/bash.nix
View file

@ -44,7 +44,7 @@ in
shellAliases = mkOption {
default = {};
description = lib.mdDoc ''
description = ''
Set of aliases for bash shell, which overrides {option}`environment.shellAliases`.
See {option}`environment.shellAliases` for an option format description.
'';
@ -53,7 +53,7 @@ in
shellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during bash shell initialisation.
'';
type = types.lines;
@ -61,7 +61,7 @@ in
loginShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during login bash shell initialisation.
'';
type = types.lines;
@ -69,7 +69,7 @@ in
interactiveShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during interactive bash shell initialisation.
'';
type = types.lines;
@ -92,7 +92,7 @@ in
fi
fi
'';
description = lib.mdDoc ''
description = ''
Shell script code used to initialise the bash prompt.
'';
type = types.lines;
@ -100,7 +100,7 @@ in
promptPluginInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code used to initialise bash prompt plugins.
'';
type = types.lines;

2
nixos/modules/programs/bash/blesh.nix
View file

@ -4,7 +4,7 @@ let
cfg = config.programs.bash.blesh;
in {
options = {
programs.bash.blesh.enable = mkEnableOption (mdDoc "blesh, a full-featured line editor written in pure Bash");
programs.bash.blesh.enable = mkEnableOption "blesh, a full-featured line editor written in pure Bash";
};
config = mkIf cfg.enable {

2
nixos/modules/programs/bash/ls-colors.nix
View file

@ -7,7 +7,7 @@ let
in
{
options = {
programs.bash.enableLsColors = mkEnableOption (lib.mdDoc "extra colors in directory listings") // {
programs.bash.enableLsColors = mkEnableOption "extra colors in directory listings" // {
default = true;
};
};

6
nixos/modules/programs/bash/undistract-me.nix
View file

@ -8,13 +8,13 @@ in
{
options = {
programs.bash.undistractMe = {
enable = mkEnableOption (lib.mdDoc "notifications when long-running terminal commands complete");
enable = mkEnableOption "notifications when long-running terminal commands complete";
playSound = mkEnableOption (lib.mdDoc "notification sounds when long-running terminal commands complete");
playSound = mkEnableOption "notification sounds when long-running terminal commands complete";
timeout = mkOption {
default = 10;
description = lib.mdDoc ''
description = ''
Number of seconds it would take for a command to be considered long-running.
'';
type = types.int;

2
nixos/modules/programs/bcc.nix
View file

@ -1,6 +1,6 @@
{ config, pkgs, lib, ... }:
{
options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc, tools for BPF-based Linux IO analysis, networking, monitoring, and more");
options.programs.bcc.enable = lib.mkEnableOption "bcc, tools for BPF-based Linux IO analysis, networking, monitoring, and more";
config = lib.mkIf config.programs.bcc.enable {
environment.systemPackages = [ pkgs.bcc ];

2
nixos/modules/programs/browserpass.nix
View file

@ -4,7 +4,7 @@ with lib;
{
options.programs.browserpass.enable = mkEnableOption (lib.mdDoc "Browserpass native messaging host");
options.programs.browserpass.enable = mkEnableOption "Browserpass native messaging host";
config = mkIf config.programs.browserpass.enable {
environment.etc = let

4
nixos/modules/programs/calls.nix
View file

@ -7,9 +7,9 @@ let
in {
options = {
programs.calls = {
enable = mkEnableOption (lib.mdDoc ''
enable = mkEnableOption ''
GNOME calls: a phone dialer and call handler
'');
'';
};
};

12
nixos/modules/programs/captive-browser.nix
View file

@ -49,13 +49,13 @@ in
options = {
programs.captive-browser = {
enable = mkEnableOption (lib.mdDoc "captive browser, a dedicated Chrome instance to log into captive portals without messing with DNS settings");
enable = mkEnableOption "captive browser, a dedicated Chrome instance to log into captive portals without messing with DNS settings";
package = mkPackageOption pkgs "captive-browser" { };
interface = mkOption {
type = types.str;
description = lib.mdDoc "your public network interface (wlp3s0, wlan0, eth0, ...)";
description = "your public network interface (wlp3s0, wlan0, eth0, ...)";
};
# the options below are the same as in "captive-browser.toml"
@ -63,7 +63,7 @@ in
type = types.str;
default = browserDefault pkgs.chromium;
defaultText = literalExpression (browserDefault "\${pkgs.chromium}");
description = lib.mdDoc ''
description = ''
The shell (/bin/sh) command executed once the proxy starts.
When browser exits, the proxy exits. An extra env var PROXY is available.
@ -79,7 +79,7 @@ in
dhcp-dns = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The shell (/bin/sh) command executed to obtain the DHCP
DNS server address. The first match of an IPv4 regex is used.
IPv4 only, because let's be real, it's a captive portal.
@ -89,13 +89,13 @@ in
socks5-addr = mkOption {
type = types.str;
default = "localhost:1666";
description = lib.mdDoc "the listen address for the SOCKS5 proxy server";
description = "the listen address for the SOCKS5 proxy server";
};
bindInterface = mkOption {
default = true;
type = types.bool;
description = lib.mdDoc ''
description = ''
Binds `captive-browser` to the network interface declared in
`cfg.interface`. This can be used to avoid collisions
with private subnets.

10
nixos/modules/programs/ccache.nix
View file

@ -5,28 +5,28 @@ let
in {
options.programs.ccache = {
# host configuration
enable = lib.mkEnableOption (lib.mdDoc "CCache, a compiler cache for fast recompilation of C/C++ code");
enable = lib.mkEnableOption "CCache, a compiler cache for fast recompilation of C/C++ code";
cacheDir = lib.mkOption {
type = lib.types.path;
description = lib.mdDoc "CCache directory";
description = "CCache directory";
default = "/var/cache/ccache";
};
# target configuration
packageNames = lib.mkOption {
type = lib.types.listOf lib.types.str;
description = lib.mdDoc "Nix top-level packages to be compiled using CCache";
description = "Nix top-level packages to be compiled using CCache";
default = [];
example = [ "wxGTK32" "ffmpeg" "libav_all" ];
};
owner = lib.mkOption {
type = lib.types.str;
default = "root";
description = lib.mdDoc "Owner of CCache directory";
description = "Owner of CCache directory";
};
group = lib.mkOption {
type = lib.types.str;
default = "nixbld";
description = lib.mdDoc "Group owner of CCache directory";
description = "Group owner of CCache directory";
};
};

8
nixos/modules/programs/cdemu.nix
View file

@ -10,7 +10,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
{command}`cdemu` for members of
{option}`programs.cdemu.group`.
'';
@ -18,21 +18,21 @@ in {
group = mkOption {
type = types.str;
default = "cdrom";
description = lib.mdDoc ''
description = ''
Group that users must be in to use {command}`cdemu`.
'';
};
gui = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to install the {command}`cdemu` GUI (gCDEmu).
'';
};
image-analyzer = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to install the image analyzer.
'';
};

2
nixos/modules/programs/cfs-zen-tweaks.nix
View file

@ -17,7 +17,7 @@ in
};
options = {
programs.cfs-zen-tweaks.enable = mkEnableOption (lib.mdDoc "CFS Zen Tweaks");
programs.cfs-zen-tweaks.enable = mkEnableOption "CFS Zen Tweaks";
};
config = mkIf cfg.enable {

18
nixos/modules/programs/chromium.nix
View file

@ -19,15 +19,15 @@ in
options = {
programs.chromium = {
enable = mkEnableOption (lib.mdDoc "{command}`chromium` policies");
enable = mkEnableOption "{command}`chromium` policies";
enablePlasmaBrowserIntegration = mkEnableOption (lib.mdDoc "Native Messaging Host for Plasma Browser Integration");
enablePlasmaBrowserIntegration = mkEnableOption "Native Messaging Host for Plasma Browser Integration";
plasmaBrowserIntegrationPackage = mkPackageOption pkgs [ "plasma5Packages" "plasma-browser-integration" ] { };
extensions = mkOption {
type = with types; nullOr (listOf str);
description = lib.mdDoc ''
description = ''
List of chromium extensions to install.
For list of plugins ids see id in url of extensions on
[chrome web store](https://chrome.google.com/webstore/category/extensions)
@ -50,35 +50,35 @@ in
homepageLocation = mkOption {
type = types.nullOr types.str;
description = lib.mdDoc "Chromium default homepage";
description = "Chromium default homepage";
default = null;
example = "https://nixos.org";
};
defaultSearchProviderEnabled = mkOption {
type = types.nullOr types.bool;
description = lib.mdDoc "Enable the default search provider.";
description = "Enable the default search provider.";
default = null;
example = true;
};
defaultSearchProviderSearchURL = mkOption {
type = types.nullOr types.str;
description = lib.mdDoc "Chromium default search provider url.";
description = "Chromium default search provider url.";
default = null;
example = "https://encrypted.google.com/search?q={searchTerms}&{google:RLZ}{google:originalQueryForSuggestion}{google:assistedQueryStats}{google:searchFieldtrialParameter}{google:searchClient}{google:sourceId}{google:instantExtendedEnabledParameter}ie={inputEncoding}";
};
defaultSearchProviderSuggestURL = mkOption {
type = types.nullOr types.str;
description = lib.mdDoc "Chromium default search provider url for suggestions.";
description = "Chromium default search provider url for suggestions.";
default = null;
example = "https://encrypted.google.com/complete/search?output=chrome&q={searchTerms}";
};
extraOpts = mkOption {
type = types.attrs;
description = lib.mdDoc ''
description = ''
Extra chromium policy options. A list of available policies
can be found in the Chrome Enterprise documentation:
<https://cloud.google.com/docs/chrome-enterprise/policies/>
@ -101,7 +101,7 @@ in
initialPrefs = mkOption {
type = types.attrs;
description = lib.mdDoc ''
description = ''
Initial preferences are used to configure the browser for the first run.
Unlike {option}`programs.chromium.extraOpts`, initialPrefs can be changed by users in the browser settings.
More information can be found in the Chromium documentation:

6
nixos/modules/programs/clash-verge.nix
View file

@ -2,10 +2,10 @@
{
options.programs.clash-verge = {
enable = lib.mkEnableOption (lib.mdDoc "Clash Verge");
enable = lib.mkEnableOption "Clash Verge";
package = lib.mkPackageOption pkgs "clash-verge" {};
autoStart = lib.mkEnableOption (lib.mdDoc "Clash Verge auto launch");
tunMode = lib.mkEnableOption (lib.mdDoc "Clash Verge TUN mode");
autoStart = lib.mkEnableOption "Clash Verge auto launch";
tunMode = lib.mkEnableOption "Clash Verge TUN mode";
};
config =

2
nixos/modules/programs/cnping.nix
View file

@ -8,7 +8,7 @@ in
{
options = {
programs.cnping = {
enable = mkEnableOption (lib.mdDoc "a setcap wrapper for cnping");
enable = mkEnableOption "a setcap wrapper for cnping";
};
};

4
nixos/modules/programs/command-not-found/command-not-found.nix
View file

@ -26,7 +26,7 @@ in
enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether interactive shells should show which Nix package (if
any) provides a missing command.
'';
@ -34,7 +34,7 @@ in
dbPath = mkOption {
default = "/nix/var/nix/profiles/per-user/root/channels/nixos/programs.sqlite" ;
description = lib.mdDoc ''
description = ''
Absolute path to programs.sqlite.
By default this file will be provided by your channel

4
nixos/modules/programs/coolercontrol.nix
View file

@ -11,13 +11,13 @@ in
##### interface
options = {
programs.coolercontrol = {
enable = lib.mkEnableOption (lib.mdDoc "CoolerControl GUI & its background services");
enable = lib.mkEnableOption "CoolerControl GUI & its background services";
nvidiaSupport = lib.mkOption {
type = lib.types.bool;
default = lib.elem "nvidia" config.services.xserver.videoDrivers;
defaultText = lib.literalExpression "lib.elem \"nvidia\" config.services.xserver.videoDrivers";
description = lib.mdDoc ''
description = ''
Enable support for Nvidia GPUs.
'';
};

2
nixos/modules/programs/criu.nix
View file

@ -10,7 +10,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Install {command}`criu` along with necessary kernel options.
'';
};

2
nixos/modules/programs/darling.nix
View file

@ -5,7 +5,7 @@ let
in {
options = {
programs.darling = {
enable = lib.mkEnableOption (lib.mdDoc "Darling, a Darwin/macOS compatibility layer for Linux");
enable = lib.mkEnableOption "Darling, a Darwin/macOS compatibility layer for Linux";
package = lib.mkPackageOption pkgs "darling" {};
};
};

18
nixos/modules/programs/dconf.nix
View file

@ -93,12 +93,12 @@ let
keyfiles = lib.mkOption {
type = listOf (oneOf [ path package ]);
default = [ ];
description = lib.mdDoc "A list of dconf keyfile directories.";
description = "A list of dconf keyfile directories.";
};
settings = lib.mkOption {
type = attrs;
default = { };
description = lib.mdDoc "An attrset used to generate dconf keyfile.";
description = "An attrset used to generate dconf keyfile.";
example = literalExpression ''
with lib.gvariant;
{
@ -112,7 +112,7 @@ let
locks = lib.mkOption {
type = with lib.types; listOf str;
default = [ ];
description = lib.mdDoc ''
description = ''
A list of dconf keys to be lockdown. This doesn't take effect if `lockAll`
is set.
'';
@ -123,7 +123,7 @@ let
lockAll = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc "Lockdown all dconf keys in `settings`.";
description = "Lockdown all dconf keys in `settings`.";
};
};
};
@ -133,7 +133,7 @@ let
enableUserDb = lib.mkOption {
type = bool;
default = true;
description = lib.mdDoc "Add `user-db:user` at the beginning of the profile.";
description = "Add `user-db:user` at the beginning of the profile.";
};
databases = lib.mkOption {
@ -143,7 +143,7 @@ let
dconfDatabase
]);
default = [ ];
description = lib.mdDoc ''
description = ''
List of data sources for the profile. An element can be an attrset,
or the path of an already compiled database. Each element is converted
to a file-db.
@ -161,7 +161,7 @@ in
{
options = {
programs.dconf = {
enable = lib.mkEnableOption (lib.mdDoc "dconf");
enable = lib.mkEnableOption "dconf";
profiles = lib.mkOption {
type = with lib.types; attrsOf (oneOf [
@ -170,7 +170,7 @@ in
dconfProfile
]);
default = { };
description = lib.mdDoc ''
description = ''
Attrset of dconf profiles. By default the `user` profile is used which
ends up in `/etc/dconf/profile/user`.
'';
@ -193,7 +193,7 @@ in
packages = lib.mkOption {
type = lib.types.listOf lib.types.package;
default = [ ];
description = lib.mdDoc "A list of packages which provide dconf profiles and databases in {file}`/etc/dconf`.";
description = "A list of packages which provide dconf profiles and databases in {file}`/etc/dconf`.";
};
};
};

2
nixos/modules/programs/digitalbitbox/default.nix
View file

@ -11,7 +11,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Installs the Digital Bitbox application and enables the complementary hardware module.
'';
};

20
nixos/modules/programs/direnv.nix
View file

@ -8,11 +8,11 @@
in {
options.programs.direnv = {
enable = lib.mkEnableOption (lib.mdDoc ''
enable = lib.mkEnableOption ''
direnv integration. Takes care of both installation and
setting up the sourcing of the shell. Additionally enables nix-direnv
integration. Note that you need to logout and login for this change to apply
'');
'';
package = lib.mkPackageOption pkgs "direnv" {};
@ -23,28 +23,28 @@ in {
export FOO="foo"
echo "loaded direnv!"
'';
description = lib.mdDoc ''
description = ''
Extra lines to append to the sourced direnvrc
'';
};
silent = lib.mkEnableOption (lib.mdDoc ''
silent = lib.mkEnableOption ''
the hiding of direnv logging
'');
'';
loadInNixShell =
lib.mkEnableOption (lib.mdDoc ''
lib.mkEnableOption ''
loading direnv in `nix-shell` `nix shell` or `nix develop`
'')
''
// {
default = true;
};
nix-direnv = {
enable =
(lib.mkEnableOption (lib.mdDoc ''
(lib.mkEnableOption ''
a faster, persistent implementation of use_nix and use_flake, to replace the built-in one
''))
'')
// {
default = true;
};
@ -53,7 +53,7 @@ in {
default = pkgs.nix-direnv.override { nix = config.nix.package; };
defaultText = "pkgs.nix-direnv";
type = lib.types.package;
description = lib.mdDoc ''
description = ''
The nix-direnv package to use
'';
};

2
nixos/modules/programs/dmrconfig.nix
View file

@ -14,7 +14,7 @@ in {
enable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Whether to configure system to enable use of dmrconfig. This
enables the required udev rules and installs the program.
'';

2
nixos/modules/programs/droidcam.nix
View file

@ -4,7 +4,7 @@ with lib;
{
options.programs.droidcam = {
enable = mkEnableOption (lib.mdDoc "DroidCam client");
enable = mkEnableOption "DroidCam client";
};
config = lib.mkIf config.programs.droidcam.enable {

4
nixos/modules/programs/dublin-traceroute.nix
View file

@ -10,9 +10,9 @@ in {
options = {
programs.dublin-traceroute = {
enable = mkEnableOption (mdDoc ''
enable = mkEnableOption ''
dublin-traceroute, add it to the global environment and configure a setcap wrapper for it.
'');
'';
package = mkPackageOption pkgs "dublin-traceroute" { };
};

2
nixos/modules/programs/ecryptfs.nix
View file

@ -7,7 +7,7 @@ let
in {
options.programs.ecryptfs = {
enable = mkEnableOption (lib.mdDoc "ecryptfs setuid mount wrappers");
enable = mkEnableOption "ecryptfs setuid mount wrappers";
};
config = mkIf cfg.enable {

3
nixos/modules/programs/evince.nix
View file

@ -21,8 +21,7 @@ in {
programs.evince = {
enable = mkEnableOption
(lib.mdDoc "Evince, the GNOME document viewer");
enable = mkEnableOption "Evince, the GNOME document viewer";
package = mkPackageOption pkgs "evince" { };

4
nixos/modules/programs/extra-container.nix
View file

@ -5,10 +5,10 @@ let
cfg = config.programs.extra-container;
in {
options = {
programs.extra-container.enable = mkEnableOption (lib.mdDoc ''
programs.extra-container.enable = mkEnableOption ''
extra-container, a tool for running declarative NixOS containers
without host system rebuilds
'');
'';
};
config = mkIf cfg.enable {
environment.systemPackages = [ pkgs.extra-container ];

4
nixos/modules/programs/feedbackd.nix
View file

@ -7,11 +7,11 @@ let
in {
options = {
programs.feedbackd = {
enable = mkEnableOption (lib.mdDoc ''
enable = mkEnableOption ''
the feedbackd D-BUS service and udev rules.
Your user needs to be in the `feedbackd` group to trigger effects
'');
'';
package = mkPackageOption pkgs "feedbackd" { };
};
};

2
nixos/modules/programs/file-roller.nix
View file

@ -21,7 +21,7 @@ in {
programs.file-roller = {
enable = mkEnableOption (lib.mdDoc "File Roller, an archive manager for GNOME");
enable = mkEnableOption "File Roller, an archive manager for GNOME";
package = mkPackageOption pkgs [ "gnome" "file-roller" ] { };

20
nixos/modules/programs/firefox.nix
View file

@ -62,12 +62,12 @@ let
in
{
options.programs.firefox = {
enable = mkEnableOption (mdDoc "the Firefox web browser");
enable = mkEnableOption "the Firefox web browser";
package = mkOption {
type = types.package;
default = pkgs.firefox;
description = mdDoc "Firefox package to use.";
description = "Firefox package to use.";
defaultText = literalExpression "pkgs.firefox";
relatedPackages = [
"firefox"
@ -81,13 +81,13 @@ in
wrapperConfig = mkOption {
type = types.attrs;
default = {};
description = mdDoc "Arguments to pass to Firefox wrapper";
description = "Arguments to pass to Firefox wrapper";
};
policies = mkOption {
type = policyFormat.type;
default = { };
description = mdDoc ''
description = ''
Group policies to install.
See [Mozilla's documentation](https://mozilla.github.io/policy-templates/)
@ -103,7 +103,7 @@ in
preferences = mkOption {
type = with types; attrsOf (oneOf [ bool int str ]);
default = { };
description = mdDoc ''
description = ''
Preferences to set from `about:config`.
Some of these might be able to be configured more ergonomically
@ -116,7 +116,7 @@ in
preferencesStatus = mkOption {
type = types.enum [ "default" "locked" "user" "clear" ];
default = "locked";
description = mdDoc ''
description = ''
The status of `firefox.preferences`.
`status` can assume the following values:
@ -230,7 +230,7 @@ in
"zh-TW"
]));
default = [ ];
description = mdDoc ''
description = ''
The language packs to install.
'';
};
@ -238,7 +238,7 @@ in
autoConfig = mkOption {
type = types.lines;
default = "";
description = mdDoc ''
description = ''
AutoConfig files can be used to set and lock preferences that are not covered
by the policies.json for Mac and Linux. This method can be used to automatically
change user preferences or prevent the end user from modifiying specific
@ -250,11 +250,11 @@ in
packages = mkOption {
type = types.listOf types.package;
default = [];
description = mdDoc ''
description = ''
Additional packages containing native messaging hosts that should be made available to Firefox extensions.
'';
};
}) // (mapAttrs (k: v: mkEnableOption (mdDoc "${v.name} support")) nmhOptions);
}) // (mapAttrs (k: v: mkEnableOption "${v.name} support") nmhOptions);
};
config = let

12
nixos/modules/programs/firejail.nix
View file

@ -40,32 +40,32 @@ let
in {
options.programs.firejail = {
enable = mkEnableOption (lib.mdDoc "firejail, a sandboxing tool for Linux");
enable = mkEnableOption "firejail, a sandboxing tool for Linux";
wrappedBinaries = mkOption {
type = types.attrsOf (types.either types.path (types.submodule {
options = {
executable = mkOption {
type = types.path;
description = lib.mdDoc "Executable to run sandboxed";
description = "Executable to run sandboxed";
example = literalExpression ''"''${lib.getBin pkgs.firefox}/bin/firefox"'';
};
desktop = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc ".desktop file to modify. Only necessary if it uses the absolute path to the executable.";
description = ".desktop file to modify. Only necessary if it uses the absolute path to the executable.";
example = literalExpression ''"''${pkgs.firefox}/share/applications/firefox.desktop"'';
};
profile = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc "Profile to use";
description = "Profile to use";
example = literalExpression ''"''${pkgs.firejail}/etc/firejail/firefox.profile"'';
};
extraArgs = mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc "Extra arguments to pass to firejail";
description = "Extra arguments to pass to firejail";
example = [ "--private=~/.firejail_home" ];
};
};
@ -83,7 +83,7 @@ in {
};
}
'';
description = lib.mdDoc ''
description = ''
Wrap the binaries in firejail and place them in the global path.
'';
};

22
nixos/modules/programs/fish.nix
View file

@ -49,7 +49,7 @@ in
enable = mkOption {
default = false;
description = lib.mdDoc ''
description = ''
Whether to configure fish as an interactive shell.
'';
type = types.bool;
@ -58,7 +58,7 @@ in
useBabelfish = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
If enabled, the configured environment will be translated to native fish using [babelfish](https://github.com/bouk/babelfish).
Otherwise, [foreign-env](https://github.com/oh-my-fish/plugin-foreign-env) will be used.
'';
@ -67,7 +67,7 @@ in
vendor.config.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether fish should source configuration snippets provided by other packages.
'';
};
@ -75,7 +75,7 @@ in
vendor.completions.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether fish should use completion files provided by other packages.
'';
};
@ -83,7 +83,7 @@ in
vendor.functions.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether fish should autoload fish functions provided by other packages.
'';
};
@ -94,7 +94,7 @@ in
gco = "git checkout";
npu = "nix-prefetch-url";
};
description = lib.mdDoc ''
description = ''
Set of fish abbreviations.
'';
type = with types; attrsOf str;
@ -102,7 +102,7 @@ in
shellAliases = mkOption {
default = {};
description = lib.mdDoc ''
description = ''
Set of aliases for fish shell, which overrides {option}`environment.shellAliases`.
See {option}`environment.shellAliases` for an option format description.
'';
@ -111,7 +111,7 @@ in
shellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during fish shell initialisation.
'';
type = types.lines;
@ -119,7 +119,7 @@ in
loginShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during fish login shell initialisation.
'';
type = types.lines;
@ -127,7 +127,7 @@ in
interactiveShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during interactive fish shell initialisation.
'';
type = types.lines;
@ -135,7 +135,7 @@ in
promptInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code used to initialise fish prompt.
'';
type = types.lines;

2
nixos/modules/programs/flashrom.nix
View file

@ -10,7 +10,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Installs flashrom and configures udev rules for programmers
used by flashrom. Grants access to users in the "flashrom"
group.

2
nixos/modules/programs/flexoptix-app.nix
View file

@ -7,7 +7,7 @@ let
in {
options = {
programs.flexoptix-app = {
enable = mkEnableOption (lib.mdDoc "FLEXOPTIX app + udev rules");
enable = mkEnableOption "FLEXOPTIX app + udev rules";
package = mkPackageOption pkgs "flexoptix-app" { };
};

3
nixos/modules/programs/freetds.nix
View file

@ -25,8 +25,7 @@ in
''';
}
'';
description =
lib.mdDoc ''
description = ''
Configure freetds database entries. Each attribute denotes
a section within freetds.conf, and the value (a string) is the config
content for that section. When at least one entry is configured

4
nixos/modules/programs/fuse.nix
View file

@ -13,7 +13,7 @@ in {
# negative numbers obviously make no sense:
type = types.ints.between 0 32767; # 2^15 - 1
default = 1000;
description = lib.mdDoc ''
description = ''
Set the maximum number of FUSE mounts allowed to non-root users.
'';
};
@ -21,7 +21,7 @@ in {
userAllowOther = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Allow non-root users to specify the allow_other or allow_root mount
options, see mount.fuse3(8).
'';

4
nixos/modules/programs/fzf.nix
View file

@ -6,8 +6,8 @@ in
{
options = {
programs.fzf = {
fuzzyCompletion = lib.mkEnableOption (lib.mdDoc "fuzzy completion with fzf");
keybindings = lib.mkEnableOption (lib.mdDoc "fzf keybindings");
fuzzyCompletion = lib.mkEnableOption "fuzzy completion with fzf";
keybindings = lib.mkEnableOption "fzf keybindings";
};
};

6
nixos/modules/programs/gamemode.nix
View file

@ -10,16 +10,16 @@ in
{
options = {
programs.gamemode = {
enable = mkEnableOption (lib.mdDoc "GameMode to optimise system performance on demand");
enable = mkEnableOption "GameMode to optimise system performance on demand";
enableRenice = mkEnableOption (lib.mdDoc "CAP_SYS_NICE on gamemoded to support lowering process niceness") // {
enableRenice = mkEnableOption "CAP_SYS_NICE on gamemoded to support lowering process niceness" // {
default = true;
};
settings = mkOption {
type = settingsFormat.type;
default = { };
description = lib.mdDoc ''
description = ''
System-wide configuration for GameMode (/etc/gamemode.ini).
See gamemoded(8) man page for available settings.
'';

8
nixos/modules/programs/gamescope.nix
View file

@ -21,14 +21,14 @@ with lib; let
in
{
options.programs.gamescope = {
enable = mkEnableOption (mdDoc "gamescope, the SteamOS session compositing window manager");
enable = mkEnableOption "gamescope, the SteamOS session compositing window manager";
package = mkPackageOption pkgs "gamescope" { };
capSysNice = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
Add cap_sys_nice capability to the GameScope
binary so that it may renice itself.
'';
@ -38,7 +38,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "--rt" "--prefer-vk-device 8086:9bc4" ];
description = mdDoc ''
description = ''
Arguments passed to GameScope on startup.
'';
};
@ -55,7 +55,7 @@ in
__GLX_VENDOR_LIBRARY_NAME = "nvidia";
}
'';
description = mdDoc ''
description = ''
Default environment variables available to the GameScope process, overridable at runtime.
'';
};

2
nixos/modules/programs/geary.nix
View file

@ -11,7 +11,7 @@ in {
};
options = {
programs.geary.enable = mkEnableOption (lib.mdDoc "Geary, a Mail client for GNOME");
programs.geary.enable = mkEnableOption "Geary, a Mail client for GNOME";
};
config = mkIf cfg.enable {

6
nixos/modules/programs/git.nix
View file

@ -9,7 +9,7 @@ in
{
options = {
programs.git = {
enable = mkEnableOption (lib.mdDoc "git, a distributed version control system");
enable = mkEnableOption "git, a distributed version control system";
package = mkPackageOption pkgs "git" {
example = "gitFull";
@ -43,7 +43,7 @@ in
init.defaultBranch = "main";
url."https://github.com/".insteadOf = [ "gh:" "github:" ];
};
description = lib.mdDoc ''
description = ''
Configuration to write to /etc/gitconfig. A list can also be
specified to keep the configuration in order. For example, setting
`config` to `[ { foo.x = 42; } { bar.y = 42; }]` will put the `foo`
@ -59,7 +59,7 @@ in
};
lfs = {
enable = mkEnableOption (lib.mdDoc "git-lfs (Large File Storage)");
enable = mkEnableOption "git-lfs (Large File Storage)";
package = mkPackageOption pkgs "git-lfs" { };
};

2
nixos/modules/programs/gnome-disks.nix
View file

@ -26,7 +26,7 @@ with lib;
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable GNOME Disks daemon, a program designed to
be a UDisks2 graphical front-end.
'';

2
nixos/modules/programs/gnome-terminal.nix
View file

@ -24,7 +24,7 @@ in
];
options = {
programs.gnome-terminal.enable = mkEnableOption (lib.mdDoc "GNOME Terminal");
programs.gnome-terminal.enable = mkEnableOption "GNOME Terminal";
};
config = mkIf cfg.enable {

14
nixos/modules/programs/gnupg.nix
View file

@ -36,7 +36,7 @@ in
agent.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enables GnuPG agent with socket-activation for every user session.
'';
};
@ -44,7 +44,7 @@ in
agent.enableSSHSupport = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enable SSH agent support in GnuPG agent. Also sets SSH_AUTH_SOCK
environment variable correctly. This will disable socket-activation
and thus always start a GnuPG agent per user session.
@ -54,7 +54,7 @@ in
agent.enableExtraSocket = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enable extra socket for GnuPG agent.
'';
};
@ -62,7 +62,7 @@ in
agent.enableBrowserSocket = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enable browser socket for GnuPG agent.
'';
};
@ -72,7 +72,7 @@ in
example = lib.literalMD "pkgs.pinentry-gnome3";
default = pkgs.pinentry-curses;
defaultText = lib.literalMD "matching the configured desktop environment or `pkgs.pinentry-curses`";
description = lib.mdDoc ''
description = ''
Which pinentry package to use. The path to the mainProgram as defined in
the package's meta attriutes will be set in /etc/gnupg/gpg-agent.conf.
If not set by the user, it'll pick an appropriate flavor depending on the
@ -87,7 +87,7 @@ in
example = {
default-cache-ttl = 600;
};
description = lib.mdDoc ''
description = ''
Configuration for /etc/gnupg/gpg-agent.conf.
See {manpage}`gpg-agent(1)` for supported options.
'';
@ -96,7 +96,7 @@ in
dirmngr.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enables GnuPG network certificate management daemon with socket-activation for every user session.
'';
};

2
nixos/modules/programs/gpaste.nix
View file

@ -18,7 +18,7 @@ with lib;
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable GPaste, a clipboard manager.
'';
};

2
nixos/modules/programs/gphoto2.nix
View file

@ -11,7 +11,7 @@ with lib;
enable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Whether to configure system to use gphoto2.
To grant digital camera access to a user, the user must
be part of the camera group:

2
nixos/modules/programs/haguichi.nix
View file

@ -4,7 +4,7 @@ with lib;
{
options.programs.haguichi = {
enable = mkEnableOption (lib.mdDoc "Haguichi, a Linux GUI frontend to the proprietary LogMeIn Hamachi");
enable = mkEnableOption "Haguichi, a Linux GUI frontend to the proprietary LogMeIn Hamachi";
};
config = mkIf config.programs.haguichi.enable {

2
nixos/modules/programs/hamster.nix
View file

@ -6,7 +6,7 @@ with lib;
meta.maintainers = pkgs.hamster.meta.maintainers;
options.programs.hamster.enable =
mkEnableOption (lib.mdDoc "hamster, a time tracking program");
mkEnableOption "hamster, a time tracking program";
config = lib.mkIf config.programs.hamster.enable {
environment.systemPackages = [ pkgs.hamster ];

4
nixos/modules/programs/htop.nix
View file

@ -20,7 +20,7 @@ in
options.programs.htop = {
package = mkPackageOption pkgs "htop" { };
enable = mkEnableOption (lib.mdDoc "htop process monitor");
enable = mkEnableOption "htop process monitor";
settings = mkOption {
type = with types; attrsOf (oneOf [ str int bool (listOf (oneOf [ str int bool ])) ]);
@ -29,7 +29,7 @@ in
hide_kernel_threads = true;
hide_userland_threads = true;
};
description = lib.mdDoc ''
description = ''
Extra global default configuration for htop
which is read on first startup only.
Htop subsequently uses ~/.config/htop/htoprc

4
nixos/modules/programs/i3lock.nix
View file

@ -12,7 +12,7 @@ in {
options = {
programs.i3lock = {
enable = mkEnableOption (mdDoc "i3lock");
enable = mkEnableOption "i3lock";
package = mkPackageOption pkgs "i3lock" {
example = "i3lock-color";
extraDescription = ''
@ -25,7 +25,7 @@ in {
type = types.bool;
default = false;
example = true;
description = mdDoc ''
description = ''
Whether to enable U2F support in the i3lock program.
U2F enables authentication using a hardware device, such as a security key.
When U2F support is enabled, the i3lock program will set the setuid bit on the i3lock binary and enable the pam u2fAuth service,

4
nixos/modules/programs/iay.nix
View file

@ -5,13 +5,13 @@ let
inherit (lib) mkEnableOption mkIf mkOption mkPackageOption optionalString types;
in {
options.programs.iay = {
enable = mkEnableOption (lib.mdDoc "iay, a minimalistic shell prompt");
enable = mkEnableOption "iay, a minimalistic shell prompt";
package = mkPackageOption pkgs "iay" {};
minimalPrompt = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Use minimal one-liner prompt.";
description = "Use minimal one-liner prompt.";
};
};

2
nixos/modules/programs/iftop.nix
View file

@ -6,7 +6,7 @@ let
cfg = config.programs.iftop;
in {
options = {
programs.iftop.enable = mkEnableOption (lib.mdDoc "iftop + setcap wrapper");
programs.iftop.enable = mkEnableOption "iftop + setcap wrapper";
};
config = mkIf cfg.enable {
environment.systemPackages = [ pkgs.iftop ];

2
nixos/modules/programs/iotop.nix
View file

@ -6,7 +6,7 @@ let
cfg = config.programs.iotop;
in {
options = {
programs.iotop.enable = mkEnableOption (lib.mdDoc "iotop + setcap wrapper");
programs.iotop.enable = mkEnableOption "iotop + setcap wrapper";
};
config = mkIf cfg.enable {
security.wrappers.iotop = {

6
nixos/modules/programs/java.nix
View file

@ -14,8 +14,8 @@ in
programs.java = {
enable = mkEnableOption (lib.mdDoc "java") // {
description = lib.mdDoc ''
enable = mkEnableOption "java" // {
description = ''
Install and setup the Java development kit.
::: {.note}
@ -34,7 +34,7 @@ in
example = "jre";
};
binfmt = mkEnableOption (lib.mdDoc "binfmt to execute java jar's and classes");
binfmt = mkEnableOption "binfmt to execute java jar's and classes";
};

2
nixos/modules/programs/joycond-cemuhook.nix
View file

@ -2,7 +2,7 @@
with lib;
{
options.programs.joycond-cemuhook = {
enable = mkEnableOption (lib.mdDoc "joycond-cemuhook, a program to enable support for cemuhook's UDP protocol for joycond devices.");
enable = mkEnableOption "joycond-cemuhook, a program to enable support for cemuhook's UDP protocol for joycond devices.";
};
config = lib.mkIf config.programs.joycond-cemuhook.enable {

2
nixos/modules/programs/k3b.nix
View file

@ -8,7 +8,7 @@ with lib;
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable k3b, the KDE disk burning application.
Additionally to installing `k3b` enabling this will

4
nixos/modules/programs/k40-whisperer.nix
View file

@ -10,11 +10,11 @@ let
in
{
options.programs.k40-whisperer = {
enable = mkEnableOption (lib.mdDoc "K40-Whisperer");
enable = mkEnableOption "K40-Whisperer";
group = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
Group assigned to the device when connected.
'';
default = "k40";

2
nixos/modules/programs/kbdlight.nix
View file

@ -7,7 +7,7 @@ let
in
{
options.programs.kbdlight.enable = mkEnableOption (lib.mdDoc "kbdlight");
options.programs.kbdlight.enable = mkEnableOption "kbdlight";
config = mkIf cfg.enable {
environment.systemPackages = [ pkgs.kbdlight ];

2
nixos/modules/programs/kclock.nix
View file

@ -4,7 +4,7 @@ let
cfg = config.programs.kclock;
kclockPkg = pkgs.libsForQt5.kclock;
in {
options.programs.kclock = { enable = mkEnableOption (lib.mdDoc "KClock"); };
options.programs.kclock = { enable = mkEnableOption "KClock"; };
config = mkIf cfg.enable {
services.dbus.packages = [ kclockPkg ];

4
nixos/modules/programs/kdeconnect.nix
View file

@ -2,7 +2,7 @@
with lib;
{
options.programs.kdeconnect = {
enable = mkEnableOption (lib.mdDoc ''
enable = mkEnableOption ''
kdeconnect.
Note that it will open the TCP and UDP port from
@ -10,7 +10,7 @@ with lib;
You can use the {option}`package` to use
`gnomeExtensions.gsconnect` as an alternative
implementation if you use Gnome
'');
'';
package = mkPackageOption pkgs [ "plasma5Packages" "kdeconnect-kde" ] {
example = "gnomeExtensions.gsconnect";
};

2
nixos/modules/programs/kubeswitch.nix
View file

@ -10,7 +10,7 @@ in
{
options = {
programs.kubeswitch = {
enable = lib.mkEnableOption (lib.mdDoc "kubeswitch");
enable = lib.mkEnableOption "kubeswitch";
commandName = lib.mkOption {
type = lib.types.str;

16
nixos/modules/programs/less.nix
View file

@ -35,13 +35,13 @@ in
# note that environment.nix sets PAGER=less, and
# therefore also enables this module
enable = mkEnableOption (lib.mdDoc "less, a file pager");
enable = mkEnableOption "less, a file pager";
configFile = mkOption {
type = types.nullOr types.path;
default = null;
example = literalExpression ''"''${pkgs.my-configs}/lesskey"'';
description = lib.mdDoc ''
description = ''
Path to lesskey configuration file.
{option}`configFile` takes precedence over {option}`commands`,
@ -57,13 +57,13 @@ in
h = "noaction 5\\e(";
l = "noaction 5\\e)";
};
description = lib.mdDoc "Defines new command keys.";
description = "Defines new command keys.";
};
clearDefaultCommands = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Clear all default commands.
You should remember to set the quit key.
Otherwise you will not be able to leave less without killing it.
@ -76,7 +76,7 @@ in
example = {
e = "abort";
};
description = lib.mdDoc "Defines new line-editing keys.";
description = "Defines new line-editing keys.";
};
envVariables = mkOption {
@ -87,14 +87,14 @@ in
example = {
LESS = "--quit-if-one-screen";
};
description = lib.mdDoc "Defines environment variables.";
description = "Defines environment variables.";
};
lessopen = mkOption {
type = types.nullOr types.str;
default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s";
defaultText = literalExpression ''"|''${pkgs.lesspipe}/bin/lesspipe.sh %s"'';
description = lib.mdDoc ''
description = ''
Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed.
'';
};
@ -102,7 +102,7 @@ in
lessclose = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc ''
description = ''
When less closes a file opened in such a way, it will call another program, called the input postprocessor,
which may perform any desired clean-up action (such as deleting the replacement file created by LESSOPEN).
'';

2
nixos/modules/programs/liboping.nix
View file

@ -6,7 +6,7 @@ let
cfg = config.programs.liboping;
in {
options.programs.liboping = {
enable = mkEnableOption (lib.mdDoc "liboping");
enable = mkEnableOption "liboping";
};
config = mkIf cfg.enable {
environment.systemPackages = with pkgs; [ liboping ];

2
nixos/modules/programs/light.nix
View file

@ -13,7 +13,7 @@ in
enable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Whether to install Light backlight control command
and udev rules granting access to members of the "video" group.
'';

2
nixos/modules/programs/mdevctl.nix
View file

@ -5,7 +5,7 @@ let
cfg = config.programs.mdevctl;
in {
options.programs.mdevctl = {
enable = mkEnableOption (lib.mdDoc "Mediated Device Management");
enable = mkEnableOption "Mediated Device Management";
};
config = mkIf cfg.enable {

6
nixos/modules/programs/mepo.nix
View file

@ -5,13 +5,13 @@ let
in
{
options.programs.mepo = {
enable = mkEnableOption (mdDoc "Mepo, a fast, simple and hackable OSM map viewer");
enable = mkEnableOption "Mepo, a fast, simple and hackable OSM map viewer";
locationBackends = {
gpsd = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
Whether to enable location detection via gpsd.
This may require additional configuration of gpsd, see [here](#opt-services.gpsd.enable)
'';
@ -20,7 +20,7 @@ in
geoclue = mkOption {
type = types.bool;
default = true;
description = mdDoc "Whether to enable location detection via geoclue";
description = "Whether to enable location detection via geoclue";
};
};
};

2
nixos/modules/programs/mininet.nix
View file

@ -8,7 +8,7 @@ let
cfg = config.programs.mininet;
in
{
options.programs.mininet.enable = mkEnableOption (lib.mdDoc "Mininet, an emulator for rapid prototyping of Software Defined Networks");
options.programs.mininet.enable = mkEnableOption "Mininet, an emulator for rapid prototyping of Software Defined Networks";
config = mkIf cfg.enable {

4
nixos/modules/programs/minipro.nix
View file

@ -6,8 +6,8 @@ in
{
options = {
programs.minipro = {
enable = lib.mkEnableOption (lib.mdDoc "minipro") // {
description = lib.mdDoc ''
enable = lib.mkEnableOption "minipro" // {
description = ''
Whether to enable minipro and its udev rules.
Users of the `plugdev` group can interact with connected MiniPRO chip programmers.
'';

6
nixos/modules/programs/miriway.nix
View file

@ -4,12 +4,12 @@ let
cfg = config.programs.miriway;
in {
options.programs.miriway = {
enable = lib.mkEnableOption (lib.mdDoc ''
enable = lib.mkEnableOption ''
Miriway, a Mir based Wayland compositor. You can manually launch Miriway by
executing "exec miriway" on a TTY, or launch it from a display manager. Copy
/etc/xdg/xdg-miriway/miriway-shell.config to ~/.config/miriway-shell.config
to modify the system-wide configuration on a per-user basis. See <https://github.com/Miriway/Miriway>,
and "miriway --help" for more information'');
and "miriway --help" for more information'';
config = lib.mkOption {
type = lib.types.lines;
@ -50,7 +50,7 @@ in {
meta=Page_Down:@workspace-down
ctrl-alt=BackSpace:@exit
'';
description = lib.mdDoc ''
description = ''
Miriway's config. This will be installed system-wide.
The default will install the miriway package's barebones example config.
'';

2
nixos/modules/programs/mosh.nix
View file

@ -13,7 +13,7 @@ in
default = true;
};
withUtempter = lib.mkEnableOption "" // {
description = lib.mdDoc ''
description = ''
Whether to enable libutempter for mosh.
This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).

10
nixos/modules/programs/msmtp.nix
View file

@ -10,12 +10,12 @@ in {
options = {
programs.msmtp = {
enable = mkEnableOption (lib.mdDoc "msmtp - an SMTP client");
enable = mkEnableOption "msmtp - an SMTP client";
setSendmail = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to set the system sendmail to msmtp's.
'';
};
@ -28,7 +28,7 @@ in {
port = 587;
tls = true;
};
description = lib.mdDoc ''
description = ''
Default values applied to all accounts.
See msmtp(1) for the available options.
'';
@ -45,7 +45,7 @@ in {
passwordeval = "cat /secrets/password.txt";
};
};
description = lib.mdDoc ''
description = ''
Named accounts and their respective configurations.
The special name "default" allows a default account to be defined.
See msmtp(1) for the available options.
@ -62,7 +62,7 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Extra lines to add to the msmtp configuration verbatim.
See msmtp(1) for the syntax and available options.
'';

2
nixos/modules/programs/mtr.nix
View file

@ -11,7 +11,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to add mtr to the global environment and configure a
setcap wrapper for it.
'';

6
nixos/modules/programs/nano.nix
View file

@ -7,7 +7,7 @@ in
{
options = {
programs.nano = {
enable = lib.mkEnableOption (lib.mdDoc "nano, a small user-friendly console text editor") // {
enable = lib.mkEnableOption "nano, a small user-friendly console text editor" // {
default = true;
};
@ -16,7 +16,7 @@ in
nanorc = lib.mkOption {
type = lib.types.lines;
default = "";
description = lib.mdDoc ''
description = ''
The system-wide nano configuration.
See {manpage}`nanorc(5)`.
'';
@ -30,7 +30,7 @@ in
syntaxHighlight = lib.mkOption {
type = lib.types.bool;
default = true;
description = lib.mdDoc "Whether to enable syntax highlight for various languages.";
description = "Whether to enable syntax highlight for various languages.";
};
};
};

4
nixos/modules/programs/nautilus-open-any-terminal.nix
View file

@ -5,12 +5,12 @@ let
in
{
options.programs.nautilus-open-any-terminal = {
enable = lib.mkEnableOption (lib.mdDoc "nautilus-open-any-terminal");
enable = lib.mkEnableOption "nautilus-open-any-terminal";
terminal = lib.mkOption {
type = with lib.types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
The terminal emulator to add to context-entry of nautilus. Supported terminal
emulators are listed in https://github.com/Stunkymonkey/nautilus-open-any-terminal#supported-terminal-emulators.
'';

2
nixos/modules/programs/nbd.nix
View file

@ -8,7 +8,7 @@ in
{
options = {
programs.nbd = {
enable = mkEnableOption (lib.mdDoc "Network Block Device (nbd) support");
enable = mkEnableOption "Network Block Device (nbd) support";
};
};

28
nixos/modules/programs/neovim.nix
View file

@ -11,7 +11,7 @@ in
type = types.bool;
default = false;
example = true;
description = lib.mdDoc ''
description = ''
Whether to enable Neovim.
When enabled through this option, Neovim is wrapped to use a
@ -24,7 +24,7 @@ in
defaultEditor = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
When enabled, installs neovim and configures neovim to be the default editor
using the EDITOR environment variable.
'';
@ -33,7 +33,7 @@ in
viAlias = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Symlink {command}`vi` to {command}`nvim` binary.
'';
};
@ -41,7 +41,7 @@ in
vimAlias = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Symlink {command}`vim` to {command}`nvim` binary.
'';
};
@ -49,19 +49,19 @@ in
withRuby = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Enable Ruby provider.";
description = "Enable Ruby provider.";
};
withPython3 = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Enable Python 3 provider.";
description = "Enable Python 3 provider.";
};
withNodeJs = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable Node provider.";
description = "Enable Node provider.";
};
configure = mkOption {
@ -80,7 +80,7 @@ in
};
}
'';
description = lib.mdDoc ''
description = ''
Generate your init file from your list of plugins and custom commands.
Neovim will then be wrapped to load {command}`nvim -u /nix/store/«hash»-vimrc`
'';
@ -92,7 +92,7 @@ in
type = types.package;
visible = false;
readOnly = true;
description = lib.mdDoc "Resulting customized neovim package.";
description = "Resulting customized neovim package.";
};
runtime = mkOption {
@ -100,7 +100,7 @@ in
example = literalExpression ''
{ "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; }
'';
description = lib.mdDoc ''
description = ''
Set of files that have to be linked in {file}`runtime`.
'';
@ -112,7 +112,7 @@ in
enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether this runtime directory should be generated. This
option allows specific runtime files to be disabled.
'';
@ -120,7 +120,7 @@ in
target = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
Name of symlink. Defaults to the attribute
name.
'';
@ -129,13 +129,13 @@ in
text = mkOption {
default = null;
type = types.nullOr types.lines;
description = lib.mdDoc "Text of the file.";
description = "Text of the file.";
};
source = mkOption {
default = null;
type = types.nullOr types.path;
description = lib.mdDoc "Path of the source file.";
description = "Path of the source file.";
};
};

2
nixos/modules/programs/nethoscope.nix
View file

@ -12,7 +12,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to add nethoscope to the global environment and configure a
setcap wrapper for it.
'';

2
nixos/modules/programs/nexttrace.nix
View file

@ -7,7 +7,7 @@ in
{
options = {
programs.nexttrace = {
enable = lib.mkEnableOption (lib.mdDoc "Nexttrace to the global environment and configure a setcap wrapper for it");
enable = lib.mkEnableOption "Nexttrace to the global environment and configure a setcap wrapper for it";
package = lib.mkPackageOption pkgs "nexttrace" { };
};
};

8
nixos/modules/programs/nix-index.nix
View file

@ -3,19 +3,19 @@ let
cfg = config.programs.nix-index;
in {
options.programs.nix-index = with lib; {
enable = mkEnableOption (lib.mdDoc "nix-index, a file database for nixpkgs");
enable = mkEnableOption "nix-index, a file database for nixpkgs";
package = mkPackageOption pkgs "nix-index" { };
enableBashIntegration = mkEnableOption (lib.mdDoc "Bash integration") // {
enableBashIntegration = mkEnableOption "Bash integration" // {
default = true;
};
enableZshIntegration = mkEnableOption (lib.mdDoc "Zsh integration") // {
enableZshIntegration = mkEnableOption "Zsh integration" // {
default = true;
};
enableFishIntegration = mkEnableOption (lib.mdDoc "Fish integration") // {
enableFishIntegration = mkEnableOption "Fish integration" // {
default = true;
};
};

4
nixos/modules/programs/nix-ld.nix
View file

@ -17,11 +17,11 @@ in
{
meta.maintainers = [ lib.maintainers.mic92 ];
options.programs.nix-ld = {
enable = lib.mkEnableOption (lib.mdDoc ''nix-ld, Documentation: <https://github.com/Mic92/nix-ld>'');
enable = lib.mkEnableOption ''nix-ld, Documentation: <https://github.com/Mic92/nix-ld>'';
package = lib.mkPackageOption pkgs "nix-ld" { };
libraries = lib.mkOption {
type = lib.types.listOf lib.types.package;
description = lib.mdDoc "Libraries that automatically become available to all programs. The default set includes common libraries.";
description = "Libraries that automatically become available to all programs. The default set includes common libraries.";
default = [ ];
defaultText = lib.literalExpression "baseLibraries derived from systemd and nix dependencies.";
};

4
nixos/modules/programs/nm-applet.nix
View file

@ -6,12 +6,12 @@
};
options.programs.nm-applet = {
enable = lib.mkEnableOption (lib.mdDoc "nm-applet, a NetworkManager control applet for GNOME");
enable = lib.mkEnableOption "nm-applet, a NetworkManager control applet for GNOME";
indicator = lib.mkOption {
type = lib.types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to use indicator instead of status icon.
It is needed for Appindicator environments, like Enlightenment.
'';

8
nixos/modules/programs/nncp.nix
View file

@ -11,12 +11,12 @@ in {
options.programs.nncp = {
enable =
mkEnableOption (lib.mdDoc "NNCP (Node to Node copy) utilities and configuration");
mkEnableOption "NNCP (Node to Node copy) utilities and configuration";
group = mkOption {
type = types.str;
default = "uucp";
description = lib.mdDoc ''
description = ''
The group under which NNCP files shall be owned.
Any member of this group may access the secret keys
of this NNCP node.
@ -28,7 +28,7 @@ in {
secrets = mkOption {
type = with types; listOf str;
example = [ "/run/keys/nncp.hjson" ];
description = lib.mdDoc ''
description = ''
A list of paths to NNCP configuration files that should not be
in the Nix store. These files are layered on top of the values at
[](#opt-programs.nncp.settings).
@ -37,7 +37,7 @@ in {
settings = mkOption {
type = settingsFormat.type;
description = lib.mdDoc ''
description = ''
NNCP configuration, see
<http://www.nncpgo.org/Configuration.html>.
At runtime these settings will be overlayed by the contents of

2
nixos/modules/programs/noisetorch.nix
View file

@ -6,7 +6,7 @@ let cfg = config.programs.noisetorch;
in
{
options.programs.noisetorch = {
enable = mkEnableOption (lib.mdDoc "noisetorch (+ setcap wrapper), a virtual microphone device with noise suppression");
enable = mkEnableOption "noisetorch (+ setcap wrapper), a virtual microphone device with noise suppression";
package = mkPackageOption pkgs "noisetorch" { };
};

4
nixos/modules/programs/npm.nix
View file

@ -11,7 +11,7 @@ in
options = {
programs.npm = {
enable = mkEnableOption (lib.mdDoc "{command}`npm` global config");
enable = mkEnableOption "{command}`npm` global config";
package = mkPackageOption pkgs [ "nodePackages" "npm" ] {
example = "nodePackages_13_x.npm";
@ -19,7 +19,7 @@ in
npmrc = mkOption {
type = lib.types.lines;
description = lib.mdDoc ''
description = ''
The system-wide npm configuration.
See <https://docs.npmjs.com/misc/config>.
'';

2
nixos/modules/programs/ns-usbloader.nix
View file

@ -5,7 +5,7 @@ in
{
options = {
programs.ns-usbloader = {
enable = lib.mkEnableOption (lib.mdDoc "ns-usbloader application with udev rules applied");
enable = lib.mkEnableOption "ns-usbloader application with udev rules applied";
};
};

4
nixos/modules/programs/openvpn3.nix
View file

@ -7,7 +7,7 @@ let
in
{
options.programs.openvpn3 = {
enable = mkEnableOption (lib.mdDoc "the openvpn3 client");
enable = mkEnableOption "the openvpn3 client";
package = mkOption {
type = types.package;
default = pkgs.openvpn3.override {
@ -16,7 +16,7 @@ in
defaultText = literalExpression ''pkgs.openvpn3.override {
enableSystemdResolved = config.services.resolved.enable;
}'';
description = lib.mdDoc ''
description = ''
Which package to use for `openvpn3`.
'';
};

2
nixos/modules/programs/pantheon-tweaks.nix
View file

@ -9,7 +9,7 @@ with lib;
###### interface
options = {
programs.pantheon-tweaks.enable = mkEnableOption (lib.mdDoc "Pantheon Tweaks, an unofficial system settings panel for Pantheon");
programs.pantheon-tweaks.enable = mkEnableOption "Pantheon Tweaks, an unofficial system settings panel for Pantheon";
};
###### implementation

2
nixos/modules/programs/partition-manager.nix
View file

@ -7,7 +7,7 @@ in {
options = {
programs.partition-manager = {
enable = lib.mkEnableOption (lib.mdDoc "KDE Partition Manager");
enable = lib.mkEnableOption "KDE Partition Manager";
package = lib.mkPackageOption pkgs [ "libsForQt5" "partitionmanager" ] { };
};

2
nixos/modules/programs/plotinus.nix
View file

@ -17,7 +17,7 @@ in
programs.plotinus = {
enable = mkOption {
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable the Plotinus GTK 3 plugin. Plotinus provides a
popup (triggered by Ctrl-Shift-P) to search the menus of a
compatible application.

Some files were not shown because too many files have changed in this diff Show more