docs/manpages/smbcontrol.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "SMBCONTROL" 1 "" "" ""
  21 .SH NAME
  22 smbcontrol \- send messages to smbd, nmbd or winbindd processes
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBsmbcontrol\fR [-i] [-s]
  27 .fi
  28
  29 .nf
  30 \fBsmbcontrol\fR [destination] [message-type] [parameter]
  31 .fi
  32
  33 .SH "DESCRIPTION"
  34
  35 .PP
  36 This tool is part of the \fBSamba\fR(7) suite\&.
  37
  38 .PP
  39 \fBsmbcontrol\fR is a very small program, which sends messages to a \fBsmbd\fR(8), a \fBnmbd\fR(8), or a \fBwinbindd\fR(8) daemon running on the system\&.
  40
  41 .SH "OPTIONS"
  42
  43 .TP
  44 -h|--help
  45 Print a summary of command line options\&.
  46
  47
  48 .TP
  49 -s <configuration file>
  50 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 \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
  51
  52
  53 .TP
  54 -i
  55 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\&.
  56
  57
  58 .TP
  59 destination
  60 One of \fInmbd\fR, \fIsmbd\fR or a process ID\&.
  61
  62
  63 The \fIsmbd\fR destination causes the message to "broadcast" to all smbd daemons\&.
  64
  65
  66 The \fInmbd\fR destination causes the message to be sent to the nmbd daemon specified in the \fInmbd\&.pid\fR file\&.
  67
  68
  69 If a single process ID is given, the message is sent to only that process\&.
  70
  71
  72 .TP
  73 message-type
  74 Type of message to send\&. See the section \fBMESSAGE-TYPES\fR for details\&.
  75
  76
  77 .TP
  78 parameters
  79 any parameters required for the message-type
  80
  81
  82 .SH "MESSAGE-TYPES"
  83
  84 .PP
  85 Available message types are:
  86
  87 .TP
  88 close-share
  89 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 \fBsmbd\fR\&.
  90
  91
  92 .TP
  93 debug
  94 Set debug level to the value specified by the parameter\&. This can be sent to any of the destinations\&.
  95
  96
  97 .TP
  98 force-election
  99 This message causes the \fBnmbd\fR daemon to force a new browse master election\&.
 100
 101
 102 .TP
 103 ping
 104 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\&.
 105
 106
 107 .TP
 108 profile
 109 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\&.
 110
 111
 112 .TP
 113 debuglevel
 114 Request debuglevel of a certain daemon and write it to stdout\&. This can be sent to any of the destinations\&.
 115
 116
 117 .TP
 118 profilelevel
 119 Request profilelevel of a certain daemon and write it to stdout\&. This can be sent to any smbd or nmbd destinations\&.
 120
 121
 122 .TP
 123 printnotify
 124 Order smbd to send a printer notify message to any Windows NT clients connected to a printer\&. This message-type takes the following arguments:
 125
 126
 127
 128 .RS
 129
 130 .TP
 131 queuepause printername
 132 Send a queue pause change notify message to the printer specified\&.
 133
 134
 135 .TP
 136 queueresume printername
 137 Send a queue resume change notify message for the printer specified\&.
 138
 139
 140 .TP
 141 jobpause printername unixjobid
 142 Send a job pause change notify message for the printer and unix jobid specified\&.
 143
 144
 145 .TP
 146 jobresume printername unixjobid
 147 Send a job resume change notify message for the printer and unix jobid specified\&.
 148
 149
 150 .TP
 151 jobdelete printername unixjobid
 152 Send a job delete change notify message for the printer and unix jobid specified\&.
 153
 154
 155 .RE
 156 Note that this message only sends notification that an event has occured\&. It doesn't actually cause the event to happen\&.
 157
 158
 159 This message can only be sent to \fBsmbd\fR\&.
 160
 161
 162 .TP
 163 samsync
 164 Order smbd to synchronise sam database from PDC (being BDC)\&. Can only be sent to \fBsmbd\fR\&.
 165
 166 Not working at the moment
 167
 168
 169 .TP
 170 samrepl
 171 Send sam replication message, with specified serial\&. Can only be sent to \fBsmbd\fR\&. Should not be used manually\&.
 172
 173
 174 .TP
 175 dmalloc-mark
 176 Set a mark for dmalloc\&. Can be sent to both smbd and nmbd\&. Only available if samba is built with dmalloc support\&.
 177
 178
 179 .TP
 180 dmalloc-log-changed
 181 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\&.
 182
 183
 184 .TP
 185 shutdown
 186 Shut down specified daemon\&. Can be sent to both smbd and nmbd\&.
 187
 188
 189 .TP
 190 pool-usage
 191 Print a human-readable description of all talloc(pool) memory usage by the specified daemon/process\&. Available for both smbd and nmbd\&.
 192
 193
 194 .TP
 195 drvupgrade
 196 Force clients of printers using specified driver to update their local version of the driver\&. Can only be sent to smbd\&.
 197
 198
 199 .SH "VERSION"
 200
 201 .PP
 202 This man page is correct for version 3\&.0 of the Samba suite\&.
 203
 204 .SH "SEE ALSO"
 205
 206 .PP
 207 \fBnmbd\fR(8) and \fBsmbd\fR(8)\&.
 208
 209 .SH "AUTHOR"
 210
 211 .PP
 212 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\&.
 213
 214 .PP
 215 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 ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) 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\&.
 216