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