summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbcontrol.1.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/htmldocs/smbcontrol.1.html')
-rw-r--r--docs/htmldocs/smbcontrol.1.html314
1 files changed, 278 insertions, 36 deletions
diff --git a/docs/htmldocs/smbcontrol.1.html b/docs/htmldocs/smbcontrol.1.html
index 553a9e9163..2fe363a4ac 100644
--- a/docs/htmldocs/smbcontrol.1.html
+++ b/docs/htmldocs/smbcontrol.1.html
@@ -1,73 +1,315 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcontrol</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcontrol.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbcontrol &#8212; send messages to smbd, nmbd or winbindd processes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbcontrol</tt> [-i] [-s]</p></div><div class="cmdsynopsis"><p><tt class="command">smbcontrol</tt> [destination] [message-type] [parameter]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">smbcontrol</b> is a very small program, which
- sends messages to a <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, a <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, or a <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon running on the system.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
-</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
+<?xml version="1.0"?>
+
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+ <!ENTITY % globalentities SYSTEM 'global.ent'> %globalentities;
+ ]>
+<refentry id="smbcontrol.1">
+
+<refmeta>
+ <refentrytitle>smbcontrol</refentrytitle>
+ <manvolnum>1</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+ <refname>smbcontrol</refname>
+ <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis sepchar=" ">
+ <command moreinfo="none">smbcontrol</command>
+ <arg choice="opt" rep="norepeat">-i</arg>
+ <arg choice="opt" rep="norepeat">-s</arg>
+ </cmdsynopsis>
+
+ <cmdsynopsis sepchar=" ">
+ <command moreinfo="none">smbcontrol</command>
+ <arg choice="opt" rep="norepeat">destination</arg>
+ <arg choice="opt" rep="norepeat">message-type</arg>
+ <arg choice="opt" rep="norepeat">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 moreinfo="none">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>-h|--help</term>
+<listitem><para>Print a summary of command line options.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>-s &lt;configuration file&gt;</term>
+<listitem><para>The file specified contains the
configuration details required by the server. The
information in this file includes server-specific
information such as what printcap file to use, as well
as descriptions of all the services that the server is
-to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
-smb.conf(5)</tt></a> for more information.
+to provide. See <filename moreinfo="none">smb.conf</filename> for more information.
The default configuration file name is determined at
-compile time.</p></dd><dt><span class="term">-i</span></dt><dd><p>Run interactively. Individual commands
+compile time.</para></listitem>
+</varlistentry>
+ <varlistentry>
+ <term>-i</term>
+ <listitem><para>Run interactively. Individual commands
of the form destination message-type parameters can be entered
on STDIN. An empty command line or a &quot;q&quot; will quit the
- program.</p></dd><dt><span class="term">destination</span></dt><dd><p>One of <i class="parameter"><tt>nmbd</tt></i>, <i class="parameter"><tt>smbd</tt></i> or a process ID.</p><p>The <i class="parameter"><tt>smbd</tt></i> destination causes the
- message to &quot;broadcast&quot; to all smbd daemons.</p><p>The <i class="parameter"><tt>nmbd</tt></i> destination causes the
+ program.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>destination</term>
+ <listitem><para>One of <parameter moreinfo="none">nmbd</parameter>, <parameter moreinfo="none">smbd</parameter> or a process ID.</para>
+
+ <para>The <parameter moreinfo="none">smbd</parameter> destination causes the
+ message to &quot;broadcast&quot; to all smbd daemons.</para>
+
+ <para>The <parameter moreinfo="none">nmbd</parameter> destination causes the
message to be sent to the nmbd daemon specified in the
- <tt class="filename">nmbd.pid</tt> file.</p><p>If a single process ID is given, the message is sent
- to only that process.</p></dd><dt><span class="term">message-type</span></dt><dd><p>Type of message to send. See
- the section <tt class="constant">MESSAGE-TYPES</tt> for details.
- </p></dd><dt><span class="term">parameters</span></dt><dd><p>any parameters required for the message-type</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>MESSAGE-TYPES</h2><p>Available message types are:</p><div class="variablelist"><dl><dt><span class="term">close-share</span></dt><dd><p>Order smbd to close the client
+ <filename moreinfo="none">nmbd.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>
+ </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
&quot;*&quot; 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 <tt class="constant">smbd</tt>.</p></dd><dt><span class="term">debug</span></dt><dd><p>Set debug level to the value specified by the
- parameter. This can be sent to any of the destinations.</p></dd><dt><span class="term">force-election</span></dt><dd><p>This message causes the <b class="command">nmbd</b> daemon to
- force a new browse master election. </p></dd><dt><span class="term">ping</span></dt><dd><p>
+ 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.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>force-election</term>
+ <listitem><para>This message causes the <command moreinfo="none">nmbd</command> daemon to
+ force a new browse master election. </para>
+ </listitem></varlistentry>
+
+ <varlistentry>
+ <term>ping</term>
+ <listitem><para>
Send specified number of &quot;ping&quot; messages and
wait for the same number of reply &quot;pong&quot; messages. This can be sent to
- any of the destinations.</p></dd><dt><span class="term">profile</span></dt><dd><p>Change profile settings of a daemon, based on the
+ 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 &quot;on&quot; to turn on profile stats
collection, &quot;off&quot; to turn off profile stats collection, &quot;count&quot;
to enable only collection of count stats (time stats are
disabled), and &quot;flush&quot; to zero the current profile stats. This can
- be sent to any smbd or nmbd destinations.</p></dd><dt><span class="term">debuglevel</span></dt><dd><p>
+ 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.</p></dd><dt><span class="term">profilelevel</span></dt><dd><p>
+ 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.</p></dd><dt><span class="term">printnotify</span></dt><dd><p>
+ 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:
- </p><div class="variablelist"><dl><dt><span class="term">queuepause printername</span></dt><dd><p>Send a queue pause change notify
- message to the printer specified.</p></dd><dt><span class="term">queueresume printername</span></dt><dd><p>Send a queue resume change notify
- message for the printer specified.</p></dd><dt><span class="term">jobpause printername unixjobid</span></dt><dd><p>Send a job pause change notify
+ </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.</p></dd><dt><span class="term">jobresume printername unixjobid</span></dt><dd><p>Send a job resume change notify
+ 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.</p></dd><dt><span class="term">jobdelete printername unixjobid</span></dt><dd><p>Send a job delete change notify
+ 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.</p></dd></dl></div><p>
+ 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.
- </p><p>This message can only be sent to <tt class="constant">smbd</tt>. </p></dd><dt><span class="term">samsync</span></dt><dd><p>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <tt class="constant">smbd</tt>. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Not working at the moment</p></div></dd><dt><span class="term">samrepl</span></dt><dd><p>Send sam replication message, with specified serial. Can only be sent to <tt class="constant">smbd</tt>. Should not be used manually.</p></dd><dt><span class="term">dmalloc-mark</span></dt><dd><p>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </p></dd><dt><span class="term">dmalloc-log-changed</span></dt><dd><p>
+ </para>
+
+ <para>This message can only be sent to <constant>smbd</constant>. </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>samsync</term>
+ <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>
+
+ <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. </p></dd><dt><span class="term">shutdown</span></dt><dd><p>Shut down specified daemon. Can be sent to both smbd and nmbd.</p></dd><dt><span class="term">pool-usage</span></dt><dd><p>Print a human-readable description of all
+ 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.</p></dd><dt><span class="term">drvupgrade</span></dt><dd><p>Force clients of printers using specified driver
+ 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.</p></dd><dt><span class="term">reload-config</span></dt><dd><p>Force daemon to reload smb.conf configuration file. Can be sent
- to <tt class="constant">smbd</tt>, <tt class="constant">nmbd</tt>, or <tt class="constant">winbindd</tt>.
- </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of
- the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> and <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
+ 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>
+
+</variablelist>
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+
+ <para>This man page is correct for version 3.0 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.</p><p>The original Samba man pages were written by Karl Auer.
+ to the way the Linux kernel is developed.</para>
+
+ <para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
- excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
- ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
+ excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
+ ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
- Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>
+ Samba 3.0 was done by Alexander Bokovoy.</para>
+</refsect1>
+
+</refentry>