aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexey Shchepin <alexey@process-one.net>2004-08-22 21:54:14 +0000
committerAlexey Shchepin <alexey@process-one.net>2004-08-22 21:54:14 +0000
commit4103f30812ed99c984a2fdb16aabca139c9255d7 (patch)
tree449c3946ebd1e8c040656e119c4276e2d2d9cb00 /doc
parent* src/msgs/nl.msg: Updated (thanks to Sander Devrieze) (diff)
* src/mod_offline.erl: Added entire table locking on large message
queue * src/ejabberd_sm.erl: Added offline_subscription_hook * src/mod_offline.erl: Use offline_subscription_hook * src/configure.erl: Updated (thanks to Sergei Golovan) * src/Makefile.win32: Likewise * src/tls/Makefile.win32: Likewise * src/win32/: Likewise * src/mod_announce.erl: Added announce to all users (thanks to Sergei Golovan) * doc/guide.tex: Updated (thanks to Sergei Golovan) SVN Revision: 259
Diffstat (limited to 'doc')
-rw-r--r--doc/guide.html23
-rw-r--r--doc/guide.tex20
2 files changed, 41 insertions, 2 deletions
diff --git a/doc/guide.html b/doc/guide.html
index 1d0927ac8..9090e5b9b 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -824,8 +824,27 @@ Example:
<H3><A NAME="htoc32">A.2</A>&nbsp;&nbsp;<TT>mod_announce</TT></H3><!--SEC END -->
<A NAME="sec:modannounce"></A>
-This module adds support for broadcast announce messages and MOTD.<BR>
-<BR>
+This module adds support for broadcast announce messages and MOTD.
+When the module is loaded, it handles messages sent to the following JID's
+(suppose that main server has address <TT>example.org</TT>):
+<DL COMPACT=compact><DT>
+<B><TT>example.org/announce/all</TT></B><DD> Message is sent to all registered users.
+If the user is online and connected to several resources, only resource with
+the highest priority will receive the message. If the registered user is
+not connected, the message will be stored offline (if oflline storage is
+available).
+<DT><B><TT>example.org/announce/online</TT></B><DD> Message is sent to all connected users.
+If the user is online and connected to several resources, all resources
+will receive the message.
+<DT><B><TT>example.org/announce/motd</TT></B><DD> Message is set as MOTD (Message of the Day)
+and will be sent to users as they login. In addition the message is sent to
+all connected users (similar to <TT>announce/online</TT> resource).
+<DT><B><TT>example.org/announce/motd/update</TT></B><DD> Message is set as MOTD (Message of the Day)
+and will be sent to users as they login. The message is <EM>not sent</EM> to
+all connected users.
+<DT><B><TT>example.org/announce/motd/delete</TT></B><DD> Any message sent to this JID
+removes existing MOTD.
+</DL>
Options:
<DL COMPACT=compact><DT>
<B><TT>access</TT></B><DD> Specifies who is allowed to send announce messages
diff --git a/doc/guide.tex b/doc/guide.tex
index 5e12c70db..573fdfd6d 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -817,6 +817,26 @@ Example:
\label{sec:modannounce}
This module adds support for broadcast announce messages and MOTD.
+When the module is loaded, it handles messages sent to the following JID's
+(suppose that main server has address \jid{example.org}):
+\begin{description}
+\titem{example.org/announce/all} Message is sent to all registered users.
+If the user is online and connected to several resources, only resource with
+the highest priority will receive the message. If the registered user is
+not connected, the message will be stored offline (if oflline storage is
+available).
+\titem{example.org/announce/online} Message is sent to all connected users.
+If the user is online and connected to several resources, all resources
+will receive the message.
+\titem{example.org/announce/motd} Message is set as MOTD (Message of the Day)
+and will be sent to users as they login. In addition the message is sent to
+all connected users (similar to \term{announce/online} resource).
+\titem{example.org/announce/motd/update} Message is set as MOTD (Message of the Day)
+and will be sent to users as they login. The message is \emph{not sent} to
+all connected users.
+\titem{example.org/announce/motd/delete} Any message sent to this JID
+removes existing MOTD.
+\end{description}
Options:
\begin{description}