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" "04 March 2003" "" ""
   7 .SH NAME
   8 smbcontrol \- send messages to smbd, nmbd or winbindd processes
   9 .SH SYNOPSIS
  10
  11 \fBsmbcontrol\fR [ \fB-i\fR ]
  12
  13
  14 \fBsmbcontrol\fR [ \fBdestination\fR ] [ \fBmessage-type\fR ] [ \fBparameter\fR ]
  15
  16 .SH "DESCRIPTION"
  17 .PP
  18 This tool is part of the  Samba suite.
  19 .PP
  20 \fBsmbcontrol\fR is a very small program, which
  21 sends messages to an smbd(8)
  22 an nmbd(8)
  23 or a winbindd(8)
  24 daemon running on the system.
  25 .SH "OPTIONS"
  26 .TP
  27 \fB-i\fR
  28 Run interactively. Individual commands
  29 of the form destination message-type parameters can be entered
  30 on STDIN. An empty command line or a "q" will quit the
  31 program.
  32 .TP
  33 \fBdestination\fR
  34 One of \fInmbd\fR
  35 \fIsmbd\fR or a process ID.
  36
  37 The \fIsmbd\fR destination causes the
  38 message to "broadcast" to all smbd daemons.
  39
  40 The \fInmbd\fR destination causes the
  41 message to be sent to the nmbd daemon specified in the
  42 \fInmbd.pid\fR file.
  43
  44 If a single process ID is given, the message is sent
  45 to only that process.
  46 .TP
  47 \fBmessage-type\fR
  48 One of: close-share,
  49 debug,
  50 force-election, ping
  51 , profile,   debuglevel, profilelevel,
  52 or printnotify.
  53
  54 The close-share message-type sends a
  55 message to smbd which will then close the client connections to
  56 the named share. Note that this doesn't affect client connections
  57 to any other shares. This message-type takes an argument of the
  58 share name for which client connections will be closed, or the
  59 "*" character which will close all currently open shares.
  60 This may be useful if you made changes to the access controls on the share.
  61 This message can only be sent to smbd.
  62
  63 The debug message-type allows
  64 the debug level to be set to the value specified by the
  65 parameter. This can be sent to any of the destinations.
  66
  67 The force-election message-type can only be
  68 sent to the nmbd destination. This message
  69 causes the \fBnmbd\fR daemon to force a new browse
  70 master election.
  71
  72 The ping message-type sends the
  73 number of "ping" messages specified by the parameter and waits
  74 for the same number of  reply "pong" messages. This can be sent to
  75 any of the destinations.
  76
  77 The profile message-type sends a
  78 message to an smbd to change the profile settings based on the
  79 parameter. The parameter can be "on" to turn on profile stats
  80 collection, "off" to turn off profile stats collection, "count"
  81 to enable only collection of count stats (time stats are
  82 disabled), and "flush" to zero the current profile stats. This can
  83 be sent to any smbd or nmbd destinations.
  84
  85 The debuglevel message-type sends
  86 a "request debug level" message. The current debug level setting
  87 is returned by a  "debuglevel" message. This can be
  88 sent to any of the destinations.
  89
  90 The profilelevel message-type sends
  91 a "request profile level" message.  The current profile level
  92 setting is returned by a  "profilelevel" message. This can be sent
  93 to any smbd or nmbd destinations.
  94
  95 The printnotify message-type sends a
  96 message to smbd which in turn sends a printer notify message to
  97 any Windows NT clients connected to a printer. This message-type
  98 takes the following arguments:
  99 .RS
 100 .TP
 101 \fBqueuepause printername\fR
 102 Send a queue pause change notify
 103 message to the printer specified.
 104 .TP
 105 \fBqueueresume printername\fR
 106 Send a queue resume change notify
 107 message for the printer specified.
 108 .TP
 109 \fBjobpause printername unixjobid\fR
 110 Send a job pause change notify
 111 message for the printer and unix jobid
 112 specified.
 113 .TP
 114 \fBjobresume printername unixjobid\fR
 115 Send a job resume change notify
 116 message for the printer and unix jobid
 117 specified.
 118 .TP
 119 \fBjobdelete printername unixjobid\fR
 120 Send a job delete change notify
 121 message for the printer and unix jobid
 122 specified.
 123 .RE
 124 Note that this message only sends notification that an
 125 event has occured.  It doesn't actually cause the
 126 event to happen.
 127 This message can only be sent to smbd.
 128 .TP
 129 \fBparameters\fR
 130 any parameters required for the message-type
 131 .SH "VERSION"
 132 .PP
 133 This man page is correct for version 2.2 of
 134 the Samba suite.
 135 .SH "SEE ALSO"
 136 .PP
 137 \fBnmbd(8)\fR
 138 and \fBsmbd(8)\fR
 139 .SH "AUTHOR"
 140 .PP
 141 The original Samba software and related utilities
 142 were created by Andrew Tridgell. Samba is now developed
 143 by the Samba Team as an Open Source project similar
 144 to the way the Linux kernel is developed.
 145 .PP
 146 The original Samba man pages were written by Karl Auer.
 147 The man page sources were converted to YODL format (another
 148 excellent piece of Open Source software, available at
 149 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 150 release by Jeremy Allison.  The conversion to DocBook for
 151 Samba 2.2 was done by Gerald Carter