From 8058803f392193f661be306dd31eb662ef955e91 Mon Sep 17 00:00:00 2001 From: rycee Date: Sun, 16 Oct 2022 20:15:51 +0000 Subject: [PATCH] deploy: 04f53999788cd47c6ce932d6cbd7cbfd3998712f --- index.html | 4 +- options.html | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++ tools.html | 14 +++---- 3 files changed, 115 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index 271bef94f..39a0e6222 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 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 6788accfa..9e69ff9ad 100644 --- a/options.html +++ b/options.html @@ -2528,6 +2528,102 @@ Can be used to specify extensions. }

Declared by:

<home-manager/modules/programs/beets.nix> +
programs.borgmatic.enable

Whether to enable Borgmatic.

Type: boolean

Default: false

Example: true

Declared by:

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

Type: package

Default: pkgs.borgmatic

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups

Borgmatic allows for several named backup configurations, +each with its own source directories and repositories. +

Type: attribute set of (submodule)

Example: 

{
+  personal = {
+    location = {
+      sourceDirectories = [ "/home/me/personal" ];
+      repositories = [ "ssh://myuser@myserver.com/./personal-repo" ];
+    };
+  };
+  work = {
+    location = {
+      sourceDirectories = [ "/home/me/work" ];
+      repositories = [ "ssh://myuser@myserver.com/./work-repo" ];
+    };
+  };
+};
+

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.consistency.checks

Consistency checks to run

Type: list of (submodule)

Default: + [ + + ] +

Example: 

[
+  {
+    name = "repository";
+    frequency = "2 weeks";
+  }
+  {
+    name = "archives";
+    frequency = "4 weeks";
+  }
+  {
+    name = "data";
+    frequency = "6 weeks";
+  }
+  {
+    name = "extract";
+    frequency = "6 weeks";
+  }
+];
+

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.consistency.checks.*.frequency

Frequency of this type of check

Type: null or string matching the pattern ([[:digit:]]+ .*)|always

Default: null

Example: "2 weeks"

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.consistency.checks.*.name

Name of consistency check to run.

Type: one of "repository", "archives", "data", "extract"

Example: "repository"

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.consistency.extraConfig

Extra settings.

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

Default: + { + + } +

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.location.extraConfig

Extra settings.

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

Default: + { + + } +

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.location.repositories

Paths to repositories.

Type: list of string

Example: ["ssh://myuser@myrepo.myserver.com/./repo"]

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.location.sourceDirectories

Directories to backup.

Type: list of string

Example: [config.home.homeDirectory]

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.extraConfig

Extra settings.

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

Default: + { + + } +

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepDaily

Number of daily archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepHourly

Number of hourly archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepMinutely

Number of minutely archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepMonthly

Number of monthly archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepSecondly

Number of secondly archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepWeekly

Number of weekly archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepWithin

Keep all archives within this time interval.

Type: null or string matching the pattern [[:digit:]]+[Hdwmy]

Default: null

Example: "2d"

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.retention.keepYearly

Number of yearly archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.storage.encryptionPasscommand

Command writing the passphrase to standard output.

Type: null or string

Default: null

Example: "${pkgs.password-store}/bin/pass borg-repo"

Declared by:

+ <home-manager/modules/programs/borgmatic.nix> +
programs.borgmatic.backups.<name>.storage.extraConfig

Extra settings.

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

Default: + { + + } +

Declared by:

+ <home-manager/modules/programs/borgmatic.nix>
programs.bottom.enable

Whether to enable bottom, a cross-platform graphical process/system monitor with a customizable interface.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/bottom.nix> @@ -8648,6 +8744,16 @@ configuration using

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/blueman-applet.nix> +
services.borgmatic.enable

Whether to enable Borgmatic service.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/services/borgmatic.nix> +
services.borgmatic.frequency

How often to run borgmatic when +services.borgmatic.enable = true. +This value is passed to the systemd timer configuration as +the onCalendar option. See +systemd.time(7) +for more information about the format. +

Type: string

Default: "hourly"

Declared by:

+ <home-manager/modules/services/borgmatic.nix>
services.caffeine.enable

Whether to enable Caffeine service.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/caffeine.nix>
services.cbatticon.enable

Whether to enable cbatticon.

Type: boolean

Default: false

Example: true

Declared by:

diff --git a/tools.html b/tools.html index aee102c48..36005edb8 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