Document how to provide a long announcement (EJAB-1553)

This commit is contained in:
Badlop 2012-04-14 23:29:55 +02:00
parent 169b83b36d
commit 49859683b0
1 changed files with 4 additions and 0 deletions

View File

@ -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}},