From b968c5ad6fabd0ac7b0dd1faf5f4120d24d2a639 Mon Sep 17 00:00:00 2001 From: rycee Date: Thu, 24 Nov 2022 22:32:23 +0000 Subject: [PATCH] deploy: 62cb5bcf93896e4dd6b4507dac7ba2e2e3abc9d7 --- index.html | 4 ++-- options.html | 2 +- release-notes.html | 39 ++++++++++++++++++++++----------------- tools.html | 14 +++++++------- 4 files changed, 32 insertions(+), 27 deletions(-) diff --git a/index.html b/index.html index f5dde1e46..04245c88c 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual
Home Manager Manual
   Next

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
   Next

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 23.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 22.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.11
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 21.05
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 20.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.09
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 19.03
E.9.1. Highlights
E.9.2. State Version Changes
E.10. 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 7c9205510..bb9f08ff4 100644 --- a/options.html +++ b/options.html @@ -1280,7 +1280,7 @@ settings are in effect and will therefore help avoid breaking program configurations. Switching to a higher state version typically requires performing some manual steps, such as data conversion or moving files. -

Type: one of "18.09", "19.03", "19.09", "20.03", "20.09", "21.03", "21.05", "21.11", "22.05", "22.11"

Declared by:

+

Type: one of "18.09", "19.03", "19.09", "20.03", "20.09", "21.03", "21.05", "21.11", "22.05", "22.11", "23.05"

Declared by:

<home-manager/modules/misc/version.nix>
home.username

The user's username.

Type: string

Default: 

"$USER"   for state version < 20.09,
 undefined for state version ≥ 20.09
diff --git a/release-notes.html b/release-notes.html
index 160aa5df7..072802e0d 100644
--- a/release-notes.html
+++ b/release-notes.html
@@ -1,5 +1,10 @@
 
-Appendix E. Release Notes
Appendix E. Release Notes
Prev   
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
This section lists the release notes for stable versions of Home Manager and the current unstable version.
E.1. Release 22.11
This is the current unstable branch and the information in this section is therefore not final.
E.1.1. Highlights
This release has the following notable changes:
E.2.2. State Version Changes
The state version in this release includes the changes below.
 These changes are only active if the home.stateVersion option is set to "22.11" or later.
  • 
 The services.mpd.musicDirectory option now defaults to the
 value of xdg.userDirs.music if xdg.userDirs.enable is
@@ -70,7 +75,7 @@ activation script to commands that are explicitly specified.
 make the activation script as reproducible as possible and honoring
 the user’s PATH reduces reproducibility.
    If you need to run a command in an activation script block then refer
 to the command by its absolute command path, such as
-${pkgs.hello}/bin/hello.
E.2. Release 22.05
The 22.05 release branch became the stable branch in May, 2022.
E.2.1. Highlights
This release has the following notable changes:
  • 
+${pkgs.hello}/bin/hello.
E.3. Release 22.05
The 22.05 release branch became the stable branch in May, 2022.
E.3.1. Highlights
This release has the following notable changes:
  • 
 The programs.waybar.settings.modules option was removed.
 Waybar modules should now be declared directly under programs.waybar.settings.
 
  • 
@@ -82,12 +87,12 @@ such as the home-manager command line tool and the
 then you can do so through the Home Manager Weblate project.
  • 
 A new module, launchd.agents was added.
 Use this to enable services based on macOS LaunchAgents.
-
E.2.2. State Version Changes
The state version in this release includes the changes below.
+
E.3.2. State Version Changes
The state version in this release includes the changes below.
 These changes are only active if the home.stateVersion option is set to "22.05" or later.
  • 
 The programs.waybar.settings option now allows defining modules directly under programs.waybar.settings.
 Defining modules under programs.waybar.settings.modules will now be an error.
 For example,
-
    programs.waybar.settings.modules."custom/my-module" = { };
    becomes
    programs.waybar.settings."custom/my-module" = { };
E.3. Release 21.11
The 21.11 release branch became the stable branch in November, 2021.
E.3.1. Highlights
This release has the following notable changes:
  • 
+
    programs.waybar.settings.modules."custom/my-module" = { };
    becomes
    programs.waybar.settings."custom/my-module" = { };
E.4. Release 21.11
The 21.11 release branch became the stable branch in November, 2021.
E.4.1. Highlights
This release has the following notable changes:
  • 
 All Home Manager modules are now loaded on all platforms. With this
 change you will get a more descriptive error message if you attempt to
 enable a module that is incompatible with the host platform.
@@ -111,7 +116,7 @@ Rofi version 1.7.0 removed many options that were used by the module and replace
 Taskwarrior version 2.6.0 respects XDG Specification for the config file now.
 Option programs.taskwarrior.config and friends now generate the config file at
 $XDG_CONFIG_HOME/task/taskrc instead of ~/.taskrc.
-
E.3.2. State Version Changes
The state version in this release includes the changes below. These
+
E.4.2. State Version Changes
The state version in this release includes the changes below. These
 changes are only active if the home.stateVersion option is set to
 "21.11" or later.
  • 
 The home.keyboard option now defaults to null, meaning that Home Manager won’t do any keyboard layout management. For example, setxkbmap won’t be run in X sessions.
@@ -121,7 +126,7 @@ For example,
 
    programs.pet.settings.editor = "nvim";
    becomes
    programs.pet.settings.General.editor = "nvim";
  • 
 The programs.waybar.settings option now allows defining modules directly under programs.waybar.settings.
 For example,
-
    programs.waybar.settings.modules."custom/my-module" = { };
    becomes
    programs.waybar.settings."custom/my-module" = { };
E.4. Release 21.05
The 21.05 release branch became the stable branch in May, 2021.
E.4.1. Highlights
This release has the following notable changes:
  • 
+
    programs.waybar.settings.modules."custom/my-module" = { };
    becomes
    programs.waybar.settings."custom/my-module" = { };
E.5. Release 21.05
The 21.05 release branch became the stable branch in May, 2021.
E.5.1. Highlights
This release has the following notable changes:
  • 
 The ‘opt-programs.broot.verbs` option is now a list rather than an
 attribute set. To migrate, move the keys of the attrset into the list
 items’ invocation keys. For example,
@@ -238,14 +243,14 @@ options in programs.htop. To migrate, set the htop
      highlight_megabytes = 1;
      highlight_threads = 1;
   };
-};

E.4.2. State Version Changes

The state version in this release includes the changes below. These +};

E.5.2. State Version Changes

The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "21.05" or later.

  • The newsboat module now stores generated configuration in $XDG_CONFIG_HOME/newsboat. -

E.5. Release 20.09

The 20.09 release branch became the stable branch in late September, 2020.

E.5.1. Highlights

This release has the following notable changes:

  • +

E.6. Release 20.09

The 20.09 release branch became the stable branch in late September, 2020.

E.6.1. Highlights

This release has the following notable changes:

  • Nothing has happened. -

E.5.2. State Version Changes

The state version in this release includes the changes below. These +

E.6.2. State Version Changes

The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "20.09" or later.

  • The options home.homeDirectory and home.username no @@ -294,7 +299,7 @@ The options wayland.windowManager.sway.config.bars binding_mode #2f343a #900000 #ffffff } -}

E.6. Release 20.03

The 20.03 release branch became the stable branch in April, 2020.

E.6.1. Highlights

This release has the following notable changes:

  • +}

E.7. Release 20.03

The 20.03 release branch became the stable branch in April, 2020.

E.7.1. Highlights

This release has the following notable changes:

  • Assigning a list to the home.file, xdg.configFile, and xdg.dataFile options is now deprecated and will produce a warning message if used. Specifically, if your configuration currently @@ -350,7 +355,7 @@ configuration user = "jd"; } };

    Support for the list form will be removed in Home Manager version -20.09.

E.6.2. State Version Changes

The state version in this release includes the changes below. These +20.09.

E.7.2. State Version Changes

The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "20.03" or later.

E.7. Release 19.09

The 19.09 release branch became the stable branch in October, 2019.

E.7.1. Highlights

This release has the following notable changes:

  • +

E.8. Release 19.09

The 19.09 release branch became the stable branch in October, 2019.

E.8.1. Highlights

This release has the following notable changes:

  • The programs.firefox.enableGoogleTalk and programs.firefox.enableIcedTea options are now deprecated and will only work if Firefox ESR 52.x is used. @@ -370,7 +375,7 @@ The programs.firefox.enableGoogleTalk and The home-manager tool now provides an uninstall sub-command that can be used to uninstall Home Manager, if used in the standalone mode. That is, not as a NixOS module. -

E.7.2. State Version Changes

The state version in this release includes the changes below. These +

E.8.2. State Version Changes

The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "19.09" or later.

E.8. Release 19.03

The 19.03 release branch became the stable branch in April, 2019.

E.8.1. Highlights

This release has the following notable changes:

  • +

E.9. Release 19.03

The 19.03 release branch became the stable branch in April, 2019.

E.9.1. Highlights

This release has the following notable changes:

  • The home.file.<name>.source option now allows source files to be hidden, that is, having a name starting with the . character. It also allows the source file name to contain characters not typically @@ -396,10 +401,10 @@ encounter errors. “defined multiple times” then you need to use the mkForce function. For example,

    systemd.user.services.foo.Service.ExecStart = "/foo/bar";

    becomes

    systemd.user.services.foo.Service.ExecStart = lib.mkForce "/foo/bar";

    We had to make this change because the old merging was causing too -many confusing situations for people.

E.8.2. State Version Changes

The state version in this release includes the changes below. These +many confusing situations for people.

E.9.2. State Version Changes

The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to “19.03” or later.

E.9. Release 18.09

The 18.09 release branch became the stable branch in September, 2018.

Prev   
Appendix D. Tools Home 
\ No newline at end of file +

E.10. Release 18.09

The 18.09 release branch became the stable branch in September, 2018.

Prev   
Appendix D. Tools Home 
\ No newline at end of file diff --git a/tools.html b/tools.html index 0305dc128..958fd69c3 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools
Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools
Prev   Next

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)

Prev   Next
Appendix C. nix-darwin Module Options Home Appendix E. Release Notes
\ No newline at end of file