From: Badlop <badlop@process-one.net>
Date: Sat, 14 Apr 2012 21:29:55 +0000 (+0200)
Subject: Document how to provide a long announcement (EJAB-1553)
X-Git-Tag: v2.1.11~28
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=49859683b03652781fc9436118c8d65ea66769d9;p=ejabberd

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

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