senpai(5)

The address (host[:port]) of the IRC server. senpai uses TLS connections by default unless you specify tls option to be false. TLS connections default to port 6697, plain-text use port 6667.

An optional scheme can be specified (scheme://host[:port]):

•

irc:// is the implicit default, TLS is enabled or disabled according to the tls configuration value.

•

ircs:// enables TLS.

•

irc+insecure:// disables TLS (plain-text IRC).

•

ircs+insecure:// enables TLS but skips TLS certificate verification. This protects against passive MITM attacks but not against active MITM attacks.

Your nickname, sent with a NICK IRC message. It mustn't contain spaces or colons (:).

Your real name, or actually just a field that will be available to others and may contain spaces and colons. Sent with the USER IRC message. By default, the value of nick is used.

Your username, sent with the USER IRC message and also used for SASL authentication. By default, the value of nick is used.

Your password, used for SASL authentication. See also password-cmd.

Alternatively to providing your SASL authentication password directly in plaintext, you can specify a command to be run to fetch the password at runtime. This is useful if you store your passwords in a separate (probably encrypted) file using `gpg` or a command line password manager such as pass or gopass. If a password-cmd is provided, the value of password will be ignored and the first line of the output of password-cmd will be used for login.

The command and arguments are already quoted by scfg, so there is no need to additionally quote the whole command string. For example:

password-cmd pass "Messaging/irc"

A space separated list of channel names that senpai will automatically join at startup and server reconnect. This directive can be specified multiple times.

This directive should not be used when using a bouncer, as the bouncer already remembers and joins senpai to its saved channels automatically.

A space separated list of keywords that will trigger a notification and a display indicator when said by others. This directive can be specified multiple times.

By default, senpai will use your current nickname.

Enable sending the bell character (BEL) when you are highlighted. Defaults to disabled.

Configure the width of various UI panes.

Pane widths are set as sub-directives of the main pane-widths directive:

pane-widths {
    nicknames 16
}

This directive supports the following sub-directives:

nicknames

channels

members

text

Enable TLS encryption. Defaults to true.

Send typing notifications which let others know when you are typing a message. Defaults to true.

Enable or disable mouse support. Defaults to true.

Enable spell checking using harper-ls. Requires harper-ls to be installed. English only for now. Defaults to false.

Settings for colors of different UI elements.

Colors can be set either by name ("red"), by number (from 0 to 255, for the default 256 terminal colors; -1 meaning default), or by RGB hex true color (#rrggbb).

Colors are set as sub-directives of the main colors directive:

colors {
    prompt green
}

Settings for custom keyboard shortcuts.

Shortcuts are defined by `<key> <action> [<params>...]` subdirectives:

shortcuts {
    Alt+k cursor-delete-after
    Shift+Alt+Page_Up set-editor "/me slaps OP with a large trout"
}

Keys are optional modifiers (Control/Shift/Alt/Super) and a key name, which can either be a literal character (e.g. k) or a name for that key, taken from the XKB key names (on Linux, see wev for finding key names, e.g. Page_Up, XF86AudioPlay).

A custom shortcut will override any default shortcut for that key.

Advanced. Dump all sent and received data to the home buffer, useful for debugging. Defaults to false.

Advanced. Run an ephemeral instance without disk reads/writes (except for the initial configuration). Can be useful for public instances. Defaults to false.

Advanced. Enables integrations with the local system (e.g. notifications through DBus). Can be useful to disable on systems planned to be used through SSH. Defaults to true.

Advanced. senpai will notify you by default without the need for a custom highlight script. Alternative path to a shell script to be executed when you are highlighted. By default, senpai looks for a highlight shell script at $XDG_CONFIG_HOME/senpai/highlight. If no file is found at that path, and an alternate path is not provided, highlight command execution is disabled.

If unset, $XDG_CONFIG_HOME defaults to ~/.config/.

Before the highlight script is executed, the following environment variables are populated:

Shell scripts MUST ENSURE VARIABLES appear QUOTED in the script file, OR YOU WILL BE OPEN TO SHELL INJECTION ATTACKS. Shell scripts must also ensure characters like '*' and '?' are not expanded.

Note: when passing those to notify-send(1), some notification daemons use \ for escape sequences in the body, which causes \ to disappear from the message or triggers unintended side-effects (like newlines).

To get around this, you can double the backslash with the following snippet:

#!/bin/sh
escape() {
	printf "%s" "$1" | sed 's#\\#\\\\#g'
}
notify-send "[$BUFFER] $SENDER" "$(escape "$MESSAGE")"

address irc.libera.chat
nickname Guest123456

address irc.libera.chat
nickname Guest123456
username senpai
realname "Guest von Lenon"
password-cmd gopass show irc/guest # use your favorite CLI password solution here
channel "#rahxephon"
pane-widths {
	nicknames 10
	channels 16
	members 16
}
colors {
	nicks extended
}
shortcuts {
    Alt+k cursor-delete-after
}