From 1070a9815aeb671efa3ef3a608c6d78f91664fec Mon Sep 17 00:00:00 2001 From: rycee Date: Wed, 26 Jan 2022 23:11:35 +0000 Subject: [PATCH] deploy: cbc176010b83361af5eec4b28af78d9fd69a6383 --- index.html | 4 ++-- options.html | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ tools.html | 14 +++++++------- 3 files changed, 60 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index ee7a264f4..a963751db 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
3. Writing Home Manager Modules
3.1. Option Types
4. Contributing
4.1. Getting started
4.2. Guidelines
4.2.1. Maintain backward compatibility
4.2.2. Keep forward compatibility in mind
4.2.3. Add only valuable options
4.2.4. Add relevant tests
4.2.5. Add relevant documentation
4.2.6. Add yourself as a module maintainer
4.2.7. Format your code
4.2.8. Format your commit messages
4.2.9. Format your news entries
4.2.10. Use conditional modules and news
4.2.11. Mind the license
4.3. Commits
4.4. Code Style
4.5. News
4.6. Tests
5. Frequently Asked Questions (FAQ)
5.1. Why is there a collision error when switching generation?
5.2. Why are the session variables not set?
5.3. How to set up a configuration for multiple users/machines?
5.4. Why do I get an error message about ca.desrt.dconf?
5.5. How do I install packages from Nixpkgs unstable?
5.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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. 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
3. Writing Home Manager Modules
3.1. Option Types
4. Contributing
4.1. Getting started
4.2. Guidelines
4.2.1. Maintain backward compatibility
4.2.2. Keep forward compatibility in mind
4.2.3. Add only valuable options
4.2.4. Add relevant tests
4.2.5. Add relevant documentation
4.2.6. Add yourself as a module maintainer
4.2.7. Format your code
4.2.8. Format your commit messages
4.2.9. Format your news entries
4.2.10. Use conditional modules and news
4.2.11. Mind the license
4.3. Commits
4.4. Code Style
4.5. News
4.6. Tests
5. Frequently Asked Questions (FAQ)
5.1. Why is there a collision error when switching generation?
5.2. Why are the session variables not set?
5.3. How to set up a configuration for multiple users/machines?
5.4. Why do I get an error message about ca.desrt.dconf?
5.5. How do I install packages from Nixpkgs unstable?
5.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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. 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 13f7a3550..b5cd081b0 100644 --- a/options.html +++ b/options.html @@ -3817,6 +3817,57 @@ for the documentation. }

Declared by:

<home-manager/modules/programs/kitty.nix> +
programs.kodi.enable

Whether to enable Kodi.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/kodi.nix> +
programs.kodi.package

The kodi package to use. +Can be used to specify extensions. +

Type: package

Default: pkgs.kodi

Example:

{ pkgs.kodi.withPackages (exts: [ exts.pvr-iptvsimple ]) }
+

Declared by:

+ <home-manager/modules/programs/kodi.nix> +
programs.kodi.addonSettings

Attribute set with the plugin namespace as toplevel key and the plugins +settings as lower level key/value pairs. +

+Kodi will still show the settings of plugins configured via this +mechanism in the GUI and they appear to be mutable. This however is +not the case and the settings will stay as specified via Home Manager. +

Type: null or attribute set of attribute set of stringss

Default: null

Example:

{ "service.xbmc.versioncheck".versioncheck_enable = "false"; }
+

Declared by:

+ <home-manager/modules/programs/kodi.nix> +
programs.kodi.datadir

Directory to store configuration and metadata.

Type: path

Default: "${config.home.homeDirectory}/.kodi"

Example: "${config.xdg.dataHome}/kodi"

Declared by:

+ <home-manager/modules/programs/kodi.nix> +
programs.kodi.settings

Configuration to write to the advancedsettings.xml +file in kodis userdata directory. Settings specified here will be +immutable from inside kodi and be hidden from the GUI settings dialog. +

+See https://kodi.wiki/view/Advancedsettings.xml as +reference for how settings need to be specified. +

+The innermost attributes must be of type str. +

Type: null or attribute sets of strings

Default: null

Example:

{ videolibrary.showemptytvshows = "true"; }
+

Declared by:

+ <home-manager/modules/programs/kodi.nix> +
programs.kodi.sources

Contents to populate the file sources.xml in kodis +userdata directory. +

+See https://kodi.wiki/view/Sources.xml as +reference for how sources need to be specified. +

+Kodi will still show the dialogs to modify sources in the GUI and they +appear to be mutable. This however is not the case and the sources will +stay as specified via Home Manager. +

+The innermost attributes must be of type str. +

Type: null or attribute sets or lists of strings

Default: null

Example:

{
+  video = {
+    default = "movies";
+    source = [
+      { name = "videos"; path = "/path/to/videos"; allowsharing = "true"; }
+      { name = "movies"; path = "/path/to/movies"; allowsharing = "true"; }
+    ];
+  };
+}
+

Declared by:

+ <home-manager/modules/programs/kodi.nix>
programs.lazygit.enable

Whether to enable lazygit, a simple terminal UI for git commands.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/lazygit.nix>
programs.lazygit.settings

Configuration written to diff --git a/tools.html b/tools.html index ea0838773..a85606303 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