docs/manpages-3/smbcontrol.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="smbcontrol.1">
   4
   5 <refmeta>
   6         <refentrytitle>smbcontrol</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>smbcontrol</refname>
  13         <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>smbcontrol</command>
  19                 <arg>-i</arg>
  20                 <arg>-s</arg>
  21         </cmdsynopsis>
  22
  23         <cmdsynopsis>
  24                 <command>smbcontrol</command>
  25                 <arg>destination</arg>
  26                 <arg>message-type</arg>
  27                 <arg>parameter</arg>
  28         </cmdsynopsis>
  29 </refsynopsisdiv>
  30
  31 <refsect1>
  32         <title>DESCRIPTION</title>
  33
  34         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  35         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  36
  37         <para><command>smbcontrol</command> is a very small program, which
  38         sends messages to a <citerefentry><refentrytitle>smbd</refentrytitle>
  39         <manvolnum>8</manvolnum></citerefentry>, a <citerefentry><refentrytitle>nmbd</refentrytitle>
  40         <manvolnum>8</manvolnum></citerefentry>, or a <citerefentry><refentrytitle>winbindd</refentrytitle>
  41         <manvolnum>8</manvolnum></citerefentry> daemon running on the system.</para>
  42 </refsect1>
  43
  44
  45 <refsect1>
  46         <title>OPTIONS</title>
  47
  48         <variablelist>
  49                 &stdarg.help;
  50                 &stdarg.configfile;
  51                 <varlistentry>
  52                 <term>-i</term>
  53                 <listitem><para>Run interactively. Individual commands
  54                 of the form destination message-type parameters can be entered
  55                 on STDIN. An empty command line or a "q" will quit the
  56                 program.</para></listitem>
  57                 </varlistentry>
  58
  59                 <varlistentry>
  60                 <term>destination</term>
  61                 <listitem><para>One of <parameter>nmbd</parameter>, <parameter>smbd</parameter> or a process ID.</para>
  62
  63                 <para>The <parameter>smbd</parameter> destination causes the
  64                 message to "broadcast" to all smbd daemons.</para>
  65
  66                 <para>The <parameter>nmbd</parameter> destination causes the
  67                 message to be sent to the nmbd daemon specified in the
  68                 <filename>nmbd.pid</filename> file.</para>
  69
  70                 <para>If a single process ID is given, the message is sent
  71                 to only that process.</para></listitem>
  72                 </varlistentry>
  73
  74
  75                 <varlistentry>
  76                 <term>message-type</term>
  77                 <listitem><para>Type of message to send. See
  78                 the section <constant>MESSAGE-TYPES</constant> for details.
  79                 </para></listitem></varlistentry>
  80
  81
  82
  83                 <varlistentry>
  84                 <term>parameters</term>
  85                 <listitem><para>any parameters required for the message-type</para>
  86                 </listitem>
  87                 </varlistentry>
  88         </variablelist>
  89
  90 </refsect1>
  91
  92 <refsect1>
  93         <title>MESSAGE-TYPES</title>
  94
  95         <para>Available message types are:</para>
  96
  97         <variablelist>
  98         <varlistentry><term>close-share</term>
  99         <listitem><para>Order smbd to close the client
 100         connections to the named share. Note that this doesn't affect client
 101         connections to any other shares. This message-type takes an argument of the
 102         share name for which client connections will be closed, or the
 103         "*" character which will close all currently open shares.
 104         This may be useful if you made changes to the access controls on the share.
 105         This message can only be sent to <constant>smbd</constant>.</para>
 106         </listitem>
 107         </varlistentry>
 108
 109         <varlistentry>
 110         <term>debug</term>
 111         <listitem><para>Set debug level to the value specified by the
 112         parameter. This can be sent to any of the destinations.</para>
 113         </listitem>
 114         </varlistentry>
 115
 116         <varlistentry>
 117         <term>force-election</term>
 118         <listitem><para>This message causes the <command>nmbd</command> daemon to
 119         force a new browse master election. </para>
 120         </listitem></varlistentry>
 121
 122         <varlistentry>
 123         <term>ping</term>
 124         <listitem><para>
 125         Send specified number of "ping" messages and
 126         wait for the same number of  reply "pong" messages. This can be sent to
 127         any of the destinations.</para>
 128         </listitem>
 129         </varlistentry>
 130
 131         <varlistentry>
 132         <term>profile</term>
 133         <listitem><para>Change profile settings of a daemon, based on the
 134         parameter. The parameter can be "on" to turn on profile stats
 135         collection, "off" to turn off profile stats collection, "count"
 136         to enable only collection of count stats (time stats are
 137         disabled), and "flush" to zero the current profile stats. This can
 138         be sent to any smbd or nmbd destinations.</para>
 139         </listitem></varlistentry>
 140
 141         <varlistentry>
 142         <term>debuglevel</term>
 143         <listitem><para>
 144         Request debuglevel of a certain daemon and write it to stdout. This
 145         can be sent to any of the destinations.</para>
 146         </listitem>
 147         </varlistentry>
 148
 149         <varlistentry>
 150         <term>profilelevel</term>
 151         <listitem><para>
 152         Request profilelevel of a certain daemon and write it to stdout.
 153         This can be sent to any smbd or nmbd destinations.</para>
 154         </listitem>
 155         </varlistentry>
 156
 157         <varlistentry>
 158         <term>printnotify</term>
 159         <listitem><para>
 160         Order smbd to send a printer notify message to any Windows NT clients
 161         connected to a printer. This message-type takes the following arguments:
 162         </para>
 163
 164         <variablelist>
 165
 166             <varlistentry>
 167             <term>queuepause printername</term>
 168             <listitem><para>Send a queue pause change notify
 169             message to the printer specified.</para></listitem>
 170             </varlistentry>
 171
 172             <varlistentry>
 173             <term>queueresume printername</term>
 174             <listitem><para>Send a queue resume change notify
 175             message for the printer specified.</para></listitem>
 176             </varlistentry>
 177
 178                 <varlistentry>
 179             <term>jobpause printername unixjobid</term>
 180             <listitem><para>Send a job pause change notify
 181             message for the printer and unix jobid
 182             specified.</para></listitem>
 183             </varlistentry>
 184
 185             <varlistentry>
 186             <term>jobresume printername unixjobid</term>
 187             <listitem><para>Send a job resume change notify
 188             message for the printer and unix jobid
 189             specified.</para></listitem>
 190             </varlistentry>
 191
 192             <varlistentry>
 193             <term>jobdelete printername unixjobid</term>
 194             <listitem><para>Send a job delete change notify
 195             message for the printer and unix jobid
 196             specified.</para></listitem>
 197             </varlistentry>
 198         </variablelist>
 199
 200         <para>
 201         Note that this message only sends notification that an
 202         event has occured.  It doesn't actually cause the
 203         event to happen.
 204         </para>
 205
 206         <para>This message can only be sent to <constant>smbd</constant>. </para>
 207         </listitem>
 208         </varlistentry>
 209
 210         <varlistentry>
 211         <term>samsync</term>
 212         <listitem><para>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <constant>smbd</constant>. </para>
 213         <note><para>Not working at the moment</para></note>
 214         </listitem>
 215         </varlistentry>
 216
 217         <varlistentry>
 218         <term>samrepl</term>
 219         <listitem><para>Send sam replication message, with specified serial. Can only be sent to <constant>smbd</constant>. Should not be used manually.</para></listitem>
 220         </varlistentry>
 221
 222         <varlistentry>
 223         <term>dmalloc-mark</term>
 224         <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>
 225         </varlistentry>
 226
 227         <varlistentry>
 228         <term>dmalloc-log-changed</term>
 229         <listitem><para>
 230         Dump the pointers that have changed since the mark set by dmalloc-mark.
 231         Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
 232         </varlistentry>
 233
 234         <varlistentry>
 235         <term>shutdown</term>
 236         <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
 237         </varlistentry>
 238
 239         <varlistentry>
 240         <term>pool-usage</term>
 241         <listitem><para>Print a human-readable description of all
 242         talloc(pool) memory usage by the specified daemon/process. Available
 243         for both smbd and nmbd.</para></listitem>
 244         </varlistentry>
 245
 246         <varlistentry>
 247         <term>drvupgrade</term>
 248         <listitem><para>Force clients of printers using specified driver
 249         to update their local version of the driver. Can only be
 250         sent to smbd.</para></listitem>
 251         </varlistentry>
 252
 253         <varlistentry>
 254         <term>reload-config</term>
 255         <listitem><para>Force daemon to reload smb.conf configuration file. Can be sent
 256         to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>.
 257         </para></listitem>
 258         </varlistentry>
 259
 260 </variablelist>
 261 </refsect1>
 262
 263 <refsect1>
 264         <title>VERSION</title>
 265
 266         <para>This man page is correct for version 3.0 of
 267         the Samba suite.</para>
 268 </refsect1>
 269
 270 <refsect1>
 271         <title>SEE ALSO</title>
 272         <para><citerefentry><refentrytitle>nmbd</refentrytitle>
 273         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
 274         <manvolnum>8</manvolnum></citerefentry>.</para>
 275 </refsect1>
 276
 277 <refsect1>
 278         <title>AUTHOR</title>
 279
 280         <para>The original Samba software and related utilities
 281         were created by Andrew Tridgell. Samba is now developed
 282         by the Samba Team as an Open Source project similar
 283         to the way the Linux kernel is developed.</para>
 284
 285         <para>The original Samba man pages were written by Karl Auer.
 286         The man page sources were converted to YODL format (another
 287         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 288         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 289         release by Jeremy Allison.  The conversion to DocBook for
 290         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 291         Samba 3.0 was done by Alexander Bokovoy.</para>
 292 </refsect1>
 293
 294 </refentry>