sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2025-01-19 10:03:58 +03:00
Code
samba-mirror/docs-xml/manpages-3/smbcontrol.1.xml

310 lines
9.8 KiB
XML
Raw Normal View History

Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<?xml version="1.0" encoding="iso-8859-1"?>
Use the Samba Variant of the DocBook DTD rather then the original one. Entities are now in samba-web/, so remove them from here. (This used to be commit a66ba7c7e0b00eb9475a495d18e18cada3f6f9dd)
2005-03-12 19:33:59 +00:00
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<refentry id="smbcontrol.1">
<refmeta>
<refentrytitle>smbcontrol</refentrytitle>
<manvolnum>1</manvolnum>
Add man page metadata fields that are used by temprorary manpages XSLT (This used to be commit b2f3f38e57d96132f2befb13359306848c998ffc)
2008-04-06 20:26:45 +00:00
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">User Commands</refmiscinfo>
s3/docs: Raise version number. Karolin
2009-09-08 15:39:57 +02:00
<refmiscinfo class="version">3.6</refmiscinfo>
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
</refmeta>
<refnamediv>
<refname>smbcontrol</refname>
<refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbcontrol</command>
<arg>-i</arg>
<arg>-s</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>smbcontrol</command>
<arg>destination</arg>
<arg>message-type</arg>
<arg>parameter</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
The 'index' manpage is samba(7), not Samba(7). Fixes bug #1142 (This used to be commit 9c3ca3be0c55a8b35a08dcf9f2baa72a1179d0f6)
2004-04-27 14:43:44 +00:00
<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<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>
&stdarg.help;
&stdarg.configfile;
<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 "q" will quit the
program.</para></listitem>
</varlistentry>
Make the change to smbcontrol for "all" to mean broadcast, and "smbd" to mean the main smb daemon. Update docs to match. Jeremy. (This used to be commit e415420b086a236be6bcc1e7584bec276a74e457)
2008-08-18 16:18:34 -07:00
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<varlistentry>
<term>destination</term>
<listitem><para>One of <parameter>nmbd</parameter>, <parameter>smbd</parameter> or a process ID.</para>
Make the change to smbcontrol for "all" to mean broadcast, and "smbd" to mean the main smb daemon. Update docs to match. Jeremy. (This used to be commit e415420b086a236be6bcc1e7584bec276a74e457)
2008-08-18 16:18:34 -07:00
<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
s3/docs: Fix typo. Karolin
2009-04-07 19:55:45 +02:00
parameter smbd used to do this.</para>
Make the change to smbcontrol for "all" to mean broadcast, and "smbd" to mean the main smb daemon. Update docs to match. Jeremy. (This used to be commit e415420b086a236be6bcc1e7584bec276a74e457)
2008-08-18 16:18:34 -07:00
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<para>The <parameter>smbd</parameter> destination causes the
Make the change to smbcontrol for "all" to mean broadcast, and "smbd" to mean the main smb daemon. Update docs to match. Jeremy. (This used to be commit e415420b086a236be6bcc1e7584bec276a74e457)
2008-08-18 16:18:34 -07:00
message to be sent to the smbd daemon specified in the
<filename>smbd.pid</filename> file.</para>
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<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>
Make the change to smbcontrol for "all" to mean broadcast, and "smbd" to mean the main smb daemon. Update docs to match. Jeremy. (This used to be commit e415420b086a236be6bcc1e7584bec276a74e457)
2008-08-18 16:18:34 -07:00
<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>
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<para>If a single process ID is given, the message is sent
to only that process.</para></listitem>
</varlistentry>
Make the change to smbcontrol for "all" to mean broadcast, and "smbd" to mean the main smb daemon. Update docs to match. Jeremy. (This used to be commit e415420b086a236be6bcc1e7584bec276a74e457)
2008-08-18 16:18:34 -07:00
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
<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
"*" 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>debug</term>
<listitem><para>Set debug level to the value specified by the
s3: forward MSG_DEBUG from smbd parent to all children Before 3.3, an smbcontrol debug message sent to the target "smbd" would actually be sent to all running processes including nmbd and winbindd. This behavior was changed in 3.3 so that the "smbd" target would only send a message to the process found in smbd.pid, while the "all" target would send a message to all processes. The ability to set the debug level of all processes within a single daemon, without specifying each pid is quite useful. This was implemented in winbindd in 065760ed. This patch does the same thing for smbd. Upon receiving a MSG_DEBUG the parent smbd will rebroadcast it to all of its children. The printing process has been added to the list of smbd child processes, and we now always track the number of smbd children regardless of the "max smbd processes" setting.
2009-06-16 15:11:32 -07:00
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>
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
</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 occured. 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>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. </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>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>
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
man pages: Correct version string. As Samba 3.2 will be out soon, man pages should be correct for both versions, Samba 3.0 and 3.2. Karolin (This used to be commit 9c59c1895d8d3621f38b67ecf88109c81130c886)
2008-05-13 10:18:37 +02:00
<para>This man page is correct for version 3 of
Add all the source files from the old CVS tree, add the 5 missing chapters from the HOWTO and add jht's Samba by Example book. (This used to be commit 9fb5bcb93e57c5162b3ee6f9c7d777dc0269d100)
2004-04-07 10:15:11 +00:00
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>
<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 <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.</para>
</refsect1>
</refentry>
Copy Permalink