Moving docs tree to docs-xml to make room for generated docs in the release tarball.

(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)

1 files changed, 79 insertions, 0 deletions

diff --git a/docs-xml/smbdotconf/misc/messagecommand.xml b/docs-xml/smbdotconf/misc/messagecommand.xml
new file mode 100644
index 0000000000..91df58ab5d
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/messagecommand.xml
@@ -0,0 +1,79 @@
+<samba:parameter name="message command"
+	         context="G"
+			 type="string"
+		 advanced="1" developer="1"
+		 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This specifies what command to run when the 
+	server receives a WinPopup style message.</para>
+
+	<para>This would normally be a command that would 
+	deliver the message somehow. How this is to be done is 
+	up to your imagination.</para>
+
+	<para>An example is:
+<programlisting>
+<command moreinfo="none">message command = csh -c 'xedit %s;rm %s' &amp;</command>
+</programlisting>
+	</para>
+
+	<para>This delivers the message using <command moreinfo="none">xedit</command>, then 
+	removes it afterwards. <emphasis>NOTE THAT IT IS VERY IMPORTANT 
+	THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I 
+	have the '&amp;' on the end. If it doesn't return immediately then 
+	your PCs may freeze when sending messages (they should recover 
+	after 30 seconds, hopefully).</para>
+
+	<para>All messages are delivered as the global guest user. 
+	The command takes the standard substitutions, although <parameter moreinfo="none">
+	%u</parameter> won't work (<parameter moreinfo="none">%U</parameter> may be better 
+	in this case).</para>
+
+	<para>Apart from the standard substitutions, some additional 
+	ones apply. In particular:</para>
+
+	<itemizedlist>
+		<listitem>
+			<para><parameter moreinfo="none">%s</parameter> = the filename containing 
+				the message.</para>
+		</listitem>
+			
+		<listitem>
+			<para><parameter moreinfo="none">%t</parameter> = the destination that 
+				the message was sent to (probably the server name).</para>
+		</listitem>
+
+		<listitem>
+			<para><parameter moreinfo="none">%f</parameter> = who the message 
+				is from.</para>
+		</listitem>
+	</itemizedlist>
+
+	<para>You could make this command send mail, or whatever else 
+	takes your fancy. Please let us know of any really interesting 
+	ideas you have.</para>
+
+	<para>
+	Here's a way of sending the messages as mail to root:
+<programlisting>
+<command moreinfo="none">message command = /bin/mail -s 'message from %f on %m' root &lt; %s; rm %s</command>
+</programlisting>
+	</para>
+
+	<para>If you don't have a message command then the message 
+	won't be delivered and Samba will tell the sender there was 
+	an error. Unfortunately WfWg totally ignores the error code 
+	and carries on regardless, saying that the message was delivered.
+	</para>
+
+	<para>
+	If you want to silently delete it then try:
+<programlisting>
+<command moreinfo="none">message command = rm %s</command>
+</programlisting>
+	</para>
+	
+</description>
+<value type="default"></value>
+<value type="example">csh -c 'xedit %s; rm %s' &amp;</value>
+</samba:parameter>