From f855e193da08e71c1b02039a377806bf41dcd090 Mon Sep 17 00:00:00 2001 From: rycee Date: Tue, 5 Oct 2021 22:08:53 +0000 Subject: [PATCH] deploy: af2007bb7772c6f17f4924639f2eb8a321d74fb4 --- index.html | 4 ++-- options.html | 45 +++++++++++++++++++++++++++++++++++++++++++++ tools.html | 14 +++++++------- 3 files changed, 54 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index 2ba331839..d703137cb 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. 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 c9aad303e..fd4434cc7 100644 --- a/options.html +++ b/options.html @@ -1871,6 +1871,51 @@ See

Declared by:

<home-manager/modules/programs/astroid.nix> +
programs.atuin.enable

Whether to enable atuin.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/modules/programs/atuin.nix> +
programs.atuin.enableBashIntegration

Whether to enable Atuin's Bash integration. This will bind +ctrl-r to open the Atuin history. +

Type: boolean

Default: + true +

Declared by:

+ <home-manager/modules/programs/atuin.nix> +
programs.atuin.enableZshIntegration

Whether to enable Atuin's Zsh integration. +

+If enabled, this will bind ctrl-r and the up-arrow +key to open the Atuin history. +

Type: boolean

Default: + true +

Example: + true +

Declared by:

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

The package to use for atuin.

Type: package

Default: + pkgs.atuin +

Declared by:

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

Configuration written to +~/.config/atuin/config.toml. +

+See https://github.com/ellie/atuin/blob/main/docs/config.md for the full list +of options. +

Type: Atuin configuration

Default: + + { + + } + +

Example:

{
+  auto_sync = true;
+  sync_frequency = "5m";
+  sync_address = "https://api.atuin.sh";
+  search_mode = "prefix";
+}
+

Declared by:

+ <home-manager/modules/programs/atuin.nix>
programs.autojump.enable

Whether to enable autojump.

Type: boolean

Default: false

Example: diff --git a/tools.html b/tools.html index 53c012ab9..c0e12e8e5 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 | @@ -82,7 +82,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.

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

-

Options

+

Options

The tool accepts the options

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

Activates verbose output. -

Files

+

Files

~/.local/share/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