diff options
Diffstat (limited to 'docs/htmldocs/smbcontrol.1.html')
| -rw-r--r-- | docs/htmldocs/smbcontrol.1.html | 444 |
1 files changed, 379 insertions, 65 deletions
diff --git a/docs/htmldocs/smbcontrol.1.html b/docs/htmldocs/smbcontrol.1.html index 6fa017fdb0..12662dcc04 100644 --- a/docs/htmldocs/smbcontrol.1.html +++ b/docs/htmldocs/smbcontrol.1.html @@ -1,71 +1,385 @@ -<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.59.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 class="refnamediv"><h2>Name</h2><p>smbcontrol — send messages to smbd, nmbd or winbindd processes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>smbcontrol</tt> [-i] [-s]</p></div><div class="cmdsynopsis"><p><tt>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">Samba(7)</a> suite.</p><p><b>smbcontrol</b> is a very small program, which - sends messages to a <a href="smbd.8.html">smbd(8)</a>, a <a href="nmbd.8.html">nmbd(8)</a>, or a <a href="winbindd.8.html">winbindd(8)</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 <configuration file></span></dt><dd><p>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> -smb.conf(5)</tt></a> 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 +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<HTML +><HEAD +><TITLE +>smbcontrol</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.77"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><H1 +><A +NAME="SMBCONTROL" +></A +>smbcontrol</H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN5" +></A +><H2 +>Name</H2 +>smbcontrol -- send messages to smbd, nmbd or winbindd processes</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN8" +></A +><H2 +>Synopsis</H2 +><P +><B +CLASS="COMMAND" +>smbcontrol</B +> [-i]</P +><P +><B +CLASS="COMMAND" +>smbcontrol</B +> [destination] [message-type] [parameter]</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN17" +></A +><H2 +>DESCRIPTION</H2 +><P +>This tool is part of the <A +HREF="samba.7.html" +TARGET="_top" +> Samba</A +> suite.</P +><P +><B +CLASS="COMMAND" +>smbcontrol</B +> is a very small program, which + sends messages to an <A +HREF="smbd.8.html" +TARGET="_top" +>smbd(8)</A +>, + an <A +HREF="nmbd.8.html" +TARGET="_top" +>nmbd(8)</A +> + or a <A +HREF="winbindd.8.html" +TARGET="_top" +>winbindd(8)</A +> + daemon running on the system.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN26" +></A +><H2 +>OPTIONS</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>-i</DT +><DD +><P +>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.</p></dd><dt><span class="term">destination</span></dt><dd><p>One of <i><tt>nmbd</tt></i>, <i><tt>smbd</tt></i> or a process ID.</p><p>The <i><tt>smbd</tt></i> destination causes the - message to "broadcast" to all smbd daemons.</p><p>The <i><tt>nmbd</tt></i> destination causes the + on STDIN. An empty command line or a "q" will quit the + program.</P +></DD +><DT +>destination</DT +><DD +><P +>One of <TT +CLASS="PARAMETER" +><I +>nmbd</I +></TT +> + <TT +CLASS="PARAMETER" +><I +>smbd</I +></TT +> or a process ID.</P +><P +>The <TT +CLASS="PARAMETER" +><I +>smbd</I +></TT +> destination causes the + message to "broadcast" to all smbd daemons.</P +><P +>The <TT +CLASS="PARAMETER" +><I +>nmbd</I +></TT +> destination causes the message to be sent to the nmbd daemon specified in the - <tt>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>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 - 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 <tt>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>nmbd</b> daemon to - force a new browse master election. </p></dd><dt><span class="term">ping</span></dt><dd><p> - 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.</p></dd><dt><span class="term">profile</span></dt><dd><p>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.</p></dd><dt><span class="term">debuglevel</span></dt><dd><p> - 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> - 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> - 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 - 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 - 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 - message for the printer and unix jobid - specified.</p></dd></dl></div><p> - 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>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>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>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> - 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 - 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 - to update their local version of the driver. Can only be - sent to smbd.</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">nmbd(8)</a> and <a href="smbd.8.html">smbd(8)</a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities + <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 +>message-type</DT +><DD +><P +>One of: <TT +CLASS="CONSTANT" +>close-share</TT +>, + <TT +CLASS="CONSTANT" +>debug</TT +>, + <TT +CLASS="CONSTANT" +>force-election</TT +>, <TT +CLASS="CONSTANT" +>ping + </TT +>, <TT +CLASS="CONSTANT" +>profile</TT +>, <TT +CLASS="CONSTANT" +> debuglevel</TT +>, <TT +CLASS="CONSTANT" +>profilelevel</TT +>, + or <TT +CLASS="CONSTANT" +>printnotify</TT +>.</P +><P +>The <TT +CLASS="CONSTANT" +>close-share</TT +> 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 + 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 <TT +CLASS="CONSTANT" +>smbd</TT +>.</P +><P +>The <TT +CLASS="CONSTANT" +>debug</TT +> message-type allows + the debug level to be set to the value specified by the + parameter. This can be sent to any of the destinations.</P +><P +>The <TT +CLASS="CONSTANT" +>force-election</TT +> message-type can only be + sent to the <TT +CLASS="CONSTANT" +>nmbd</TT +> destination. This message + causes the <B +CLASS="COMMAND" +>nmbd</B +> daemon to force a new browse + master election.</P +><P +>The <TT +CLASS="CONSTANT" +>ping</TT +> message-type sends the + number of "ping" messages specified by the parameter and waits + for the same number of reply "pong" messages. This can be sent to + any of the destinations.</P +><P +>The <TT +CLASS="CONSTANT" +>profile</TT +> message-type sends a + message to an smbd to change the profile settings 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.</P +><P +>The <TT +CLASS="CONSTANT" +>debuglevel</TT +> message-type sends + a "request debug level" message. The current debug level setting + is returned by a "debuglevel" message. This can be + sent to any of the destinations.</P +><P +>The <TT +CLASS="CONSTANT" +>profilelevel</TT +> message-type sends + a "request profile level" message. The current profile level + setting is returned by a "profilelevel" message. This can be sent + to any smbd or nmbd destinations.</P +><P +>The <TT +CLASS="CONSTANT" +>printnotify</TT +> message-type sends a + message to smbd which in turn sends a printer notify message to + any Windows NT clients connected to a printer. This message-type + takes the following arguments: + + <P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>queuepause printername</DT +><DD +><P +>Send a queue pause change notify + message to the printer specified.</P +></DD +><DT +>queueresume printername</DT +><DD +><P +>Send a queue resume change notify + message for the printer specified.</P +></DD +><DT +>jobpause printername unixjobid</DT +><DD +><P +>Send a job pause change notify + message for the printer and unix jobid + specified.</P +></DD +><DT +>jobresume printername unixjobid</DT +><DD +><P +>Send a job resume change notify + message for the printer and unix jobid + specified.</P +></DD +><DT +>jobdelete printername unixjobid</DT +><DD +><P +>Send a job delete change notify + message for the printer and unix jobid + specified.</P +></DD +></DL +></DIV +> + + 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 <TT +CLASS="CONSTANT" +>smbd</TT +>. + </P +></DD +><DT +>parameters</DT +><DD +><P +>any parameters required for the message-type</P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN102" +></A +><H2 +>VERSION</H2 +><P +>This man page is correct for version 2.2 of + the Samba suite.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN105" +></A +><H2 +>SEE ALSO</H2 +><P +><A +HREF="nmbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>nmbd(8)</B +></A +>, + and <A +HREF="smbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbd(8)</B +></A +>. + </P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN112" +></A +><H2 +>AUTHOR</H2 +><P +>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.</P +><P +>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 + <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 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 2.2 was done by Gerald Carter</P +></DIV +></BODY +></HTML +>
\ No newline at end of file |