docs/manpages/smbcontrol.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "SMBCONTROL" "1" "17 April 2003" "" ""
   7
   8 .SH NAME
   9 smbcontrol \- send messages to smbd, nmbd or winbindd processes
  10 .SH SYNOPSIS
  11
  12 \fBsmbcontrol\fR [ \fB-i\fR ] [ \fB-s\fR ]
  13
  14
  15 \fBsmbcontrol\fR [ \fBdestination\fR ] [ \fBmessage-type\fR ] [ \fBparameter\fR ]
  16
  17 .SH "DESCRIPTION"
  18 .PP
  19 This tool is part of the \fBSamba\fR(7) suite.
  20 .PP
  21 \fBsmbcontrol\fR is a very small program, which
  22 sends messages to a \fBsmbd\fR(8), a \fBnmbd\fR(8), or a \fBwinbindd\fR(8) daemon running on the system.
  23 .SH "OPTIONS"
  24 .TP
  25 \fB-h|--help\fR
  26 Print a summary of command line options.
  27 .TP
  28 \fB-s <configuration file>\fR
  29 The file specified contains the
  30 configuration details required by the server.  The
  31 information in this file includes server-specific
  32 information such as what printcap file to use, as well
  33 as descriptions of all the services that the server is
  34 to provide. See \fIsmb.conf(5)\fR for more information.
  35 The default configuration file name is determined at
  36 compile time.
  37 .TP
  38 \fB-i\fR
  39 Run interactively. Individual commands
  40 of the form destination message-type parameters can be entered
  41 on STDIN. An empty command line or a "q" will quit the
  42 program.
  43 .TP
  44 \fBdestination\fR
  45 One of \fInmbd\fR, \fIsmbd\fR or a process ID.
  46
  47 The \fIsmbd\fR destination causes the
  48 message to "broadcast" to all smbd daemons.
  49
  50 The \fInmbd\fR destination causes the
  51 message to be sent to the nmbd daemon specified in the
  52 \fInmbd.pid\fR file.
  53
  54 If a single process ID is given, the message is sent
  55 to only that process.
  56 .TP
  57 \fBmessage-type\fR
  58 Type of message to send. See
  59 the section MESSAGE-TYPES for details.
  60 .TP
  61 \fBparameters\fR
  62 any parameters required for the message-type
  63 .SH "MESSAGE-TYPES"
  64 .PP
  65 Available message types are:
  66 .TP
  67 \fBclose-share\fR
  68 Order smbd to close the client
  69 connections to the named share. Note that this doesn't affect client
  70 connections to any other shares. This message-type takes an argument of the
  71 share name for which client connections will be closed, or the
  72 "*" character which will close all currently open shares.
  73 This may be useful if you made changes to the access controls on the share.
  74 This message can only be sent to smbd.
  75 .TP
  76 \fBdebug\fR
  77 Set debug level to the value specified by the
  78 parameter. This can be sent to any of the destinations.
  79 .TP
  80 \fBforce-election\fR
  81 This message causes the \fBnmbd\fR daemon to
  82 force a new browse master election.
  83 .TP
  84 \fBping\fR
  85 Send specified number of "ping" messages and
  86 wait for the same number of  reply "pong" messages. This can be sent to
  87 any of the destinations.
  88 .TP
  89 \fBprofile\fR
  90 Change profile settings of a daemon, based on the
  91 parameter. The parameter can be "on" to turn on profile stats
  92 collection, "off" to turn off profile stats collection, "count"
  93 to enable only collection of count stats (time stats are
  94 disabled), and "flush" to zero the current profile stats. This can
  95 be sent to any smbd or nmbd destinations.
  96 .TP
  97 \fBdebuglevel\fR
  98 Request debuglevel of a certain daemon and write it to stdout. This
  99 can be sent to any of the destinations.
 100 .TP
 101 \fBprofilelevel\fR
 102 Request profilelevel of a certain daemon and write it to stdout.
 103 This can be sent to any smbd or nmbd destinations.
 104 .TP
 105 \fBprintnotify\fR
 106 Order smbd to send a printer notify message to any Windows NT clients
 107 connected to a printer. This message-type takes the following arguments:
 108 .RS
 109 .TP
 110 \fBqueuepause printername\fR
 111 Send a queue pause change notify
 112 message to the printer specified.
 113 .TP
 114 \fBqueueresume printername\fR
 115 Send a queue resume change notify
 116 message for the printer specified.
 117 .TP
 118 \fBjobpause printername unixjobid\fR
 119 Send a job pause change notify
 120 message for the printer and unix jobid
 121 specified.
 122 .TP
 123 \fBjobresume printername unixjobid\fR
 124 Send a job resume change notify
 125 message for the printer and unix jobid
 126 specified.
 127 .TP
 128 \fBjobdelete printername unixjobid\fR
 129 Send a job delete change notify
 130 message for the printer and unix jobid
 131 specified.
 132 .RE
 133
 134 Note that this message only sends notification that an
 135 event has occured.  It doesn't actually cause the
 136 event to happen.
 137
 138 This message can only be sent to smbd.
 139 .TP
 140 \fBsamsync\fR
 141 Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to smbd.
 142 .sp
 143 .RS
 144 .B "Note:"
 145 Not working at the moment
 146 .RE
 147 .TP
 148 \fBsamrepl\fR
 149 Send sam replication message, with specified serial. Can only be sent to smbd. Should not be used manually.
 150 .TP
 151 \fBdmalloc-mark\fR
 152 Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.
 153 .TP
 154 \fBdmalloc-log-changed\fR
 155 Dump the pointers that have changed since the mark set by dmalloc-mark.
 156 Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.
 157 .TP
 158 \fBshutdown\fR
 159 Shut down specified daemon. Can be sent to both smbd and nmbd.
 160 .TP
 161 \fBpool-usage\fR
 162 Print a human-readable description of all
 163 talloc(pool) memory usage by the specified daemon/process. Available
 164 for both smbd and nmbd.
 165 .TP
 166 \fBdrvupgrade\fR
 167 Force clients of printers using specified driver
 168 to update their local version of the driver. Can only be
 169 sent to smbd.
 170 .SH "VERSION"
 171 .PP
 172 This man page is correct for version 3.0 of
 173 the Samba suite.
 174 .SH "SEE ALSO"
 175 .PP
 176 \fBnmbd\fR(8) and \fBsmbd\fR(8).
 177 .SH "AUTHOR"
 178 .PP
 179 The original Samba software and related utilities
 180 were created by Andrew Tridgell. Samba is now developed
 181 by the Samba Team as an Open Source project similar
 182 to the way the Linux kernel is developed.
 183 .PP
 184 The original Samba man pages were written by Karl Auer.
 185 The man page sources were converted to YODL format (another
 186 excellent piece of Open Source software, available at  ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 187 release by Jeremy Allison.  The conversion to DocBook for
 188 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 189 Samba 3.0 was done by Alexander Bokovoy.