From d34b60161b4c674c5f41dbd1bf8e29a7e9d99d77 Mon Sep 17 00:00:00 2001 From: Blair Bonnett Date: Tue, 14 Aug 2012 12:30:43 +1200 Subject: [PATCH] UCMD plugin: extra documentation, add commands for other plugins. Adds entries for the !motd, !rules, and !history commands in the user command menu. --- doc/plugins.conf | 9 ++++++++- doc/ucmd.conf | 8 ++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/doc/plugins.conf b/doc/plugins.conf index 672d787..ff15da7 100644 --- a/doc/plugins.conf +++ b/doc/plugins.conf @@ -60,8 +60,15 @@ plugin /var/lib/uhub/mod_welcome.so "motd=/etc/uhub/motd.txt rules=/etc/uhub/rul # history_connect: the number of chat history messages to send when users connect (0 = do not send any history) plugin /var/lib/uhub/mod_chat_history.so "history_max=200 history_default=10 history_connect=5" -# A plugin to send user commands. +# A plugin to send user commands. These are custom commands which are shown in +# the right-click menu of the users client software and allows easy usage of +# hub commands. # # Parameters: # file: the file where the list of user commands is stored. +# +# NB. Any changes to the commands (if you either change the file location, or +# edit the file itself) will be picked up when you reload the configuration. +# However, the menu that users see is not auto-refreshed i.e., users will not +# see the changes to the commands until they disconnect and reconnect. plugin /var/lib/uhub/mod_ucmd.so "file=/etc/uhub/ucmd.conf" diff --git a/doc/ucmd.conf b/doc/ucmd.conf index 6687578..1289a39 100644 --- a/doc/ucmd.conf +++ b/doc/ucmd.conf @@ -95,6 +95,14 @@ Chat 0 !myip Chat 0 !uptime 0 hub,user Hub version Chat 0 !version +0 hub,user BasicSeparator +Separator +0 hub,user Message of the day +Chat 0 !motd +0 hub,user Hub rules +Chat 0 !rules +0 hub,user Chat history +Chat 0 !history %[line:How many lines of history do you want to see?] # Put a separator before operator commands. 4 user OpSeparator