aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2012-04-14 23:29:55 +0200
committerBadlop <badlop@process-one.net>2012-04-14 23:29:55 +0200
commit49859683b03652781fc9436118c8d65ea66769d9 (patch)
tree6e62aebf29f26e122762931886942b033fa3b8f8 /src
parentHandle the scenario of disabled mod_muc (EJAB-1553) (diff)
Document how to provide a long announcement (EJAB-1553)
Diffstat (limited to 'src')
-rw-r--r--src/ejabberd_admin.erl4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl
index 24f8aab12..b7fbbd00c 100644
--- a/src/ejabberd_admin.erl
+++ b/src/ejabberd_admin.erl
@@ -85,6 +85,10 @@ commands() ->
args = [], result = {res, rescode}},
#ejabberd_commands{name = stop_kindly, tags = [server],
desc = "Inform users and rooms, wait, and stop the server",
+ longdesc = "Provide the delay in seconds, and the "
+ "announcement quoted, for example: \n"
+ "ejabberdctl stop_kindly 60 "
+ "\\\"The server will stop in one minute.\\\"",
module = ?MODULE, function = stop_kindly,
args = [{delay, integer}, {announcement, string}],
result = {res, rescode}},