+ Declared by: home-manager.sharedModulesExtra modules added to all users.
Type: list of Home Manager moduless Default:
@@ -23,7 +23,13 @@ file extension rather than exiting with an error.
]
- Example: [ { home.packages = [ nixpkgs-fmt ]; } ]Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[ { home.packages = [ nixpkgs-fmt ]; } ]";
+ }
+
+ Declared by: home-manager.useGlobalPkgsWhether to enable using the system configuration's pkgs
argument in Home Manager. This disables the Home Manager
diff --git a/nixos-options.html b/nixos-options.html
index e60739fc..8b43ddc5 100644
--- a/nixos-options.html
+++ b/nixos-options.html
@@ -23,7 +23,13 @@ file extension rather than exiting with an error.
]
- Example: [ { home.packages = [ nixpkgs-fmt ]; } ]Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[ { home.packages = [ nixpkgs-fmt ]; } ]";
+ }
+
+ Declared by: home-manager.useGlobalPkgsWhether to enable using the system configuration's pkgs
argument in Home Manager. This disables the Home Manager
diff --git a/options.html b/options.html
index 11eabf4f..a87709c0 100644
--- a/options.html
+++ b/options.html
@@ -58,13 +58,13 @@ explanation about possible values.
command = "'\${pkgs.notmuch}/bin/notmuch address --format=json --output=recipients date:6M..'"; regexp = '''\[?{"name": "(?P<name>.*)", "address": "(?P<email>.+)", "name-addr": ".*"}[,\]]?'''; shellcommand_external_filtering = "False"; type = "shellcommand";
}
- Example: {
- type = "shellcommand";
- command = "abook --mutt-query";
- regexp = "'^(?P<email>[^@]+@[^\t]+)\t+(?P<name>[^\t]+)'";
- ignorecase = "True";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n type = \"shellcommand\";\n command = \"abook --mutt-query\";\n regexp = \"'^(?P<email>[^@]+@[^\\t]+)\\t+(?P<name>[^\\t]+)'\";\n ignorecase = \"True\";\n}\n";
+ }
+
+ Declared by: accounts.email.accounts.<name>.alot.extraConfigExtra settings to add to this Alot account configuration.
Type: strings concatenated with "\n" Default:
@@ -216,10 +216,13 @@ account configuration.
}
- Example: {
- default-page-size = 50;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n default-page-size = 50;\n}\n";
+ }
+
+ Declared by: accounts.email.accounts.<name>.imapThe IMAP configuration to use for this account.
Type: null or submodule Default:
@@ -451,11 +454,13 @@ the given mail store.
}
- Example: {
- PipelineDepth = 10;
- Timeout = 60;
-};
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n PipelineDepth = 10;\n Timeout = 60;\n};\n";
+ }
+
+ Declared by: accounts.email.accounts.<name>.mbsync.extraConfig.channelPer channel extra configuration.
Type: attribute set of string or signed integer or booleans Default:
@@ -464,11 +469,13 @@ the given mail store.
}
- Example: {
- MaxMessages = 10000;
- MaxSize = "1m";
-};
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n MaxMessages = 10000;\n MaxSize = \"1m\";\n};\n";
+ }
+
+ Declared by: accounts.email.accounts.<name>.mbsync.extraConfig.localLocal store extra configuration.
Type: attribute set of string or signed integer or booleans Default:
@@ -705,11 +712,11 @@ attribute name of the account configuration.
<home-manager/modules/programs/neomutt.nix>
|
accounts.email.accounts.<name>.neomutt.sendMailCommandCommand to send a mail. If not set, neomutt will be in charge of sending mails.
Type: null or string Default:
- if config.msmtp.enable then
- "msmtpq --read-envelope-from --read-recipients"
-else
- null
-
+
+ {
+ _type = "literalExpression"; text = "if config.msmtp.enable then\n \"msmtpq --read-envelope-from --read-recipients\"\nelse\n null\n";
+ }
+
Example:
"msmtpq --read-envelope-from --read-recipients"
Declared by:
@@ -889,16 +896,13 @@ directory.
}
- Example: {
- "org/gnome/calculator" = {
- button-mode = "programming";
- show-thousands = true;
- base = 10;
- word-size = 64;
- window-position = lib.hm.gvariant.mkTuple [100 100];
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n \"org/gnome/calculator\" = {\n button-mode = \"programming\";\n show-thousands = true;\n base = 10;\n word-size = 64;\n window-position = lib.hm.gvariant.mkTuple [100 100];\n };\n}\n";
+ }
+
+ Declared by: fonts.fontconfig.enableWhether to enable fontconfig configuration. This will, for
example, allow fontconfig to discover fonts and
@@ -925,7 +929,13 @@ to your profile. If null then the font
is assumed to already be available in your profile.
Type: null or package Default:
null
- Example: pkgs.dejavu_fonts Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "pkgs.dejavu_fonts";
+ }
+
+ Declared by: gtk.font.nameThe family name of the font within the package.
Type: string Example:
@@ -941,8 +951,18 @@ is assumed to already be available in your profile.
<home-manager/modules/misc/gtk.nix>
|
gtk.gtk2.configLocationThe location to put the GTK configuration file.
Type: path Default:
- "${config.home.homeDirectory}/.gtkrc-2.0"
- Example: "${config.xdg.configHome}/gtk-2.0/gtkrc"Declared by:
+
+ {
+ _type = "literalExpression"; text = ''"''${config.home.homeDirectory}/.gtkrc-2.0"'';
+ }
+
+ Example:
+
+ {
+ _type = "literalExpression"; text = ''"''${config.xdg.configHome}/gtk-2.0/gtkrc"'';
+ }
+
+ Declared by: gtk.gtk2.extraConfigExtra configuration lines to add verbatim to
~/.gtkrc-2.0.
@@ -997,7 +1017,13 @@ to your profile. If null then the theme
is assumed to already be available in your profile.
Type: null or package Default:
null
- Example: pkgs.gnome.gnome_themes_standard Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "pkgs.gnome.gnome_themes_standard";
+ }
+
+ Declared by: gtk.iconTheme.nameThe name of the theme within the package. Type: string Example:
"Adwaita"
@@ -1012,7 +1038,13 @@ to your profile. If null then the theme
is assumed to already be available in your profile.
Type: null or package Default:
null
- Example: pkgs.gnome.gnome_themes_standard Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "pkgs.gnome.gnome_themes_standard";
+ }
+
+ Declared by: gtk.theme.nameThe name of the theme within the package. Type: string Example:
"Adwaita"
@@ -1089,13 +1121,13 @@ any issue that may arise. The variable
}
- Example: {
- myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] ''
- $DRY_RUN_CMD ln -s $VERBOSE_ARG \
- ${builtins.toPath ./link-me-directly} $HOME
- '';
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n myActivationAction = lib.hm.dag.entryAfter [\"writeBoundary\"] ''\n \$DRY_RUN_CMD ln -s \$VERBOSE_ARG \\\n \${builtins.toPath ./link-me-directly} \$HOME\n '';\n}\n";
+ }
+
+ Declared by: home.extraOutputsToInstallList of additional package outputs of the packages
home.packages that should be installed into
@@ -1162,7 +1194,11 @@ containing that text.
<home-manager/modules/files.nix>
|
home.file.<name>.targetPath to target file relative to HOME.
Type: string Default:
- <name>
+
+ {
+ _type = "literalExpression"; text = "<name>";
+ }
+
Declared by: home.file.<name>.textText of the file. If this option is null then
@@ -1173,9 +1209,11 @@ must be set.
Declared by: home.homeDirectoryThe user's home directory. Must be an absolute path. Type: path Default:
- "$HOME" for state version < 20.09,
-undefined for state version ≥ 20.09
-
+
+ {
+ _type = "literalExpression"; text = "\"\$HOME\" for state version < 20.09,\nundefined for state version ≥ 20.09\n";
+ }
+
Example:
"/home/jane.doe"
Declared by:
@@ -1196,7 +1234,11 @@ configuration will be used.
This defaults to null for state
version ≥ 19.09 and "us" otherwise.
Type: null or string Default:
- null
+
+ {
+ _type = "literalExpression"; text = "null";
+ }
+
Declared by: home.keyboard.modelKeyboard model.
@@ -1227,7 +1269,11 @@ system configuration will be used.
This defaults to null for state
version ≥ 19.09 and "" otherwise.
Type: null or string Default:
- null
+
+ {
+ _type = "literalExpression"; text = "null";
+ }
+
Example:
"colemak"
Declared by:
@@ -1372,9 +1418,11 @@ conversion or moving files.
Declared by: home.usernameThe user's username. Type: string Default:
- "$USER" for state version < 20.09,
-undefined for state version ≥ 20.09
-
+
+ {
+ _type = "literalExpression"; text = "\"\$USER\" for state version < 20.09,\nundefined for state version ≥ 20.09\n";
+ }
+
Example:
"jane.doe"
Declared by:
@@ -1413,7 +1461,13 @@ Currently the following input methods are available in Home Manager:
]
- Example: with pkgs.fcitx-engines; [ mozc hangul ] Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "with pkgs.fcitx-engines; [ mozc hangul ]";
+ }
+
+ Declared by: i18n.inputMethod.fcitx5.addonsEnabled Fcitx5 addons.
Type: list of packages Default:
@@ -1422,7 +1476,13 @@ Currently the following input methods are available in Home Manager:
]
- Example: with pkgs; [ fcitx5-rime ] Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "with pkgs; [ fcitx5-rime ]";
+ }
+
+ Declared by: i18n.inputMethod.kime.configkime configuration. Refer to
https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md
@@ -1433,22 +1493,13 @@ for details on supported values.
}
- Example: {
- daemon = {
- modules = ["Xim" "Indicator"];
- };
-
- indicator = {
- icon_color = "White";
- };
-
- engine = {
- hangul = {
- layout = "dubeolsik";
- };
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n daemon = {\n modules = [\"Xim\" \"Indicator\"];\n };\n\n indicator = {\n icon_color = \"White\";\n };\n\n engine = {\n hangul = {\n layout = \"dubeolsik\";\n };\n };\n}\n";
+ }
+
+ Declared by: i18n.inputMethod.uim.toolbarSelected UIM toolbar.
Type: one of "gtk", "gtk3", "gtk-systray", "gtk3-systray", "qt4" Default:
@@ -1576,15 +1627,13 @@ applies within the Home Manager configuration. See
works both internally and externally.
Type: null or list of nixpkgs overlays Default:
null
- Example: [ (self: super: {
- openssh = super.openssh.override {
- hpnSupport = true;
- withKerberos = true;
- kerberos = self.libkrb5;
- };
- };
-) ]
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[ (self: super: {\n openssh = super.openssh.override {\n hpnSupport = true;\n withKerberos = true;\n kerberos = self.libkrb5;\n };\n };\n) ]\n";
+ }
+
+ Declared by: pam.sessionVariablesEnvironment variables that will be set for the PAM session.
The variable values must be as described in
@@ -1656,7 +1705,11 @@ message = Message from above
Declared by: programs.alacritty.packageThe Alacritty package to install. Type: package Default:
- pkgs.alacritty
+
+ {
+ _type = "literalExpression"; text = "pkgs.alacritty";
+ }
+
Declared by: programs.alacritty.settingsConfiguration written to
@@ -1669,20 +1722,13 @@ for the default configuration.
}
- Example: {
- window.dimensions = {
- lines = 3;
- columns = 200;
- };
- key_bindings = [
- {
- key = "K";
- mods = "Control";
- chars = "\\x0c";
- }
- ];
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n window.dimensions = {\n lines = 3;\n columns = 200;\n };\n key_bindings = [\n {\n key = \"K\";\n mods = \"Control\";\n chars = \"\\\\x0c\";\n }\n ];\n}\n";
+ }
+
+ Declared by: programs.alot.enableWhether to enable the Alot mail user agent. Alot uses the
Notmuch email system and will therefore be automatically
@@ -1767,12 +1813,13 @@ enabled for each email account that is managed by Notmuch.
auto_remove_unread = true; handle_mouse = true; initial_command = "search tag:inbox AND NOT tag:killed"; prefer_plaintext = true;
}
- Example: {
- auto_remove_unread = true;
- ask_subject = false;
- thread_indent_replies = 2;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n auto_remove_unread = true;\n ask_subject = false;\n thread_indent_replies = 2;\n}\n";
+ }
+
+ Declared by: programs.alot.tagsHow to display the tags. Type: attribute set of submodules Default:
@@ -1827,14 +1874,13 @@ for options.
}
- Example: {
- listen-port = 60000;
- dht-listen-port = 60000;
- seed-ratio = 1.0;
- max-upload-limit = "50K";
- ftp-pasv = true;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n listen-port = 60000;\n dht-listen-port = 60000;\n seed-ratio = 1.0;\n max-upload-limit = \"50K\";\n ftp-pasv = true;\n}\n";
+ }
+
+ Declared by: programs.astroid.enableWhether to enable Astroid. Type: boolean Default:
false
@@ -1859,10 +1905,13 @@ See Example: {
- poll.interval = 0;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n poll.interval = 0;\n}\n";
+ }
+
+ Declared by: programs.astroid.pollScriptScript to run to fetch/update mails.
Type: string Default:
@@ -1894,7 +1943,11 @@ key to open the Atuin history.
Declared by: programs.atuin.packageThe package to use for atuin. Type: package Default:
- pkgs.atuin
+
+ {
+ _type = "literalExpression"; text = "pkgs.atuin";
+ }
+
Declared by: programs.atuin.settingsConfiguration written to
@@ -1908,13 +1961,13 @@ of options.
}
- Example: {
- auto_sync = true;
- sync_frequency = "5m";
- sync_address = "https://api.atuin.sh";
- search_mode = "prefix";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n auto_sync = true;\n sync_frequency = \"5m\";\n sync_address = \"https://api.atuin.sh\";\n search_mode = \"prefix\";\n}\n";
+ }
+
+ Declared by: programs.autojump.enableWhether to enable autojump. Type: boolean Default:
false
@@ -1949,31 +2002,13 @@ of options.
}
- Example: {
- postswitch = {
- "notify-i3" = "${pkgs.i3}/bin/i3-msg restart";
- "change-background" = readFile ./change-background.sh;
- "change-dpi" = ''
- case "$AUTORANDR_CURRENT_PROFILE" in
- default)
- DPI=120
- ;;
- home)
- DPI=192
- ;;
- work)
- DPI=144
- ;;
- *)
- echo "Unknown profle: $AUTORANDR_CURRENT_PROFILE"
- exit 1
- esac
-
- echo "Xft.dpi: $DPI" | ${pkgs.xorg.xrdb}/bin/xrdb -merge
- ''
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n postswitch = {\n \"notify-i3\" = \"\${pkgs.i3}/bin/i3-msg restart\";\n \"change-background\" = readFile ./change-background.sh;\n \"change-dpi\" = ''\n case \"\$AUTORANDR_CURRENT_PROFILE\" in\n default)\n DPI=120\n ;;\n home)\n DPI=192\n ;;\n work)\n DPI=144\n ;;\n *)\n echo \"Unknown profle: \$AUTORANDR_CURRENT_PROFILE\"\n exit 1\n esac\n\n echo \"Xft.dpi: \$DPI\" | \${pkgs.xorg.xrdb}/bin/xrdb -merge\n ''\n };\n}\n";
+ }
+
+ Declared by: programs.autorandr.hooks.postswitchPostswitch hook executed after mode switch. Type: attribute set of strings concatenated with "\n"s Default:
@@ -2006,29 +2041,13 @@ of options.
}
- Example: {
- "work" = {
- fingerprint = {
- eDP1 = "<EDID>";
- DP1 = "<EDID>";
- };
- config = {
- eDP1.enable = false;
- DP1 = {
- enable = true;
- crtc = 0;
- primary = true;
- position = "0x0";
- mode = "3840x2160";
- gamma = "1.0:0.909:0.833";
- rate = "60.00";
- rotate = "left";
- };
- };
- hooks.postswitch = readFile ./work-postswitch.sh;
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n \"work\" = {\n fingerprint = {\n eDP1 = \"<EDID>\";\n DP1 = \"<EDID>\";\n };\n config = {\n eDP1.enable = false;\n DP1 = {\n enable = true;\n crtc = 0;\n primary = true;\n position = \"0x0\";\n mode = \"3840x2160\";\n gamma = \"1.0:0.909:0.833\";\n rate = \"60.00\";\n rotate = \"left\";\n };\n };\n hooks.postswitch = readFile ./work-postswitch.sh;\n };\n}\n";
+ }
+
+ Declared by: programs.autorandr.profiles.<name>.configPer output profile configuration. Type: attribute set of submodules Default:
@@ -2102,11 +2121,13 @@ This option is a shortcut version of the transform option and they are mutually
exclusive.
Type: null or submodule Default:
null
- Example: {
- x = 1.25;
- y = 1.25;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n x = 1.25;\n y = 1.25;\n}\n";
+ }
+
+ Declared by: programs.autorandr.profiles.<name>.config.<name>.scale.methodOutput scaling method. Type: one of "factor", "pixel" Default:
"factor"
@@ -2123,12 +2144,13 @@ exclusive.
for the documentation of the transform matrix.
Type: null or 3×3 matrix of floating point numbers Default:
null
- Example: [
- [ 0.6 0.0 0.0 ]
- [ 0.0 0.6 0.0 ]
- [ 0.0 0.0 1.0 ]
-]
- Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[\n [ 0.6 0.0 0.0 ]\n [ 0.0 0.6 0.0 ]\n [ 0.0 0.0 1.0 ]\n]\n";
+ }
+
+ Declared by: programs.autorandr.profiles.<name>.fingerprintOutput name to EDID mapping.
Use autorandr --fingerprint to get current setup values.
@@ -2257,11 +2279,13 @@ this option) to command strings or directly to build outputs.
}
- Example: {
- ll = "ls -l";
- ".." = "cd ..";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n ll = \"ls -l\";\n \"..\" = \"cd ..\";\n}\n";
+ }
+
+ Declared by: programs.bash.shellOptionsShell options to set. Prefix an option with
“-” to unset.
@@ -2311,15 +2335,13 @@ this option) to command strings or directly to build outputs.
}
- Example: {
- dracula = builtins.readFile (pkgs.fetchFromGitHub {
- owner = "dracula";
- repo = "sublime"; # Bat uses sublime syntax for its themes
- rev = "26c57ec282abcaa76e57e055f38432bd827ac34e";
- sha256 = "019hfl4zbn4vm4154hh3bwk6hm7bdxbr1hdww83nabxwjn99ndhv";
- } + "/Dracula.tmTheme");
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n dracula = builtins.readFile (pkgs.fetchFromGitHub {\n owner = \"dracula\";\n repo = \"sublime\"; # Bat uses sublime syntax for its themes\n rev = \"26c57ec282abcaa76e57e055f38432bd827ac34e\";\n sha256 = \"019hfl4zbn4vm4154hh3bwk6hm7bdxbr1hdww83nabxwjn99ndhv\";\n } + \"/Dracula.tmTheme\");\n}\n";
+ }
+
+ Declared by: programs.beets.enableWhether to enable the beets music library manager. This
defaults to false for state
@@ -2332,8 +2354,18 @@ version ≥ 19.03. For earlier versions beets is enabled if
|
programs.beets.packageThe beets package to use.
Can be used to specify extensions.
Type: package Default:
- pkgs.beets
- Example: (pkgs.beets.override { enableCheck = true; })Declared by:
+
+ {
+ _type = "literalExpression"; text = "pkgs.beets";
+ }
+
+ Example:
+
+ {
+ _type = "literalExpression"; text = "(pkgs.beets.override { enableCheck = true; })";
+ }
+
+ Declared by: programs.beets.settingsConfiguration written to
~/.config/beets/config.yaml
@@ -2353,7 +2385,11 @@ customizable interface. Type: boole
Declared by: programs.bottom.packagePackage providing bottom. Type: package Default:
- pkgs.bottom
+
+ {
+ _type = "literalExpression"; text = "pkgs.bottom";
+ }
+
Declared by: programs.bottom.settingsConfiguration written to
@@ -2368,17 +2404,13 @@ for the default configuration.
}
- Example: {
- flags = {
- avg_cpu = true;
- temperature_type = "c";
- };
-
- colors = {
- low_battery_color = "red";
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n flags = {\n avg_cpu = true;\n temperature_type = \"c\";\n };\n\n colors = {\n low_battery_color = \"red\";\n };\n}\n";
+ }
+
+ Declared by: programs.broot.enableWhether to enable Broot, a better way to navigate directories. Type: boolean Default:
false
@@ -2402,7 +2434,11 @@ for the default configuration.
Declared by: programs.broot.packagePackage providing broot Type: package Default:
- pkgs.broot
+
+ {
+ _type = "literalExpression"; text = "pkgs.broot";
+ }
+
Declared by: programs.broot.modalWhether to enable modal (vim) mode. Type: boolean Default:
@@ -2424,23 +2460,13 @@ Add _fg for a foreground color and
}
- Example: {
- status_normal_fg = "grayscale(18)";
- status_normal_bg = "grayscale(3)";
- status_error_fg = "red";
- status_error_bg = "yellow";
- tree_fg = "red";
- selected_line_bg = "grayscale(7)";
- permissions_fg = "grayscale(12)";
- size_bar_full_bg = "red";
- size_bar_void_bg = "black";
- directory_fg = "lightyellow";
- input_fg = "cyan";
- flag_value_fg = "lightyellow";
- table_border_fg = "red";
- code_fg = "lightyellow";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n status_normal_fg = \"grayscale(18)\";\n status_normal_bg = \"grayscale(3)\";\n status_error_fg = \"red\";\n status_error_bg = \"yellow\";\n tree_fg = \"red\";\n selected_line_bg = \"grayscale(7)\";\n permissions_fg = \"grayscale(12)\";\n size_bar_full_bg = \"red\";\n size_bar_void_bg = \"black\";\n directory_fg = \"lightyellow\";\n input_fg = \"cyan\";\n flag_value_fg = \"lightyellow\";\n table_border_fg = \"red\";\n code_fg = \"lightyellow\";\n}\n";
+ }
+
+ Declared by: programs.broot.verbsDefine new verbs. For more information, see
https://dystroy.org/broot/documentation/configuration/#verb-definition-attributes.
@@ -2474,18 +2500,13 @@ The possible attributes are:
]
- Example: [
- { invocation = "p"; execution = ":parent"; }
- { invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; }
- { invocation = "create {subpath}"; execution = "$EDITOR {directory}/{subpath}"; }
- { invocation = "view"; execution = "less {file}"; }
- {
- invocation = "blop {name}\\.{type}";
- execution = "/bin/mkdir {parent}/{type} && /usr/bin/nvim {parent}/{type}/{name}.{type}";
- from_shell = true;
- }
-]
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[\n { invocation = \"p\"; execution = \":parent\"; }\n { invocation = \"edit\"; shortcut = \"e\"; execution = \"\$EDITOR {file}\" ; }\n { invocation = \"create {subpath}\"; execution = \"\$EDITOR {directory}/{subpath}\"; }\n { invocation = \"view\"; execution = \"less {file}\"; }\n {\n invocation = \"blop {name}\\\\.{type}\";\n execution = \"/bin/mkdir {parent}/{type} && /usr/bin/nvim {parent}/{type}/{name}.{type}\";\n from_shell = true;\n }\n]\n";
+ }
+
+ Declared by: programs.browserpass.enableWhether to enable the browserpass extension host application. Type: boolean Default:
false
@@ -2514,7 +2535,11 @@ The possible attributes are:
Declared by: programs.chromium.packageThe Chromium package to use. Type: package Default:
- pkgs.chromium
+
+ {
+ _type = "literalExpression"; text = "pkgs.chromium";
+ }
+
Declared by: programs.chromium.extensionsList of Chromium extensions to install.
@@ -2532,19 +2557,13 @@ documentation.
]
- Example: [
- { id = "cjpalhdlnbpafiamejdnhcphjbkeiagm"; } # ublock origin
- {
- id = "dcpihecpambacapedldabdbpakmachpb";
- updateUrl = "https://raw.githubusercontent.com/iamadamdev/bypass-paywalls-chrome/master/updates.xml";
- }
- {
- id = "aaaaaaaaaabbbbbbbbbbcccccccccc";
- crxPath = "/home/share/extension.crx";
- version = "1.0";
- }
-]
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[\n { id = \"cjpalhdlnbpafiamejdnhcphjbkeiagm\"; } # ublock origin\n {\n id = \"dcpihecpambacapedldabdbpakmachpb\";\n updateUrl = \"https://raw.githubusercontent.com/iamadamdev/bypass-paywalls-chrome/master/updates.xml\";\n }\n {\n id = \"aaaaaaaaaabbbbbbbbbbcccccccccc\";\n crxPath = \"/home/share/extension.crx\";\n version = \"1.0\";\n }\n]\n";
+ }
+
+ Declared by: programs.chromium.extensions.*.crxPathPath to the extension's crx file. Linux only.
Type: null or path Default:
@@ -2614,12 +2633,13 @@ for options.
}
- Example: {
- OTHER_WRITABLE = "30;46";
- ".sh" = "01;32";
- ".csh" = "01;32";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n OTHER_WRITABLE = \"30;46\";\n \".sh\" = \"01;32\";\n \".csh\" = \"01;32\";\n}\n";
+ }
+
+ Declared by: programs.direnv.enableWhether to enable direnv, the environment switcher. Type: boolean Default:
false
@@ -2691,8 +2711,18 @@ necessary to use the Lombok class annotations.
<home-manager/modules/programs/eclipse.nix>
|
programs.eclipse.packageThe Eclipse package to install.
Type: package Default:
- pkgs.eclipses.eclipse-platform
- Example: pkgs.eclipses.eclipse-java Declared by:
+
+ {
+ _type = "literalExpression"; text = "pkgs.eclipses.eclipse-platform";
+ }
+
+ Example:
+
+ {
+ _type = "literalExpression"; text = "pkgs.eclipses.eclipse-java";
+ }
+
+ Declared by: programs.eclipse.jvmArgsJVM arguments to use for the Eclipse process. Type: list of strings Default:
@@ -2717,8 +2747,18 @@ necessary to use the Lombok class annotations.
Declared by: programs.emacs.packageThe Emacs package to use. Type: package Default:
- pkgs.emacs
- Example: pkgs.emacs25-nox Declared by:
+
+ {
+ _type = "literalExpression"; text = "pkgs.emacs";
+ }
+
+ Example:
+
+ {
+ _type = "literalExpression"; text = "pkgs.emacs25-nox";
+ }
+
+ Declared by: programs.emacs.extraConfigConfiguration to include in the Emacs default init file. See
https://www.gnu.org/software/emacs/manual/html_node/elisp/Init-File.html
@@ -2734,16 +2774,24 @@ available packages run:
nix-env -f '<nixpkgs>' -qaP -A emacsPackages.
Type: Function that takes an attribute set and returns a list containing a selection of the values of the input set Default:
"epkgs: []"
- Example: epkgs: [ epkgs.emms epkgs.magit ] Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "epkgs: [ epkgs.emms epkgs.magit ]";
+ }
+
+ Declared by: programs.emacs.overridesAllows overriding packages within the Emacs package set.
Type: An overlay function, takes self and super and returns an attribute set overriding the desired attributes. Default:
"self: super: {}"
- Example: self: super: rec {
- haskell-mode = self.melpaPackages.haskell-mode;
- # ...
-};
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "self: super: rec {\n haskell-mode = self.melpaPackages.haskell-mode;\n # ...\n};\n";
+ }
+
+ Declared by: programs.exa.enableWhether to enable exa, a modern replacement for ls. Type: boolean Default:
false
@@ -2827,17 +2875,18 @@ also need to set the NixOS option
this should be a wrapped Firefox package. For earlier state
versions it should be an unwrapped Firefox package.
Type: package Default:
- pkgs.firefox
- Example: pkgs.firefox.override {
- # See nixpkgs' firefox/wrapper.nix to check which options you can use
- cfg = {
- # Gnome shell native connector
- enableGnomeExtensions = true;
- # Tridactyl native connector
- enableTridactylNative = true;
- };
-}
-Declared by:
+
+ {
+ _type = "literalExpression"; text = "pkgs.firefox";
+ }
+
+ Example:
+
+ {
+ _type = "literalExpression"; text = "pkgs.firefox.override {\n # See nixpkgs' firefox/wrapper.nix to check which options you can use\n cfg = {\n # Gnome shell native connector\n enableGnomeExtensions = true;\n # Tridactyl native connector\n enableTridactylNative = true;\n };\n}\n";
+ }
+
+ Declared by: programs.firefox.extensionsList of Firefox add-on packages to install. Some
pre-packaged add-ons are accessible from NUR,
@@ -2868,11 +2917,13 @@ handles extension side-loading.
]
- Example: with pkgs.nur.repos.rycee.firefox-addons; [
- https-everywhere
- privacy-badger
-]
- Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "with pkgs.nur.repos.rycee.firefox-addons; [\n https-everywhere\n privacy-badger\n]\n";
+ }
+
+ Declared by: programs.firefox.profilesAttribute set of Firefox profiles. Type: attribute set of submodules Default:
@@ -2890,16 +2941,13 @@ previously existing bookmarks!
}
- Example: {
- wikipedia = {
- keyword = "wiki";
- url = "https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go";
- };
- "kernel.org" = {
- url = "https://www.kernel.org";
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n wikipedia = {\n keyword = \"wiki\";\n url = \"https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go\";\n };\n \"kernel.org\" = {\n url = \"https://www.kernel.org\";\n };\n}\n";
+ }
+
+ Declared by: programs.firefox.profiles.<name>.bookmarks.<name>.keywordBookmark search keyword. Type: null or string Default:
null
@@ -2939,15 +2987,13 @@ previously existing bookmarks!
}
- Example: {
- "browser.startup.homepage" = "https://nixos.org";
- "browser.search.region" = "GB";
- "browser.search.isUS" = false;
- "distribution.searchplugins.defaultLocale" = "en-GB";
- "general.useragent.locale" = "en-GB";
- "browser.bookmarks.showMobileBookmarks" = true;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n \"browser.startup.homepage\" = \"https://nixos.org\";\n \"browser.search.region\" = \"GB\";\n \"browser.search.isUS\" = false;\n \"distribution.searchplugins.defaultLocale\" = \"en-GB\";\n \"general.useragent.locale\" = \"en-GB\";\n \"browser.bookmarks.showMobileBookmarks\" = true;\n}\n";
+ }
+
+ Declared by: programs.firefox.profiles.<name>.userChromeCustom Firefox user chrome CSS. Type: strings concatenated with "\n" Default:
""
@@ -2980,7 +3026,11 @@ previously existing bookmarks!
<home-manager/modules/programs/fish.nix>
|
programs.fish.packageThe fish package to install. May be used to change the version.
Type: package Default:
- pkgs.fish
+
+ {
+ _type = "literalExpression"; text = "pkgs.fish";
+ }
+
Declared by: programs.fish.functionsBasic functions to add to fish. For more information see
@@ -2991,15 +3041,13 @@ previously existing bookmarks!
}
- Example: {
- __fish_command_not_found_handler = {
- body = "__fish_default_command_not_found_handler $argv[1]";
- onEvent = "fish_command_not_found";
- };
-
- gitignore = "curl -sL https://www.gitignore.io/api/$argv";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n __fish_command_not_found_handler = {\n body = \"__fish_default_command_not_found_handler \$argv[1]\";\n onEvent = \"fish_command_not_found\";\n };\n\n gitignore = \"curl -sL https://www.gitignore.io/api/\$argv\";\n}\n";
+ }
+
+ Declared by: programs.fish.interactiveShellInitShell script code called during interactive fish shell
initialisation.
@@ -3021,30 +3069,13 @@ initialisation.
]
- Example: [
- {
- name = "z";
- src = pkgs.fetchFromGitHub {
- owner = "jethrokuan";
- repo = "z";
- rev = "ddeb28a7b6a1f0ec6dae40c636e5ca4908ad160a";
- sha256 = "0c5i7sdrsp0q3vbziqzdyqn4fmp235ax4mn4zslrswvn8g3fvdyh";
- };
- }
-
- # oh-my-fish plugins are stored in their own repositories, which
- # makes them simple to import into home-manager.
- {
- name = "fasd";
- src = pkgs.fetchFromGitHub {
- owner = "oh-my-fish";
- repo = "plugin-fasd";
- rev = "38a5b6b6011106092009549e52249c6d6f501fba";
- sha256 = "06v37hqy5yrv5a6ssd1p3cjd9y3hnp19d3ab7dag56fs1qmgyhbs";
- };
- }
-]
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[\n {\n name = \"z\";\n src = pkgs.fetchFromGitHub {\n owner = \"jethrokuan\";\n repo = \"z\";\n rev = \"ddeb28a7b6a1f0ec6dae40c636e5ca4908ad160a\";\n sha256 = \"0c5i7sdrsp0q3vbziqzdyqn4fmp235ax4mn4zslrswvn8g3fvdyh\";\n };\n }\n\n # oh-my-fish plugins are stored in their own repositories, which\n # makes them simple to import into home-manager.\n {\n name = \"fasd\";\n src = pkgs.fetchFromGitHub {\n owner = \"oh-my-fish\";\n repo = \"plugin-fasd\";\n rev = \"38a5b6b6011106092009549e52249c6d6f501fba\";\n sha256 = \"06v37hqy5yrv5a6ssd1p3cjd9y3hnp19d3ab7dag56fs1qmgyhbs\";\n };\n }\n]\n";
+ }
+
+ Declared by: programs.fish.plugins.*.nameThe name of the plugin.
Type: string Declared by:
@@ -3087,11 +3118,13 @@ in this option) to command strings or directly to build outputs.
}
- Example: {
- g = "git";
- "..." = "cd ../..";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n g = \"git\";\n \"...\" = \"cd ../..\";\n}\n";
+ }
+
+ Declared by: programs.fish.shellInitShell script code called during fish shell
initialisation.
@@ -3106,7 +3139,11 @@ initialisation.
Declared by: programs.foot.packageThe foot package to install Type: package Default:
- pkgs.foot
+
+ {
+ _type = "literalExpression"; text = "pkgs.foot";
+ }
+
Declared by: programs.foot.server.enableWhether to enable Foot terminal server. Type: boolean Default:
@@ -3124,19 +3161,13 @@ for a list of available options.
}
- Example: {
- main = {
- term = "xterm-256color";
-
- font = "Fira Code:size=11";
- dpi-aware = "yes";
- };
-
- mouse = {
- hide-when-typing = "yes";
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n main = {\n term = \"xterm-256color\";\n\n font = \"Fira Code:size=11\";\n dpi-aware = \"yes\";\n };\n\n mouse = {\n hide-when-typing = \"yes\";\n };\n}\n";
+ }
+
+ Declared by: programs.fzf.enableWhether to enable fzf - a command-line fuzzy finder. Type: boolean Default:
false
@@ -3160,7 +3191,11 @@ for a list of available options.
Declared by: programs.fzf.packagePackage providing the fzf tool. Type: package Default:
- pkgs.fzf
+
+ {
+ _type = "literalExpression"; text = "pkgs.fzf";
+ }
+
Declared by: programs.fzf.changeDirWidgetCommandThe command that gets executed as the source for fzf for the
@@ -3263,7 +3298,13 @@ See fzf-tmux --help for available
]
- Example: [ "-d 40%" ] Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = ''[ "-d 40%" ]'';
+ }
+
+ Declared by: programs.gh.enableWhether to enable GitHub CLI tool. Type: boolean Default:
false
@@ -3278,11 +3319,13 @@ See fzf-tmux --help for available
}
- Example: {
- co = "pr checkout";
- pv = "pr view";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n co = \"pr checkout\";\n pv = \"pr view\";\n}\n";
+ }
+
+ Declared by: programs.gh.editorThe editor that gh should run when creating issues, pull requests, etc.
If blank, will refer to environment.
@@ -3304,7 +3347,11 @@ If blank, will refer to environment.
|
programs.git.packageGit package to install. Use pkgs.gitAndTools.gitFull
to gain access to git send-email for instance.
Type: package Default:
- pkgs.git
+
+ {
+ _type = "literalExpression"; text = "pkgs.git";
+ }
+
Declared by: programs.git.aliasesGit aliases to define. Type: attribute set of strings Default:
@@ -3410,14 +3457,13 @@ deprecated and will be removed in the future.
]
- Example: [
- { path = "~/path/to/config.inc"; }
- {
- path = "~/path/to/conditional.inc";
- condition = "gitdir:~/src/dir";
- }
-]
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[\n { path = \"~/path/to/config.inc\"; }\n {\n path = \"~/path/to/conditional.inc\";\n condition = \"gitdir:~/src/dir\";\n }\n]\n";
+ }
+
+ Declared by: programs.git.includes.*.conditionInclude this configuration only when condition
matches. Allowed conditions are described in
@@ -3436,17 +3482,13 @@ This follows the configuration structure as described in
}
- Example: {
- user = {
- email = "bob@work.example.com";
- name = "Bob Work";
- signingKey = "1A2B3C4D5E6F7G8H";
- };
- commit = {
- gpgSign = true;
- };
-};
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n user = {\n email = \"bob@work.example.com\";\n name = \"Bob Work\";\n signingKey = \"1A2B3C4D5E6F7G8H\";\n };\n commit = {\n gpgSign = true;\n };\n};\n";
+ }
+
+ Declared by: programs.git.includes.*.pathPath of the configuration file to include. Type: string or path Declared by:
<home-manager/modules/programs/git.nix>
@@ -3642,7 +3684,11 @@ presses the Delete key.
Declared by: programs.go.packageThe Go package to use. Type: package Default:
- pkgs.go
+
+ {
+ _type = "literalExpression"; text = "pkgs.go";
+ }
+
Declared by: programs.go.packagesPackages to add to GOPATH. Type: attribute set of paths Default:
@@ -3651,11 +3697,13 @@ presses the Delete key.
}
- Example: {
- "golang.org/x/text" = builtins.fetchGit "https://go.googlesource.com/text";
- "golang.org/x/time" = builtins.fetchGit "https://go.googlesource.com/time";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n \"golang.org/x/text\" = builtins.fetchGit \"https://go.googlesource.com/text\";\n \"golang.org/x/time\" = builtins.fetchGit \"https://go.googlesource.com/time\";\n}\n";
+ }
+
+ Declared by: programs.go.extraGoPathsExtra GOPATHs relative to HOME appended
after
@@ -3715,31 +3763,56 @@ or checksum database.
Declared by: programs.gpg.packageThe Gnupg package to use (also used the gpg-agent service). Type: package Default:
- pkgs.gnupg
- Example: pkgs.gnupg23 Declared by:
+
+ {
+ _type = "literalExpression"; text = "pkgs.gnupg";
+ }
+
+ Example:
+
+ {
+ _type = "literalExpression"; text = "pkgs.gnupg23";
+ }
+
+ Declared by: programs.gpg.homedirDirectory to store keychains and configuration. Type: path Default:
- "${config.home.homeDirectory}/.gnupg"
- Example: "${config.xdg.dataHome}/gnupg"Declared by:
+
+ {
+ _type = "literalExpression"; text = ''"''${config.home.homeDirectory}/.gnupg"'';
+ }
+
+ Example:
+
+ {
+ _type = "literalExpression"; text = ''"''${config.xdg.dataHome}/gnupg"'';
+ }
+
+ Declared by: programs.gpg.scdaemonSettingsSCdaemon configuration options. Available options are described
in the gpg scdaemon manpage:
https://www.gnupg.org/documentation/manuals/gnupg/Scdaemon-Options.html.
- Type: attribute set of string or boolean or list of stringss Example: {
- disable-ccid = true;
-}
-Declared by:
+Type: attribute set of string or boolean or list of stringss Example:
+
+ {
+ _type = "literalExpression"; text = "{\n disable-ccid = true;\n}\n";
+ }
+
+ Declared by: programs.gpg.settingsGnuPG configuration options. Available options are described
in the gpg manpage:
https://gnupg.org/documentation/manpage.html.
Note that lists are converted to duplicate keys.
- Type: attribute set of string or boolean or list of stringss Example: {
- no-comments = false;
- s2k-cipher-algo = "AES128";
-}
-Declared by: programs.himalaya.packagePackage providing the himalaya mail client.
Type: package Default:
- pkgs.himalaya
+
+ {
+ _type = "literalExpression"; text = "pkgs.himalaya";
+ }
+
Declared by: programs.himalaya.settingsGlobal himalaya configuration values.
@@ -3759,10 +3836,13 @@ Note that lists are converted to duplicate keys.
}
- Example: {
- default-page-size = 50;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n default-page-size = 50;\n}\n";
+ }
+
+ Declared by: programs.home-manager.enableWhether to enable Home Manager. Type: boolean Default:
false
@@ -3795,39 +3875,13 @@ attempted.
}
- Example: {
- color_scheme = 6;
- cpu_count_from_one = 0;
- delay = 15;
- fields = with config.lib.htop.fields; [
- PID
- USER
- PRIORITY
- NICE
- M_SIZE
- M_RESIDENT
- M_SHARE
- STATE
- PERCENT_CPU
- PERCENT_MEM
- TIME
- COMM
- ];
- highlight_base_name = 1;
- highlight_megabytes = 1;
- highlight_threads = 1;
-} // (with config.lib.htop; leftMeters [
- (bar "AllCPUs2")
- (bar "Memory")
- (bar "Swap")
- (text "Zram")
-]) // (with config.lib.htop; rightMeters [
- (text "Tasks")
- (text "LoadAverage")
- (text "Uptime")
- (text "Systemd")
-]);
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n color_scheme = 6;\n cpu_count_from_one = 0;\n delay = 15;\n fields = with config.lib.htop.fields; [\n PID\n USER\n PRIORITY\n NICE\n M_SIZE\n M_RESIDENT\n M_SHARE\n STATE\n PERCENT_CPU\n PERCENT_MEM\n TIME\n COMM\n ];\n highlight_base_name = 1;\n highlight_megabytes = 1;\n highlight_threads = 1;\n} // (with config.lib.htop; leftMeters [\n (bar \"AllCPUs2\")\n (bar \"Memory\")\n (bar \"Swap\")\n (text \"Zram\")\n]) // (with config.lib.htop; rightMeters [\n (text \"Tasks\")\n (text \"LoadAverage\")\n (text \"Uptime\")\n (text \"Systemd\")\n]);\n";
+ }
+
+ Declared by: programs.i3status.enableWhether to enable i3status. Type: boolean Default:
false
@@ -3852,14 +3906,13 @@ for options.
}
- Example: {
- colors = true;
- color_good = "#e0e0e0";
- color_degraded = "#d7ae00";
- color_bad = "#f69d6a";
- interval = 1;
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n colors = true;\n color_good = \"#e0e0e0\";\n color_degraded = \"#d7ae00\";\n color_bad = \"#f69d6a\";\n interval = 1;\n}\n";
+ }
+
+ Declared by: programs.i3status.modulesModules to add to i3status config file.
See
@@ -3871,23 +3924,13 @@ for options.
}
- Example: {
- "volume master" = {
- position = 1;
- settings = {
- format = "♪ %volume";
- format_muted = "♪ muted (%volume)";
- device = "pulse:1";
- };
- };
- "disk /" = {
- position = 2;
- settings = {
- format = "/ %avail";
- };
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n \"volume master\" = {\n position = 1;\n settings = {\n format = \"♪ %volume\";\n format_muted = \"♪ muted (%volume)\";\n device = \"pulse:1\";\n };\n };\n \"disk /\" = {\n position = 2;\n settings = {\n format = \"/ %avail\";\n };\n };\n}\n";
+ }
+
+ Declared by: programs.i3status.modules.<name>.enableWhether or not to enable this module.
Type: boolean Default:
@@ -3907,12 +3950,13 @@ for options.
}
- Example: {
- format = "♪ %volume";
- format_muted = "♪ muted (%volume)";
- device = "pulse:1";
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n format = \"♪ %volume\";\n format_muted = \"♪ muted (%volume)\";\n device = \"pulse:1\";\n}\n";
+ }
+
+ Declared by: programs.i3status-rust.enableWhether to enable a replacement for i3-status written in Rust. Type: boolean Default:
false
@@ -3921,7 +3965,11 @@ for options.
Declared by: programs.i3status-rust.packagePackage providing i3status-rust Type: package Default:
- pkgs.i3status-rust
+
+ {
+ _type = "literalExpression"; text = "pkgs.i3status-rust";
+ }
+
Declared by: programs.i3status-rust.barsAttribute set of i3status-rust bars, each with their own configuration.
@@ -3973,53 +4021,13 @@ for options.
;
}
- Example: bottom = {
- blocks = [
- {
- block = "disk_space";
- path = "/";
- alias = "/";
- info_type = "available";
- unit = "GB";
- interval = 60;
- warning = 20.0;
- alert = 10.0;
- }
- {
- block = "memory";
- display_type = "memory";
- format_mem = "{mem_used_percents}";
- format_swap = "{swap_used_percents}";
- }
- {
- block = "cpu";
- interval = 1;
- }
- {
- block = "load";
- interval = 1;
- format = "{1m}";
- }
- { block = "sound"; }
- {
- block = "time";
- interval = 60;
- format = "%a %d/%m %R";
- }
- ];
- settings = {
- theme = {
- name = "solarized-dark";
- overrides = {
- idle_bg = "#123456";
- idle_fg = "#abcdef";
- };
- };
- };
- icons = "awesome5";
- theme = "gruvbox-dark";
-};
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "bottom = {\n blocks = [\n {\n block = \"disk_space\";\n path = \"/\";\n alias = \"/\";\n info_type = \"available\";\n unit = \"GB\";\n interval = 60;\n warning = 20.0;\n alert = 10.0;\n }\n {\n block = \"memory\";\n display_type = \"memory\";\n format_mem = \"{mem_used_percents}\";\n format_swap = \"{swap_used_percents}\";\n }\n {\n block = \"cpu\";\n interval = 1;\n }\n {\n block = \"load\";\n interval = 1;\n format = \"{1m}\";\n }\n { block = \"sound\"; }\n {\n block = \"time\";\n interval = 60;\n format = \"%a %d/%m %R\";\n }\n ];\n settings = {\n theme = {\n name = \"solarized-dark\";\n overrides = {\n idle_bg = \"#123456\";\n idle_fg = \"#abcdef\";\n };\n };\n };\n icons = \"awesome5\";\n theme = \"gruvbox-dark\";\n};\n";
+ }
+
+ Declared by: programs.i3status-rust.bars.<name>.blocksConfiguration blocks to add to i3status-rust
config. See
@@ -4055,28 +4063,13 @@ for block options.
]
- Example: [
- {
- block = "disk_space";
- path = "/";
- alias = "/";
- info_type = "available";
- unit = "GB";
- interval = 60;
- warning = 20.0;
- alert = 10.0;
- }
- {
- block = "sound";
- format = "{output_name} {volume}%";
- on_click = "pavucontrol --tab=3";
- mappings = {
- "alsa_output.pci-0000_00_1f.3.analog-stereo" = "";
- "bluez_sink.70_26_05_DA_27_A4.a2dp_sink" = "";
- };
- }
-];
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "[\n {\n block = \"disk_space\";\n path = \"/\";\n alias = \"/\";\n info_type = \"available\";\n unit = \"GB\";\n interval = 60;\n warning = 20.0;\n alert = 10.0;\n }\n {\n block = \"sound\";\n format = \"{output_name} {volume}%\";\n on_click = \"pavucontrol --tab=3\";\n mappings = {\n \"alsa_output.pci-0000_00_1f.3.analog-stereo\" = \"\";\n \"bluez_sink.70_26_05_DA_27_A4.a2dp_sink\" = \"\";\n };\n }\n];\n";
+ }
+
+ Declared by: programs.i3status-rust.bars.<name>.iconsThe icons set to use. See
https://github.com/greshake/i3status-rust/blob/master/themes.md
@@ -4095,16 +4088,13 @@ for a list of available icon sets.
}
- Example: {
- theme = {
- name = "solarized-dark";
- overrides = {
- idle_bg = "#123456";
- idle_fg = "#abcdef";
- };
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n theme = {\n name = \"solarized-dark\";\n overrides = {\n idle_bg = \"#123456\";\n idle_fg = \"#abcdef\";\n };\n };\n}\n";
+ }
+
+ Declared by: programs.i3status-rust.bars.<name>.themeThe theme to use. See
https://github.com/greshake/i3status-rust/blob/master/themes.md
@@ -4151,20 +4141,13 @@ for a list of available themes.
}
- Example: {
- freenode = {
- nick = "hmuser";
- server = {
- address = "chat.freenode.net";
- port = 6697;
- autoConnect = true;
- };
- channels = {
- nixos.autoJoin = true;
- };
- };
-}
-Declared by:
+ Example:
+
+ {
+ _type = "literalExpression"; text = "{\n freenode = {\n nick = \"hmuser\";\n server = {\n address = \"chat.freenode.net\";\n port = 6697;\n autoConnect = true;\n };\n channels = {\n nixos.autoJoin = true;\n };\n };\n}\n";
+ }
+
+ Declared by: programs.irssi.networks.<name>.autoCommandsList of commands to execute on connect. Type: list of strings Default:
@@ -4237,7 +4220,11 @@ variable.
Declared by: programs.jq.packagejq package to use. Type: package Default:
- pkgs.jq
+
+ {
+ _type = "literalExpression"; text = "pkgs.jq";
+ }
+
Declared by: programs.jq.colorsThe colors used in colored JSON output. See https://stedolan.github.io/jq/manual/#Colors.
@@ -4247,16 +4234,13 @@ variable.
arrays = "1;37"; false = "0;37"; null = "1;30"; numbers = "0;37"; objects = "1;37"; strings = "0;32"; true = "0;37";
}
- Example: {
- null = "1;30";
- false = "0;31";
- true = "0;32";
- numbers = "0;36";
- strings = "0;33";
- arrays = "1;35";
- objects = "1;37";
-}
-Declared by: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|