From 142892835de27f904f78831574ab63c7400c71a4 Mon Sep 17 00:00:00 2001 From: berbiche Date: Mon, 7 Jun 2021 20:14:25 +0000 Subject: [PATCH] deploy: f74dc9c70bc05c87bf2ebb9a5e60665a87753ce5 --- index.html | 4 +-- options.html | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++ tools.html | 14 ++++----- 3 files changed, 95 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index 831aad8cb..d4a6d6ff0 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 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
   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 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 describes how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index a6c2fdf6d..88467f6e5 100644 --- a/options.html +++ b/options.html @@ -11198,6 +11198,92 @@ program. pkgs.plasma-workspace

Declared by:

<home-manager/modules/services/xembed-sni-proxy.nix> +
services.xidlehook.enable

Whether to enable xidlehook systemd service.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.package

The package to use for xidlehook.

Type: package

Default: + "pkgs.xidlehook" +

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.environment

Extra environment variables to be exported in the script. +These options are passed unescaped as export name=value. +

Type: attribute set of strings

Default: + + { + + } + +

Example: 

{
+  "primary-display" = "$(xrandr | awk '/ primary/{print $1}')";
+}
+

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.not-when-audio

Disable locking when audio is playing.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.not-when-fullscreen

Disable locking when a fullscreen application is in use.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.once

Whether to enable running the program once and exiting.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.timers

A set of commands to be executed after a specific idle timeout. +The commands specified in command and canceller +are passed escaped to the script. +To use or re-use environment variables that are script-dependent, specify them +in the environment section. +

Type: list of submodules

Default: + + [ + + ] + +

Example: 

[
+  {
+    delay = 60;
+    command = "xrandr --output \"$PRIMARY_DISPLAY\" --brightness .1";
+    canceller = "xrandr --output \"$PRIMARY_DISPLAY\" --brightness 1";
+  }
+  {
+    delay = 120;
+    command = "${pkgs.writeShellScript "my-script" ''
+      # A complex script to run
+    ''}";
+  }
+]
+

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.timers.*.canceller

Command executed when the user becomes active again. +This is only executed if the next timer has not been reached. +Path to executables are accepted. +The command is automatically escaped. +

Type: string

Default: + "" +

Example: 

${pkgs.libnotify}/bin/notify-send "Idle" "Resuming activity"
+

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.timers.*.command

Command executed after the idle timeout is reached. +Path to executables are accepted. +The command is automatically escaped. +

Type: null or string

Example: 

${pkgs.libnotify}/bin/notify-send "Idle" "Sleeping in 1 minute"
+

Declared by:

+ <home-manager/modules/services/xidlehook.nix> +
services.xidlehook.timers.*.delay

Time before executing the command.

Type: unsigned integer, meaning >=0

Example: + 60 +

Declared by:

+ <home-manager/modules/services/xidlehook.nix>
services.xscreensaver.enable

Whether to enable XScreenSaver.

Type: boolean

Default: false

Example: diff --git a/tools.html b/tools.html index 5fa33a649..7aba5e0f8 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 | @@ -76,7 +76,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.

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

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -240,15 +240,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 C. nix-darwin Module Options Home Appendix E. Release Notes
\ No newline at end of file