Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.hexchat.enable

Whether to enable HexChat, a graphical IRC client.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.hexchat.package

The hexchat package to use.

Type: null or package

Default:

pkgs.hexchat

Declared by:

programs.hexchat.channels

Configures $XDG_CONFIG_HOME/hexchat/servlist.conf.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  oftc = {
    autojoin = [
      "#home-manager"
      "#linux"
    ];
    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 = [
      "irc.oftc.net"
    ];
    userName = "my_username";
  };
}

Declared by:

programs.hexchat.channels.<name>.autojoin

Channels list to autojoin on connecting to server.

Type: list of string

Default:

[ ]

Example:

[
  "#home-manager"
  "#linux"
  "#nix"
]

Declared by:

programs.hexchat.channels.<name>.charset

Character set.

Type: null or string

Default:

null

Example:

"UTF-8 (Unicode)"

Declared by:

programs.hexchat.channels.<name>.commands

Commands to be executed on connecting to server.

Type: list of string

Default:

[ ]

Example:

[ "ECHO Greetings fellow Nixer! ]

Declared by:

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:

programs.hexchat.channels.<name>.nickname

Primary nickname.

Type: null or string

Default:

null

Declared by:

programs.hexchat.channels.<name>.nickname2

Secondary nickname.

Type: null or string

Default:

null

Declared by:

programs.hexchat.channels.<name>.options

Channel options.

Type: null or (submodule)

Default:

null

Example:

{
  autoconnect = true;
  useGlobalUserInformation = true;
}

Declared by:

programs.hexchat.channels.<name>.options.acceptInvalidSSLCertificates

Accept invalid SSL certificates.

Type: null or boolean

Default:

false

Declared by:

programs.hexchat.channels.<name>.options.autoconnect

Autoconnect to network.

Type: null or boolean

Default:

false

Declared by:

programs.hexchat.channels.<name>.options.bypassProxy

Bypass proxy.

Type: null or boolean

Default:

true

Declared by:

programs.hexchat.channels.<name>.options.connectToSelectedServerOnly

Connect to selected server only.

Type: null or boolean

Default:

true

Declared by:

programs.hexchat.channels.<name>.options.forceSSL

Use SSL for all servers.

Type: null or boolean

Default:

false

Declared by:

programs.hexchat.channels.<name>.options.useGlobalUserInformation

Use global user information.

Type: null or boolean

Default:

false

Declared by:

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:

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:

programs.hexchat.channels.<name>.servers

IRC Server Address List.

Type: list of string

Default:

[ ]

Example:

[
  "irc.oftc.net"
]

Declared by:

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:

programs.hexchat.overwriteConfigFiles

Enables overwriting HexChat configuration files (hexchat.conf, servlist.conf). Any existing HexChat configuration will be lost. Make sure 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. Nix/Home Manager updates to be blocked until configuration files are manually removed.

Type: null or boolean

Default:

false

Declared by:

programs.hexchat.settings

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

Type: null or (attribute set of string)

Default:

null

Example:

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

Declared by:

programs.hexchat.theme

Theme package for HexChat. Expects a derivation containing decompressed theme files. Note, .hct files are actually ZIP files, as seen in example.

Type: null or package

Default:

null

Example:

source = pkgs.fetchzip {
  url = "https://dl.hexchat.net/themes/Monokai.hct#Monokai.zip";
  sha256 = "sha256-WCdgEr8PwKSZvBMs0fN7E2gOjNM0c2DscZGSKSmdID0=";
  stripRoot = false;
};

Declared by: