mod_welcome

Greet users with a message of the day. Part of the bundled plug-ins.

mod_welcome sends a message of the day (MOTD) to each user when they log in, and optionally publishes hub rules. Each configured file also gets a command so users can re-read it on demand.

Loading

plugin /var/lib/uhub/mod_welcome.so "motd=/etc/uhub/motd.txt rules=/etc/uhub/rules.txt"

Configuration

Option	Default	Description
motd	—	File whose contents are sent to each user on login. Enables the !motd command.
rules	—	File with the hub rules. Enables the !rules command (not sent automatically).

Commands

Command	Access	Description
!motd	guest	Show the message of the day (when motd is configured).
!rules	guest	Show the hub rules (when rules is configured).

Substitutions

The following placeholders are expanded in the MOTD and rules text:

Token	Expands to
%n	the user's nick
%a	the user's IP address
%c	the user's credentials (guest, user, operator, …)
%%	a literal percent sign
%H %I %M %S %p %P	current time fields (hour 24h / hour 12h / minute / second / am-pm)