diff --git a/index.html b/index.html index 1ea43312e..7577a90b8 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager - — reconfigure a user environment
E. Release Notes
E.1. Release 22.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager + — reconfigure a user environment
E. Release Notes
E.1. Release 22.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 18.09

Preface

This manual will eventually describe how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index 117938458..e2f3e8e45 100644 --- a/options.html +++ b/options.html @@ -3110,6 +3110,72 @@ previously existing bookmarks! <home-manager/modules/programs/firefox.nix>

programs.firefox.profiles.<name>.path

Profile path.

Type: string

Default: "‹name›"

Declared by:

<home-manager/modules/programs/firefox.nix> +
programs.firefox.profiles.<name>.search.default

The default search engine used in the address bar and search bar. +

Type: null or string

Default: null

Example: "DuckDuckGo"

Declared by:

+ <home-manager/modules/programs/firefox.nix> +
programs.firefox.profiles.<name>.search.engines

Attribute set of search engine configurations. Engines +that only have metaData specified will +be treated as builtin to Firefox. +

+See SearchEngine.jsm +in Firefox's source for available options. We maintain a +mapping to let you specify all options in the referenced +link without underscores, but it may fall out of date with +future options. +

+Note, icon is also a special option +added by Home Manager to make it convenient to specify +absolute icon paths. +

Type: attribute set of attribute set of (JSON value)

Default: + { + + } +

Example:

{
+  "Nix Packages" = {
+    urls = [{
+      template = "https://search.nixos.org/packages";
+      params = [
+        { name = "type"; value = "packages"; }
+        { name = "query"; value = "{searchTerms}"; }
+      ];
+    }];
+
+    icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
+    definedAliases = [ "@np" ];
+  };
+
+  "NixOS Wiki" = {
+    urls = [{ template = "https://nixos.wiki/index.php?search={searchTerms}"; }];
+    iconUpdateURL = "https://nixos.wiki/favicon.png";
+    updateInterval = 24 * 60 * 60 * 1000; # every day
+    definedAliases = [ "@nw" ];
+  };
+
+  "Bing".metaData.hidden = true;
+  "Google".metaData.alias = "@g"; # builtin engines only support specifying one additional alias
+}
+

Declared by:

+ <home-manager/modules/programs/firefox.nix> +
programs.firefox.profiles.<name>.search.force

Whether to force replace the existing search +configuration. This is recommended since Firefox will +replace the symlink for the search configuration on every +launch, but note that you'll lose any existing +configuration by enabling this. +

Type: boolean

Default: false

Declared by:

+ <home-manager/modules/programs/firefox.nix> +
programs.firefox.profiles.<name>.search.order

The order the search engines are listed in. Any engines +that aren't included in this list will be listed after +these in an unspecified order. +

Type: list of string

Default: + [ + + ] +

Example: + [ + "DuckDuckGo" "Google" + ] +

Declared by:

+ <home-manager/modules/programs/firefox.nix>
programs.firefox.profiles.<name>.settings

Attribute set of Firefox preferences.

Type: attribute set of (boolean or signed integer or string)

Default: { @@ -7884,7 +7950,7 @@ manually set any options not listed above.

programs.vscode.enable

Whether to enable Visual Studio Code.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/vscode.nix>
programs.vscode.package

Version of Visual Studio Code to install. -

Type: package

Default: (build of vscode-1.72.1)

Example: pkgs.vscodium

Declared by:

+

Type: package

Default: (build of vscode-1.72.2)

Example: pkgs.vscodium

Declared by:

<home-manager/modules/programs/vscode.nix>
programs.vscode.extensions

The extensions Visual Studio Code should be started with.

Type: list of package

Default: diff --git a/tools.html b/tools.html index 4f972c60e..3cf7b82e1 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

home-manager { build | @@ -84,7 +84,7 @@ | --verbose } - ]

Description

+ ]

Description

This command updates the user environment so that it corresponds to the configuration specified in ~/.config/nixpkgs/home.nix or ~/.config/nixpkgs/flake.nix.

@@ -153,7 +153,7 @@ available for immediate garbage collection.

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -265,15 +265,15 @@ --verbose

Activates verbose output. -

Files

+

Files

$XDG_DATA_HOME/home-manager/news-read-ids

Identifiers of news items that have been shown. Can be deleted to reset the read news indicator. -

Bugs

+

Bugs

Please report any bugs on the project issue tracker. -

See also

+

See also

home-configuration.nix(5)

\ No newline at end of file