docs/docbook/manpages/smbcontrol.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="findsmb">
   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>debug</constant>,
  74                 <constant>force-election</constant>, <constant>ping
  75                 </constant>, <constant>profile</constant>, <constant>
  76                 debuglevel</constant>, <constant>profilelevel</constant>,
  77                 or <constant>printer-notify</constant>.</para>
  78
  79                 <para>The <constant>debug</constant> message-type allows
  80                 the debug level to be set to the value specified by the
  81                 parameter. This can be sent to any of the destinations.</para>
  82
  83                 <para>The <constant>force-election</constant> message-type can only be
  84                 sent to the <constant>nmbd</constant> destination. This message
  85                 causes the <command>nmbd</command> daemon to force a new browse
  86                 master election.</para>
  87
  88                 <para>The <constant>ping</constant> message-type sends the
  89                 number of "ping" messages specified by the parameter and waits
  90                 for the same number of  reply "pong" messages. This can be sent to
  91                 any of the destinations.</para>
  92
  93                 <para>The <constant>profile</constant> message-type sends a
  94                 message to an smbd to change the profile settings based on the
  95                 parameter. The parameter can be "on" to turn on profile stats
  96                 collection, "off" to turn off profile stats collection, "count"
  97                 to enable only collection of count stats (time stats are
  98                 disabled), and "flush" to zero the current profile stats. This can
  99                 be sent to any of the destinations.</para>
 100
 101                 <para>The <constant>debuglevel</constant> message-type sends
 102                 a "request debug level" message. The current debug level setting
 103                 is returned by a  "debuglevel" message. This can be
 104                 sent to any of the destinations.</para>
 105
 106                 <para>The <constant>profilelevel</constant> message-type sends
 107                 a "request profile level" message.  The current profile level
 108                 setting is returned by a  "profilelevel" message. This can be sent
 109                 to any of the destinations.</para>
 110
 111                 <para>The <constant>printer-notify</constant> message-type sends a
 112                 message to smbd which in turn sends a printer notify message to
 113                 any Windows NT clients connected to  a printer.  This message-type
 114                 takes an argument of the printer name to  send notify messages to.
 115                 This message can only be sent to <constant>smbd</constant>.</para>
 116                 </listitem>
 117                 </varlistentry>
 118
 119
 120                 <varlistentry>
 121                 <term>parameters</term>
 122                 <listitem><para>any parameters required for the message-type</para>
 123                 </listitem>
 124                 </varlistentry>
 125         </variablelist>
 126
 127 </refsect1>
 128
 129 <refsect1>
 130         <title>VERSION</title>
 131
 132         <para>This man page is correct for version 2.2 of
 133         the Samba suite.</para>
 134 </refsect1>
 135
 136 <refsect1>
 137         <title>SEE ALSO</title>
 138         <para><ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
 139         and <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>.
 140         </para>
 141 </refsect1>
 142
 143 <refsect1>
 144         <title>AUTHOR</title>
 145
 146         <para>The original Samba software and related utilities
 147         were created by Andrew Tridgell. Samba is now developed
 148         by the Samba Team as an Open Source project similar
 149         to the way the Linux kernel is developed.</para>
 150
 151         <para>The original Samba man pages were written by Karl Auer.
 152         The man page sources were converted to YODL format (another
 153         excellent piece of Open Source software, available at
 154         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 155         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 156         release by Jeremy Allison.  The conversion to DocBook for
 157         Samba 2.2 was done by Gerald Carter</para>
 158 </refsect1>
 159
 160 </refentry>