docs/docbook/manpages/smbcontrol.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="smbcontrol">
   3
   4 <refmeta>
   5         <refentrytitle>smbcontrol</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>smbcontrol</refname>
  12         <refpurpose>send messages to smbd or nmbd processes</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>smbcontrol</command>
  18                 <arg>-i</arg>
  19         </cmdsynopsis>
  20
  21         <cmdsynopsis>
  22                 <command>smbcontrol</command>
  23                 <arg>destination</arg>
  24                 <arg>message-type</arg>
  25                 <arg>parameter</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>This tool is part of the <ulink url="samba.7.html">
  33         Samba</ulink> suite.</para>
  34
  35         <para><command>smbcontrol</command> is a very small program, which
  36         sends messages to an <ulink url="smbd.8.html">smbd(8)</ulink> or
  37         an <ulink url="nmbd.8.html">nmbd(8)</ulink> daemon running on the
  38         system.</para>
  39 </refsect1>
  40
  41
  42 <refsect1>
  43         <title>OPTIONS</title>
  44
  45         <variablelist>
  46                 <varlistentry>
  47                 <term>-i</term>
  48                 <listitem><para>Run interactively. Individual commands
  49                 of the form destination message-type parameters can be entered
  50                 on STDIN. An empty command line or a "q" will quit the
  51                 program.</para></listitem>
  52                 </varlistentry>
  53
  54                 <varlistentry>
  55                 <term>destination</term>
  56                 <listitem><para>One of <parameter>nmbd</parameter>
  57                 <parameter>smbd</parameter> or a process ID.</para>
  58
  59                 <para>The <parameter>smbd</parameter> destination causes the
  60                 message to "broadcast" to all smbd daemons.</para>
  61
  62                 <para>The <parameter>nmbd</parameter> destination causes the
  63                 message to be sent to the nmbd daemon specified in the
  64                 <filename>nmbd.pid</filename> file.</para>
  65
  66                 <para>If a single process ID is given, the message is sent
  67                 to only that process.</para></listitem>
  68                 </varlistentry>
  69
  70
  71                 <varlistentry>
  72                 <term>message-type</term>
  73                 <listitem><para>One of: <constant>close-share</constant>,
  74                 <constant>debug</constant>,
  75                 <constant>force-election</constant>, <constant>ping
  76                 </constant>, <constant>profile</constant>, <constant>
  77                 debuglevel</constant>, <constant>profilelevel</constant>,
  78                 or <constant>printer-notify</constant>.</para>
  79
  80                 <para>The <constant>close-share</constant> message-type sends a
  81                 message to smbd which will then close the client connections to
  82                 the named share. Note that this doesn't affect client connections
  83                 to any other shares. This message-type takes an argument of the
  84                 share name for which client connections will be close, or the
  85                 "*" character which will close all currently open shares.
  86                 This message can only be sent to <constant>smbd</constant>.</para>
  87
  88                 <para>The <constant>debug</constant> message-type allows
  89                 the debug level to be set to the value specified by the
  90                 parameter. This can be sent to any of the destinations.</para>
  91
  92                 <para>The <constant>force-election</constant> message-type can only be
  93                 sent to the <constant>nmbd</constant> destination. This message
  94                 causes the <command>nmbd</command> daemon to force a new browse
  95                 master election.</para>
  96
  97                 <para>The <constant>ping</constant> message-type sends the
  98                 number of "ping" messages specified by the parameter and waits
  99                 for the same number of  reply "pong" messages. This can be sent to
 100                 any of the destinations.</para>
 101
 102                 <para>The <constant>profile</constant> message-type sends a
 103                 message to an smbd to change the profile settings based on the
 104                 parameter. The parameter can be "on" to turn on profile stats
 105                 collection, "off" to turn off profile stats collection, "count"
 106                 to enable only collection of count stats (time stats are
 107                 disabled), and "flush" to zero the current profile stats. This can
 108                 be sent to any of the destinations.</para>
 109
 110                 <para>The <constant>debuglevel</constant> message-type sends
 111                 a "request debug level" message. The current debug level setting
 112                 is returned by a  "debuglevel" message. This can be
 113                 sent to any of the destinations.</para>
 114
 115                 <para>The <constant>profilelevel</constant> message-type sends
 116                 a "request profile level" message.  The current profile level
 117                 setting is returned by a  "profilelevel" message. This can be sent
 118                 to any of the destinations.</para>
 119
 120                 <para>The <constant>printer-notify</constant> message-type sends a
 121                 message to smbd which in turn sends a printer notify message to
 122                 any Windows NT clients connected to  a printer.  This message-type
 123                 takes an argument of the printer name to  send notify messages to.
 124                 This message can only be sent to <constant>smbd</constant>.</para>
 125
 126                 <para>The <constant>close-share</constant> message-type sends a
 127                 message to smbd which forces smbd to close the share that was
 128                 specified as an argument. This may be useful if you made changes
 129                 to the access controls on the share.  </para>
 130                 </listitem>
 131                 </varlistentry>
 132
 133
 134                 <varlistentry>
 135                 <term>parameters</term>
 136                 <listitem><para>any parameters required for the message-type</para>
 137                 </listitem>
 138                 </varlistentry>
 139         </variablelist>
 140
 141 </refsect1>
 142
 143 <refsect1>
 144         <title>VERSION</title>
 145
 146         <para>This man page is correct for version 2.2 of
 147         the Samba suite.</para>
 148 </refsect1>
 149
 150 <refsect1>
 151         <title>SEE ALSO</title>
 152         <para><ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
 153         and <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>.
 154         </para>
 155 </refsect1>
 156
 157 <refsect1>
 158         <title>AUTHOR</title>
 159
 160         <para>The original Samba software and related utilities
 161         were created by Andrew Tridgell. Samba is now developed
 162         by the Samba Team as an Open Source project similar
 163         to the way the Linux kernel is developed.</para>
 164
 165         <para>The original Samba man pages were written by Karl Auer.
 166         The man page sources were converted to YODL format (another
 167         excellent piece of Open Source software, available at
 168         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 169         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 170         release by Jeremy Allison.  The conversion to DocBook for
 171         Samba 2.2 was done by Gerald Carter</para>
 172 </refsect1>
 173
 174 </refentry>