From 97371dd60c90de08e77cb6d438e7508f0567a1c7 Mon Sep 17 00:00:00 2001 From: rycee Date: Thu, 5 Nov 2020 23:17:39 +0000 Subject: [PATCH] deploy: 9e9d8ffc7ca70840858153a179cb0dd4d869ea0a --- index.html | 4 +- options.html | 201 +++++++++++++++++++++++++++++++++++++++++++++++++++ tools.html | 14 ++-- 3 files changed, 210 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index 12d3fd21d..ca3667aae 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. 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 do 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. Tools
home-manager - — reconfigure a user environment
C. Release Notes
C.1. Release 21.03
C.1.1. Highlights
C.1.2. State Version Changes
C.2. Release 20.09
C.2.1. Highlights
C.2.2. State Version Changes
C.3. Release 20.03
C.3.1. Highlights
C.3.2. State Version Changes
C.4. Release 19.09
C.4.1. Highlights
C.4.2. State Version Changes
C.5. Release 19.03
C.5.1. Highlights
C.5.2. State Version Changes
C.6. 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. 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 do 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. Tools
home-manager + — reconfigure a user environment
C. Release Notes
C.1. Release 21.03
C.1.1. Highlights
C.1.2. State Version Changes
C.2. Release 20.09
C.2.1. Highlights
C.2.2. State Version Changes
C.3. Release 20.03
C.3.1. Highlights
C.3.2. State Version Changes
C.4. Release 19.09
C.4.1. Highlights
C.4.2. State Version Changes
C.5. Release 19.03
C.5.1. Highlights
C.5.2. State Version Changes
C.6. Release 18.09

Preface

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

diff --git a/options.html b/options.html index 76f6d5b47..6f80f9228 100644 --- a/options.html +++ b/options.html @@ -3569,6 +3569,207 @@ for options. }

Declared by:

<home-manager/modules/programs/i3status.nix> +
programs.i3status-rust.enable

Whether to enable a replacement for i3-status written in Rust.

Type: boolean

Default: + false +

Example: + true +

Declared by:

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

Package providing i3status-rust

Type: package

Default: + pkgs.i3status-rust +

Declared by:

+ <home-manager/modules/programs/i3status-rust.nix> +
programs.i3status-rust.bars

Attribute set of i3status-rust bars, each with their own configuration. +Each bar name generates a config file suffixed with +the bar's name from the attribute set, like so: +config-name.toml. +

+This way, multiple config files can be generated, such as for having a +top and a bottom bar. +

+See +i3status-rust(1) +for options. +

Type: attribute set of submodules

Default: + + { + default = + { + blocks = + [ + + { + alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ; + } + + { + block = "memory"; display_type = "memory"; format_mem = "{Mup}%"; format_swap = "{SUp}%"; + } + + { + block = "cpu"; interval = 1; + } + + { + block = "load"; format = "{1m}"; interval = 1; + } + + { + block = "sound"; + } + + { + block = "time"; format = "%a %d/%m %R"; interval = 60; + } + + ] + ; + } + ; + } + +

Example: 

bottom = {
+  blocks = [
+    {
+       block = "disk_space";
+       path = "/";
+       alias = "/";
+       info_type = "available";
+       unit = "GB";
+       interval = 60;
+       warning = 20.0;
+       alert = 10.0;
+     }
+     {
+       block = "memory";
+       display_type = "memory";
+       format_mem = "{Mup}%";
+       format_swap = "{SUp}%";
+     }
+     {
+       block = "cpu";
+       interval = 1;
+     }
+     {
+       block = "load";
+       interval = 1;
+       format = "{1m}";
+     }
+     { block = "sound"; }
+     {
+       block = "time";
+       interval = 60;
+       format = "%a %d/%m %R";
+     }
+  ];
+  settings = {
+    theme =  {
+      name = "solarized-dark";
+      overrides = {
+        idle_bg = "#123456";
+        idle_fg = "#abcdef";
+      };
+    };
+  };
+  icons = "awesome5";
+  theme = "gruvbox-dark";
+};
+

Declared by:

+ <home-manager/modules/programs/i3status-rust.nix> +
programs.i3status-rust.bars.<name>.blocks

Configuration blocks to add to i3status-rust +config. See +https://github.com/greshake/i3status-rust/blob/master/blocks.md +for block options. +

Type: TOML value

Default: + + [ + + { + alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ; + } + + { + block = "memory"; display_type = "memory"; format_mem = "{Mup}%"; format_swap = "{SUp}%"; + } + + { + block = "cpu"; interval = 1; + } + + { + block = "load"; format = "{1m}"; interval = 1; + } + + { + block = "sound"; + } + + { + block = "time"; format = "%a %d/%m %R"; interval = 60; + } + + ] + +

Example: 

[
+  {
+    block = "disk_space";
+    path = "/";
+    alias = "/";
+    info_type = "available";
+    unit = "GB";
+    interval = 60;
+    warning = 20.0;
+    alert = 10.0;
+  }
+  {
+    block = "sound";
+    format = "{output_name} {volume}%";
+    on_click = "pavucontrol --tab=3";
+    mappings = {
+     "alsa_output.pci-0000_00_1f.3.analog-stereo" = "";
+     "bluez_sink.70_26_05_DA_27_A4.a2dp_sink" = ""
+    };
+  }
+];
+

Declared by:

+ <home-manager/modules/programs/i3status-rust.nix> +
programs.i3status-rust.bars.<name>.icons

The icons set to use. See +https://github.com/greshake/i3status-rust/blob/master/themes.md +for a list of available icon sets. +

Type: string

Default: + "none" +

Example: + "awesome5" +

Declared by:

+ <home-manager/modules/programs/i3status-rust.nix> +
programs.i3status-rust.bars.<name>.settings

Any extra options to add to i3status-rust +config. +

Type: TOML value

Default: + + { + + } + +

Example: 

{
+  theme =  {
+    name = "solarized-dark";
+    overrides = {
+      idle_bg = "#123456";
+      idle_fg = "#abcdef";
+    };
+  };
+}
+

Declared by:

+ <home-manager/modules/programs/i3status-rust.nix> +
programs.i3status-rust.bars.<name>.theme

The theme to use. See +https://github.com/greshake/i3status-rust/blob/master/themes.md +for a list of available themes. +

Type: string

Default: + "plain" +

Example: + "gruvbox-dark" +

Declared by:

+ <home-manager/modules/programs/i3status-rust.nix>
programs.info.enable

Whether to enable GNU Info.

Type: boolean

Default: false

Example: diff --git a/tools.html b/tools.html index 13ffddf7f..37e71da4b 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix B. Tools

Appendix B. Tools
Prev   Next

Appendix B. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix B. Tools

Appendix B. Tools
Prev   Next

Appendix B. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

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

Description

+ ]

Description

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

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

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -219,15 +219,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)

Prev   Next
Appendix A. Configuration Options Home Appendix C. Release Notes
\ No newline at end of file