From 064e4133e21f3f332419837492e568f2b913f63f Mon Sep 17 00:00:00 2001 From: rycee Date: Sat, 23 Oct 2021 19:41:33 +0000 Subject: [PATCH] deploy: 406eeec0b98903561767ce7aca311034d298d53e --- index.html | 4 +- options.html | 152 +++++++++++++++++++++++++++++++++++++++++++++++++++ tools.html | 14 ++--- 3 files changed, 161 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index ec1fa0a5f..79974afae 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 describe how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index 896bd190d..e4c4b2f00 100644 --- a/options.html +++ b/options.html @@ -2714,6 +2714,158 @@ Note that lists are converted to duplicate keys. }

Declared by:

<home-manager/modules/programs/gpg.nix> +
programs.hexchat.enable

Whether to enable HexChat, a graphical IRC client.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels

Configures ~/.config/hexchat/servlist.conf. +

Type: attribute set of submodules

Default: + { + + } +

Example: 

{
+  freenode = {
+    autojoin = [
+      "#home-manager"
+      "#linux"
+      "#nixos"
+    ];
+    charset = "UTF-8 (Unicode)";
+    commands = [
+      "ECHO Buzz Lightyear sent you a message: 'To Infinity... and Beyond!'"
+    ];
+    loginMethod = sasl;
+    nickname = "my_nickname";
+    nickname2 = "my_secondchoice";
+    options = {
+      acceptInvalidSSLCertificates = false;
+      autoconnect = true;
+      bypassProxy = true;
+      connectToSelectedServerOnly = true;
+      useGlobalUserInformation = false;
+      forceSSL = false;
+    };
+    password = "my_password";
+    realName = "my_realname";
+    servers = [
+      "chat.freenode.net"
+      "irc.freenode.net"
+    ];
+    userName = "my_username";
+  };
+}

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.autojoin

Channels list to autojoin on connecting to server.

Type: list of strings

Default: + [ + + ] +

Example: + [ + "#home-manager" "#linux" "#nix" + ] +

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.charset

Character set.

Type: null or string

Default: null

Example: "UTF-8 (Unicode)"

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.commands

Commands to be executed on connecting to server.

Type: list of strings

Default: + [ + + ] +

Example: [ "ECHO Greetings fellow Nixer! ]

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.loginMethod

The login method. The allowed options are: +

null

Default

"nickServMsg"

NickServ (/MSG NickServ + password)

"nickServ"

NickServ (/NICKSERV + password)

"challengeAuth"

Challenge Auth (username + password)

"sasl"

SASL (username + password)

"serverPassword"

Server password (/PASS password)

"saslExternal"

SASL EXTERNAL (cert)

"customCommands"

Use "commands" field for auth. For example + 

+commands = [ "/msg NickServ IDENTIFY my_password" ]
+

+

+

Type: null or one of "challengeAuth", "customCommands", "nickServ", "nickServMsg", "sasl", "saslExternal", "serverPassword"

Default: null

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.nickname

Primary nickname.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.nickname2

Secondary nickname.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.options

Channel options.

Type: null or submodule

Default: null

Example: + { + autoconnect = true; useGlobalUserInformation = true; + } +

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.options.acceptInvalidSSLCertificates

Accept invalid SSL certificates.

Type: null or boolean

Default: false

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.options.autoconnect

Autoconnect to network.

Type: null or boolean

Default: false

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.options.bypassProxy

Bypass proxy.

Type: null or boolean

Default: true

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.options.connectToSelectedServerOnly

Connect to selected server only.

Type: null or boolean

Default: true

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.options.forceSSL

Use SSL for all servers.

Type: null or boolean

Default: false

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.options.useGlobalUserInformation

Use global user information.

Type: null or boolean

Default: false

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.password

Password to use. Note this password will be readable by all user's +in the Nix store. +

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.realName

Real name. Is used to populate the real name field that appears when +someone uses the WHOIS command on your nick. +

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.servers

IRC Server Address List.

Type: list of strings

Default: + [ + + ] +

Example: + [ + "chat.freenode.net" "irc.freenode.net" + ] +

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.channels.<name>.userName

User name. Part of your user@host hostmask that +appears to other on IRC. +

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.overwriteConfigFiles

Enables overwriting HexChat configuration files +(hexchat.conf, servlist.conf). +Any existing HexChat configuration will be lost. Certify to back-up any +previous configuration before enabling this. +

+Enabling this setting is recommended, because everytime HexChat +application is closed it overwrites Nix/Home Manager provided +configuration files, causing: +

  1. + Nix/Home Manager provided configuration to be out of sync with + actual active HexChat configuration. +

  2. + Blocking Nix/Home Manager updates until configuration files are + manually removed. +

+

Type: null or boolean

Default: false

Declared by:

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

Configuration for ~/.config/hexchat/hexchat.conf, see +https://hexchat.readthedocs.io/en/latest/settings.html#list-of-settings +for supported values. +

Type: null or attribute set of strings

Default: null

Example: 

{
+  irc_nick1 = "mynick";
+  irc_username = "bob";
+  irc_realname = "Bart Simpson";
+  text_font = "Monospace 14";
+};
+

Declared by:

+ <home-manager/modules/programs/hexchat.nix> +
programs.hexchat.theme

Theme package for HexChat. Expects a derivation containing decompressed +theme files. .hct file format requires unzip +decompression, as seen in example. +

Type: null or package

Default: null

Example: 

stdenv.mkDerivation rec {
+  name = "hexchat-theme-MatriY";
+  buildInputs = [ pkgs.unzip ];
+  src = fetchurl {
+      url = "https://dl.hexchat.net/themes/MatriY.hct";
+      sha256 = "sha256-ffkFJvySfl0Hwja3y7XCiNJceUrGvlEoEm97eYNMTZc=";
+  };
+  unpackPhase = "unzip ${src}";
+  installPhase = "cp -r . $out";
+};
+

Declared by:

+ <home-manager/modules/programs/hexchat.nix>
programs.himalaya.enable

Whether to enable himalaya mail client.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/himalaya.nix>
programs.himalaya.package

Package providing the himalaya mail client. diff --git a/tools.html b/tools.html index 481922607..383245b18 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 | @@ -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)

Prev   Next
Appendix C. nix-darwin Module Options Home Appendix E. Release Notes
\ No newline at end of file