diff --git a/data/options.json b/data/options.json index bb04578..330ee39 100644 --- a/data/options.json +++ b/data/options.json @@ -1,5 +1,5 @@ { - "last_update": "Fri, 11 Oct 2024 02:20:33 GMT", + "last_update": "Sat, 12 Oct 2024 02:18:11 GMT", "options": [ { "title": "_module.args", @@ -10387,6 +10387,412 @@ "default": "\"\"", "example": null }, + { + "title": "programs.floorp.enable", + "description": "Whether to enable Floorp.", + "type": "boolean", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "false", + "example": "true" + }, + { + "title": "programs.floorp.enableGnomeExtensions", + "description": "Whether to enable the GNOME Shell native host connector. Note, you also need to set the NixOS option\nservices.gnome.gnome-browser-connector.enable to\ntrue.", + "type": "boolean", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "false", + "example": null + }, + { + "title": "programs.floorp.package", + "description": "The Floorp package to use. If state version ≥ 19.09 then this should be a wrapped Floorp package. For earlier state\nversions it should be an unwrapped Floorp package.\nSet to null to disable installing Floorp.", + "type": "null or package", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "pkgs.floorp", + "example": "pkgs.floorp.override {\n # See nixpkgs' firefox/wrapper.nix to check which options you can use\n nativeMessagingHosts = [\n # Gnome shell native connector\n pkgs.gnome-browser-connector\n # Tridactyl native connector\n pkgs.tridactyl-native\n ];\n}\n\n" + }, + { + "title": "programs.floorp.finalPackage", + "description": "Resulting Floorp package.", + "type": "null or package (read only)", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": null, + "example": null + }, + { + "title": "programs.floorp.languagePacks", + "description": "The language packs to install. Available language codes can be found on the releases page:\nhttps://releases.mozilla.org/pub/firefox/releases/${version}/linux-x86_64/xpi/,\nreplacing ${version} with the version of Firefox you have.", + "type": "list of string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "[ ]", + "example": "[\n \"en-GB\"\n \"de\"\n]\n" + }, + { + "title": "programs.floorp.nativeMessagingHosts", + "description": "Additional packages containing native messaging hosts that should be made available to Floorp extensions.", + "type": "list of package", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "[ ]", + "example": null + }, + { + "title": "programs.floorp.policies", + "description": "See list of policies.", + "type": "attribute set of (JSON value)", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "{ }", + "example": "{\n BlockAboutConfig = true;\n DefaultDownloadDirectory = \"\\${home}/Downloads\";\n}\n" + }, + { + "title": "programs.floorp.profiles", + "description": "Attribute set of Floorp profiles.", + "type": "attribute set of (submodule)", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "{ }", + "example": null + }, + { + "title": "programs.floorp.profiles..bookmarks", + "description": "Preloaded bookmarks. Note, this may silently overwrite any previously existing bookmarks!", + "type": "(list of ((bookmark submodule) or (directory submodule))) or (attribute set of ((bookmark submodule) or (directory submodule))) convertible to it", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "[ ]", + "example": "[\n {\n name = \"wikipedia\";\n tags = [ \"wiki\" ];\n keyword = \"wiki\";\n url = \"https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go\";\n }\n {\n name = \"kernel.org\";\n url = \"https://www.kernel.org\";\n }\n {\n name = \"Nix sites\";\n toolbar = true;\n bookmarks = [\n {\n name = \"homepage\";\n url = \"https://nixos.org/\";\n }\n {\n name = \"wiki\";\n tags = [ \"wiki\" \"nix\" ];\n url = \"https://wiki.nixos.org/\";\n }\n ];\n }\n]\n\n" + }, + { + "title": "programs.floorp.profiles..containers", + "description": "Attribute set of container configurations. See Multi-Account\nContainers\nfor more information.", + "type": "attribute set of (submodule)", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "{ }", + "example": "{\n dangerous = {\n color = \"red\";\n icon = \"fruit\";\n id = 2;\n };\n shopping = {\n color = \"blue\";\n icon = \"cart\";\n id = 1;\n };\n}\n" + }, + { + "title": "programs.floorp.profiles..containers..color", + "description": "Container color.", + "type": "one of “blue”, “turquoise”, “green”, “yellow”, “orange”, “red”, “pink”, “purple”, “toolbar”", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"pink\"", + "example": null + }, + { + "title": "programs.floorp.profiles..containers..icon", + "description": "Container icon.", + "type": "one of “briefcase”, “cart”, “circle”, “dollar”, “fence”, “fingerprint”, “gift”, “vacation”, “food”, “fruit”, “pet”, “tree”, “chill”", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"fruit\"", + "example": null + }, + { + "title": "programs.floorp.profiles..containers..id", + "description": "Container ID. This should be set to a unique number per container in this profile.", + "type": "unsigned integer, meaning >=0", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "0", + "example": null + }, + { + "title": "programs.floorp.profiles..containers..name", + "description": "Container name, e.g., shopping.", + "type": "string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"‹name›\"", + "example": null + }, + { + "title": "programs.floorp.profiles..containersForce", + "description": "Whether to force replace the existing containers configuration. This is recommended since Firefox will replace the symlink on\nevery launch, but note that you’ll lose any existing configuration\nby enabling this.", + "type": "boolean", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "false", + "example": null + }, + { + "title": "programs.floorp.profiles..extensions", + "description": "List of ‹name› add-on packages to install for this profile. Some pre-packaged add-ons are accessible from the\nNix User Repository.\nOnce you have NUR installed run", + "type": "list of package", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": "$ nix-env -f '' -qaP -A nur.repos.rycee.firefox-addons", + "default": "[ ]", + "example": "with pkgs.nur.repos.rycee.firefox-addons; [\n privacy-badger\n]\n\n" + }, + { + "title": "programs.floorp.profiles..extraConfig", + "description": "Extra preferences to add to user.js.", + "type": "strings concatenated with “\\n”", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"\"", + "example": null + }, + { + "title": "programs.floorp.profiles..id", + "description": "Profile ID. This should be set to a unique number per profile.", + "type": "unsigned integer, meaning >=0", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "0", + "example": null + }, + { + "title": "programs.floorp.profiles..isDefault", + "description": "Whether this is a default profile.", + "type": "boolean", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"true if profile ID is 0\"", + "example": null + }, + { + "title": "programs.floorp.profiles..name", + "description": "Profile name.", + "type": "string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"‹name›\"", + "example": null + }, + { + "title": "programs.floorp.profiles..path", + "description": "Profile path.", + "type": "string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"‹name›\"", + "example": null + }, + { + "title": "programs.floorp.profiles..search.default", + "description": "The default search engine used in the address bar and search bar.", + "type": "null or string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "null", + "example": "\"DuckDuckGo\"" + }, + { + "title": "programs.floorp.profiles..search.engines", + "description": "Attribute set of search engine configurations. Engines that only have metaData specified will\nbe treated as builtin to ‹name›.", + "type": "attribute set of attribute set of (JSON value)", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": "See SearchEngine.jsm\nin Firefox’s source for available options. We maintain a\nmapping to let you specify all options in the referenced\nlink without underscores, but it may fall out of date with\nfuture options.", + "default": "{ }", + "example": "{\n \"Nix Packages\" = {\n urls = [{\n template = \"https://search.nixos.org/packages\";\n params = [\n { name = \"type\"; value = \"packages\"; }\n { name = \"query\"; value = \"{searchTerms}\"; }\n ];\n }];\n\n icon = \"${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg\";\n definedAliases = [ \"@np\" ];\n };\n\n \"NixOS Wiki\" = {\n urls = [{ template = \"https://wiki.nixos.org/index.php?search={searchTerms}\"; }];\n iconUpdateURL = \"https://wiki.nixos.org/favicon.png\";\n updateInterval = 24 * 60 * 60 * 1000; # every day\n definedAliases = [ \"@nw\" ];\n };\n\n \"Bing\".metaData.hidden = true;\n \"Google\".metaData.alias = \"@g\"; # builtin engines only support specifying one additional alias\n}\n\n" + }, + { + "title": "programs.floorp.profiles..search.force", + "description": "Whether to force replace the existing search configuration. This is recommended since ‹name› will\nreplace the symlink for the search configuration on every\nlaunch, but note that you’ll lose any existing\nconfiguration by enabling this.", + "type": "boolean", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "false", + "example": null + }, + { + "title": "programs.floorp.profiles..search.order", + "description": "The order the search engines are listed in. Any engines that aren’t included in this list will be listed after\nthese in an unspecified order.", + "type": "list of string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "[ ]", + "example": "[\n \"DuckDuckGo\"\n \"Google\"\n]\n" + }, + { + "title": "programs.floorp.profiles..search.privateDefault", + "description": "The default search engine used in the Private Browsing.", + "type": "null or string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "null", + "example": "\"DuckDuckGo\"" + }, + { + "title": "programs.floorp.profiles..settings", + "description": "Attribute set of ‹name› preferences.", + "type": "attribute set of (‹name› preference (int, bool, string, and also attrs, list, float as a JSON string))", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": "‹name› only supports int, bool, and string types for\npreferences, but home-manager will automatically\nconvert all other JSON-compatible values into strings.", + "default": "{ }", + "example": "{\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 \"browser.newtabpage.pinned\" = [{\n title = \"NixOS\";\n url = \"https://nixos.org\";\n }];\n}\n\n" + }, + { + "title": "programs.floorp.profiles..userChrome", + "description": "Custom ‹name› user chrome CSS.", + "type": "strings concatenated with “\\n”", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"\"", + "example": "''\n /* Hide tab bar in FF Quantum */\n @-moz-document url(chrome://browser/content/browser.xul), url(chrome://browser/content/browser.xhtml) {\n #TabsToolbar {\n visibility: collapse !important;\n margin-bottom: 21px !important;\n }\n \n #sidebar-box[sidebarcommand=\"treestyletab_piro_sakura_ne_jp-sidebar-action\"] #sidebar-header {\n visibility: collapse !important;\n }\n }\n''\n" + }, + { + "title": "programs.floorp.profiles..userContent", + "description": "Custom ‹name› user content CSS.", + "type": "strings concatenated with “\\n”", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/floorp.nix", + "text": "home-manager/modules/programs/floorp.nix" + } + ], + "note": null, + "default": "\"\"", + "example": "''\n /* Hide scrollbar in FF Quantum */\n *{scrollbar-width:none !important}\n''\n" + }, { "title": "programs.foot.enable", "description": "Whether to enable Foot terminal.", @@ -11381,6 +11787,48 @@ "default": "false", "example": null }, + { + "title": "programs.git.maintenance.enable", + "description": "Enable the automatic git maintenance.", + "type": "boolean", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix", + "text": "home-manager/modules/programs/git.nix" + } + ], + "note": "See https://git-scm.com/docs/git-maintenance.", + "default": "false", + "example": "true" + }, + { + "title": "programs.git.maintenance.repositories", + "description": "Repositories on which git maintenance should run.", + "type": "list of string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix", + "text": "home-manager/modules/programs/git.nix" + } + ], + "note": "Should be a list of absolute paths.", + "default": "[ ]", + "example": null + }, + { + "title": "programs.git.maintenance.timers", + "description": "Systemd timers to create for scheduled git maintenance.", + "type": "attribute set of string", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix", + "text": "home-manager/modules/programs/git.nix" + } + ], + "note": "Key is passed to --schedule argument in git maintenance run\nand value is passed to Timer.OnCalendar in systemd.user.timers.", + "default": "", + "example": null + }, { "title": "programs.git.signing", "description": "Options related to signing commits using GnuPG.", @@ -25479,6 +25927,48 @@ "default": "\"$XDG_DATA_HOME/vdirsyncer/status\"", "example": null }, + { + "title": "programs.vifm.enable", + "description": "Whether to enable vifm, a Vim-like file manager.", + "type": "boolean", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/vifm.nix", + "text": "home-manager/modules/programs/vifm.nix" + } + ], + "note": null, + "default": "false", + "example": "true" + }, + { + "title": "programs.vifm.package", + "description": "The vifm package to use.", + "type": "package", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/vifm.nix", + "text": "home-manager/modules/programs/vifm.nix" + } + ], + "note": null, + "default": "pkgs.vifm", + "example": null + }, + { + "title": "programs.vifm.extraConfig", + "description": "Extra lines added to the $XDG_CONFIG_HOME/vifm/vifmrc file.", + "type": "strings concatenated with “\\n”", + "declared_by": [ + { + "link": "https://github.com/nix-community/home-manager/blob/master/modules/programs/vifm.nix", + "text": "home-manager/modules/programs/vifm.nix" + } + ], + "note": null, + "default": "\"\"", + "example": "\"mark h ~/\"" + }, { "title": "programs.vim.enable", "description": "Whether to enable Vim.",