Add documentation for new messages in 3.0

docs/docbook/manpages/smbcontrol.1.sgml

@@ -1,4 +1,6 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
 <refentry id="smbcontrol.1">
 
 <refmeta>
@@ -16,6 +18,7 @@
 	<cmdsynopsis>
 		<command>smbcontrol</command>
 		<arg>-i</arg>
+		<arg>-s</arg>
 	</cmdsynopsis>
 	
 	<cmdsynopsis>
@@ -44,6 +47,8 @@
 	<title>OPTIONS</title>
 
 	<variablelist>
+		&stdarg.help;
+		&stdarg.configfile;
 		<varlistentry>
 		<term>-i</term>
 		<listitem><para>Run interactively. Individual commands 
@@ -70,58 +75,92 @@
 		
 		<varlistentry>
 		<term>message-type</term>
-		<listitem><para>One of: <constant>close-share</constant>,
+		<listitem><para>Type of message to send. See 
-		<constant>debug</constant>, 
+		the section <constant>MESSAGE-TYPES</constant> for details.
-		<constant>force-election</constant>, <constant>ping
+		</para></listitem></varlistentry>
-		</constant>, <constant>profile</constant>, <constant>
-		debuglevel</constant>, <constant>profilelevel</constant>, 
-		or <constant>printnotify</constant>.</para>
 		
-		<para>The <constant>close-share</constant> message-type sends a 
+
-		message to smbd which will then close the client connections to
+	
-		the named share. Note that this doesn't affect client connections
+		<varlistentry>
-		to any other shares. This message-type takes an argument of the
+		<term>parameters</term>
+		<listitem><para>any parameters required for the message-type</para>
+		</listitem>
+		</varlistentry>
+	</variablelist>
+	
+</refsect1>
+
+<refsect1>
+	<title>MESSAGE-TYPES</title>
+
+	<para>Available message types are:</para>
+
+	<variablelist>
+	<varlistentry><term>close-share</term>
+	<listitem><para>Order smbd to close the client 
+	connections to the named share. Note that this doesn't affect client 
+	connections to any other shares. This message-type takes an argument of the
 	share name for which client connections will be closed, or the
 	"*" character which will close all currently open shares.
 	This may be useful if you made changes to the access controls on the share.
 	This message can only be sent to <constant>smbd</constant>.</para>
+	</listitem>
+	</varlistentry>
 
-		<para>The <constant>debug</constant> message-type allows 
+	<varlistentry>
-		the debug level to be set to the value specified by the 
+	<term>debug</term>
+	<listitem><para>Set debug level to the value specified by the 
 	parameter. This can be sent to any of the destinations.</para>
+	</listitem>
+	</varlistentry>
 
-		<para>The <constant>force-election</constant> message-type can only be 
+	<varlistentry>
-		sent to the <constant>nmbd</constant> destination. This message 
+	<term>force-election</term>
-		causes the <command>nmbd</command> daemon to force a new browse
+	<listitem><para>This message causes the <command>nmbd</command> daemon to 
-		master election.</para>
+	force a new browse master election. </para>
+	</listitem></varlistentry>
 
-		<para>The <constant>ping</constant> message-type sends the 
+	<varlistentry>
-		number of "ping" messages specified by the parameter and waits 
+	<term>ping</term>
-		for the same number of  reply "pong" messages. This can be sent to 
+	<listitem><para>
+	Send specified number of "ping" messages and 
+	wait for the same number of  reply "pong" messages. This can be sent to 
 	any of the destinations.</para>
+	</listitem>
+	</varlistentry>
 
-		<para>The <constant>profile</constant> message-type sends a 
+	<varlistentry>
-		message to an smbd to change the profile settings based on the 
+	<term>profile</term>
+	<listitem><para>Change profile settings of a daemon, based on the 
 	parameter. The parameter can be "on" to turn on profile stats 
 	collection, "off" to turn off profile stats collection, "count"
 	to enable only collection of count stats (time stats are 
 	disabled), and "flush" to zero the current profile stats. This can 
 	be sent to any smbd or nmbd destinations.</para>
+	</listitem></varlistentry>
 
-		<para>The <constant>debuglevel</constant> message-type sends 
+	<varlistentry>
-		a "request debug level" message. The current debug level setting 
+	<term>debuglevel</term>
-		is returned by a  "debuglevel" message. This can be 
+	<listitem><para>
-		sent to any of the destinations.</para>
+	Request debuglevel of a certain daemon and write it to stdout. This 
+	can be sent to any of the destinations.</para>
+	</listitem>
+	</varlistentry>
 
-		<para>The <constant>profilelevel</constant> message-type sends 
+	<varlistentry>
-		a "request profile level" message.  The current profile level 
+	<term>profilelevel</term>
-		setting is returned by a  "profilelevel" message. This can be sent 
+	<listitem><para>
-		to any smbd or nmbd destinations.</para>
+	Request profilelevel of a certain daemon and write it to stdout. 
+	This can be sent to any smbd or nmbd destinations.</para>
+	</listitem>
+	</varlistentry>
 
-		<para>The <constant>printnotify</constant> message-type sends a 
+	<varlistentry>
-		message to smbd which in turn sends a printer notify message to 
+	<term>printnotify</term>
-		any Windows NT clients connected to a printer. This message-type
+	<listitem><para>
-		takes the following arguments:
+	Order smbd to send a printer notify message to any Windows NT clients 
+	connected to a printer. This message-type takes the following arguments:
+	</para>
 	
 	<variablelist>
 
@@ -157,33 +196,68 @@
 	    message for the printer and unix jobid
 	    specified.</para></listitem> 
 	    </varlistentry>
-
 	</variablelist>
 
+	<para>
 	Note that this message only sends notification that an
 	event has occured.  It doesn't actually cause the
 	event to happen.
-
-		This message can only be sent to <constant>smbd</constant>. 
 	</para>
 
+	<para>This message can only be sent to <constant>smbd</constant>. </para>
 	</listitem>
 	</varlistentry>
 
-
 	<varlistentry>
-		<term>parameters</term>
+	<term>samsync</term>
-		<listitem><para>any parameters required for the message-type</para>
+	<listitem><para>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <constant>smbd</constant>. </para>
+	<note><para>Not working at the moment</para></note>
 	</listitem>
 	</varlistentry>
-	</variablelist>
 
+	<varlistentry>
+	<term>samrepl</term>
+	<listitem><para>Send sam replication message, with specified serial. Can only be sent to <constant>smbd</constant>. Should not be used manually.</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>dmalloc-mark</term>
+	<listitem><para>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>dmalloc-log-changed</term>
+	<listitem><para>
+	Dump the pointers that have changed since the mark set by dmalloc-mark. 
+	Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>shutdown</term>
+	<listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>tallocdump and pool-usage</term>
+	<listitem><para>Print a human-readable description of all 
+	talloc(pool) memory usage by the specified daemon/process. Available 
+	for both smbd and nmbd.</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>drvupgrade</term>
+	<listitem><para>Force clients of printers using specified driver 
+	to update their local version of the driver. Can only be 
+	sent to smbd.</para></listitem>
+	</varlistentry>
+
+</variablelist>
 </refsect1>
 
 <refsect1>
 	<title>VERSION</title>
 
-	<para>This man page is correct for version 2.2 of 
+	<para>This man page is correct for version 3.0 of 
 	the Samba suite.</para>
 </refsect1>