Adding upstream version 2:4.17.12+dfsg.upstream/2%4.17.12+dfsgupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 363 insertions, 0 deletions

diff --git a/docs-xml/manpages/smbcontrol.1.xml b/docs-xml/manpages/smbcontrol.1.xml
new file mode 100644
index 0000000..4b5d90c
--- /dev/null
+++ b/docs-xml/manpages/smbcontrol.1.xml
@@ -0,0 +1,363 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="smbcontrol.1">
+
+<refmeta>
+	<refentrytitle>smbcontrol</refentrytitle>
+	<manvolnum>1</manvolnum>
+	<refmiscinfo class="source">Samba</refmiscinfo>
+	<refmiscinfo class="manual">User Commands</refmiscinfo>
+	<refmiscinfo class="version">&doc.version;</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+	<refname>smbcontrol</refname>
+	<refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>smbcontrol</command>
+		<arg choice="opt">-?|--help</arg>
+		<arg choice="opt">--usage</arg>
+		<arg choice="opt">-t|--timeout</arg>
+		<arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
+		<arg choice="opt">--debug-stdout</arg>
+		<arg choice="opt">--configfile=CONFIGFILE</arg>
+		<arg choice="opt">--option=name=value</arg>
+		<arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
+		<arg choice="opt">--leak-report</arg>
+		<arg choice="opt">--leak-report-full</arg>
+	</cmdsynopsis>
+	
+	<cmdsynopsis>
+		<command>smbcontrol</command>
+		<arg>destination</arg>
+		<arg>message-type</arg>
+		<arg>parameter</arg>
+	</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>DESCRIPTION</title>
+
+	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+	<manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+	<para><command>smbcontrol</command> is a very small program, which 
+	sends messages to a <citerefentry><refentrytitle>smbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry>, a <citerefentry><refentrytitle>nmbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry>, or a <citerefentry><refentrytitle>winbindd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry> daemon running on the system.</para>
+</refsect1>
+
+
+<refsect1>
+	<title>OPTIONS</title>
+
+	<variablelist>
+		<varlistentry>
+		<term>-t|--timeout</term>
+		<listitem><para>
+				Set timeout to seconds.
+		</para></listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>destination</term>
+		<listitem><para>One of <parameter>nmbd</parameter>,
+		<parameter>smbd</parameter>, <parameter>winbindd</parameter>
+		or a process ID.</para>
+
+		<para>The <parameter>all</parameter> destination causes the 
+		message to "broadcast" to all running daemons including nmbd and
+		winbind. This is a change for Samba 3.3, prior to this the
+		parameter smbd used to do this.</para>
+
+		<para>The <parameter>smbd</parameter> destination causes the 
+		message to be sent to the smbd daemon specified in the 
+		<filename>smbd.pid</filename> file.</para>
+
+		<para>The <parameter>nmbd</parameter> destination causes the 
+		message to be sent to the nmbd daemon specified in the 
+		<filename>nmbd.pid</filename> file.</para>
+
+		<para>The <parameter>winbindd</parameter> destination causes the 
+		message to be sent to the winbind daemon specified in the 
+		<filename>winbindd.pid</filename> file.</para>
+
+		<para>If a single process ID is given, the message is sent 
+		to only that process.</para></listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>message-type</term>
+		<listitem><para>Type of message to send. See 
+		the section <constant>MESSAGE-TYPES</constant> for details.
+		</para></listitem></varlistentry>
+
+		<varlistentry>
+		<term>parameters</term>
+		<listitem><para>any parameters required for the message-type</para>
+		</listitem>
+		</varlistentry>
+
+		&popt.autohelp;
+		&cmdline.common.samba.client;
+	</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>
+
+	<varlistentry><term>close-denied-share</term>
+	<listitem><para>Behave like <constant>close-share</constant>,
+	but don't disconnect users that are still allowed to access
+	the share. It can safely be sent to all smbds after changing
+	share access controls. It will only affect users who have been
+	denied access since having connected initially. This message
+	can only be sent to <constant>smbd</constant>.</para>
+	</listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>debug</term>
+	<listitem><para>Set debug level to the value specified by the 
+	parameter. This can be sent to any of the destinations. If this
+	message is sent to either the smbd or winbindd daemons, the parent
+	process will rebroadcast the message to all child processes changing
+	the debug level in each one.</para>
+	</listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>kill-client-ip</term>
+	<listitem><para>Order smbd to close the client connections from a
+	given IP address. This message-type takes an argument of the IP
+	address from which client connections will be closed. This message
+	can only be sent to <constant>smbd</constant>.</para>
+	</listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>force-election</term>
+	<listitem><para>This message causes the <command>nmbd</command> daemon to 
+	force a new browse master election. </para>
+	</listitem></varlistentry>
+
+	<varlistentry>
+	<term>ping</term>
+	<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>
+
+	<varlistentry>
+	<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>
+
+	<varlistentry>
+	<term>debuglevel</term>
+	<listitem><para>
+	Request debuglevel of a certain daemon and write it to stdout. This 
+	can be sent to any of the destinations.</para>
+	</listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>profilelevel</term>
+	<listitem><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>
+
+	<varlistentry>
+	<term>printnotify</term>
+	<listitem><para>
+	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>
+
+	    <varlistentry>
+	    <term>queuepause printername</term>
+	    <listitem><para>Send a queue pause change notify
+	    message to the printer specified.</para></listitem>
+ 	    </varlistentry>
+
+	    <varlistentry>
+	    <term>queueresume printername</term>
+	    <listitem><para>Send a queue resume change notify
+	    message for the printer specified.</para></listitem>
+ 	    </varlistentry>
+
+		<varlistentry>
+	    <term>jobpause printername unixjobid</term>
+	    <listitem><para>Send a job pause change notify
+	    message for the printer and unix jobid
+	    specified.</para></listitem> 
+ 	    </varlistentry>
+
+	    <varlistentry>
+	    <term>jobresume printername unixjobid</term>
+	    <listitem><para>Send a job resume change notify
+	    message for the printer and unix jobid
+	    specified.</para></listitem>  
+	    </varlistentry>
+
+	    <varlistentry>
+	    <term>jobdelete printername unixjobid</term>
+	    <listitem><para>Send a job delete change notify
+	    message for the printer and unix jobid
+	    specified.</para></listitem> 
+	    </varlistentry>
+	</variablelist>
+
+	<para>
+	Note that this message only sends notification that an
+	event has occurred.  It doesn't actually cause the
+	event to happen.
+	</para>
+
+	<para>This message can only be sent to <constant>smbd</constant>. </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>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>ringbuf-log</term>
+	<listitem><para>Fetch and print the ringbuf log. Requires
+	<parameter>logging = ringbuf</parameter>. Available for smbd, winbindd
+	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>
+
+	<varlistentry>
+	<term>reload-config</term>
+	<listitem><para>Force daemon to reload smb.conf configuration file. Can be sent
+	to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>.
+	</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>reload-printers</term>
+	<listitem><para>Force smbd to reload printers. Can only be sent to
+	<constant>smbd</constant>.
+	</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>idmap</term>
+	<listitem><para>Notify about changes of id mapping. Can be sent
+	to <constant>smbd</constant> or (not implemented yet) <constant>winbindd</constant>.
+	</para></listitem>
+
+	<variablelist>
+	  <varlistentry>
+	    <term>flush [uid|gid]</term>
+	    <listitem><para>Flush caches for sid &lt;-&gt; gid and/or sid &lt;-&gt; uid mapping.
+	    </para></listitem>
+	  </varlistentry>
+	  <varlistentry>
+	    <term>delete &lt;ID&gt;</term>
+	    <listitem><para>Remove a mapping from cache. The mapping is given by &lt;ID&gt;
+	    which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
+	    </para></listitem>
+	  </varlistentry>
+	  <varlistentry>
+	    <term>kill &lt;ID&gt;</term>
+	    <listitem><para>Remove a mapping from cache. Terminate <constant>smbd</constant> if
+	    the id is currently in use.</para></listitem>
+	  </varlistentry>
+	</variablelist>
+	</varlistentry>
+
+	<varlistentry>
+	<term>num-children</term>
+	<listitem><para>Query the number of smbd child processes. This
+	message can only be sent
+	to <constant>smbd</constant>.</para></listitem>
+	</varlistentry>
+
+</variablelist>
+</refsect1>
+
+<refsect1>
+	<title>VERSION</title>
+
+	<para>This man page is part of version &doc.version; of
+	the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+	<title>SEE ALSO</title>
+	<para><citerefentry><refentrytitle>nmbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry>.</para>
+</refsect1>
+
+<refsect1>
+	<title>AUTHOR</title>
+	
+	<para>The original Samba software and related utilities 
+	were created by Andrew Tridgell. Samba is now developed
+	by the Samba Team as an Open Source project similar 
+	to the way the Linux kernel is developed.</para>
+</refsect1>
+
+</refentry>