docs/manpages/smbcontrol.1

   1 .\" This manpage has been automatically generated by docbook2man-spec
   2 .\" from a DocBook document.  docbook2man-spec can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "SMBCONTROL" "1" "08 May 2002" "" ""
   7 .SH NAME
   8 smbcontrol \- send messages to smbd, nmbd or winbindd processes
   9 .SH SYNOPSIS
  10 .sp
  11 \fBsmbcontrol\fR [ \fB-i\fR ]
  12 .sp
  13 \fBsmbcontrol\fR [ \fBdestination\fR ]  [ \fBmessage-type\fR ]  [ \fBparameter\fR ]
  14 .SH "DESCRIPTION"
  15 .PP
  16 This tool is part of the  Sambasuite.
  17 .PP
  18 \fBsmbcontrol\fR is a very small program, which
  19 sends messages to an smbd(8),
  20 an nmbd(8)
  21 or a winbindd(8)
  22 daemon running on the system.
  23 .SH "OPTIONS"
  24 .TP
  25 \fB-i\fR
  26 Run interactively. Individual commands
  27 of the form destination message-type parameters can be entered
  28 on STDIN. An empty command line or a "q" will quit the
  29 program.
  30 .TP
  31 \fBdestination\fR
  32 One of \fInmbd\fR
  33 \fIsmbd\fR or a process ID.
  34
  35 The \fIsmbd\fR destination causes the
  36 message to "broadcast" to all smbd daemons.
  37
  38 The \fInmbd\fR destination causes the
  39 message to be sent to the nmbd daemon specified in the
  40 \fInmbd.pid\fR file.
  41
  42 If a single process ID is given, the message is sent
  43 to only that process.
  44 .TP
  45 \fBmessage-type\fR
  46 One of: close-share,
  47 debug,
  48 force-election, ping
  49 , profile,  debuglevel, profilelevel,
  50 or printer-notify.
  51
  52 The close-share message-type sends a
  53 message to smbd which will then close the client connections to
  54 the named share. Note that this doesn't affect client connections
  55 to any other shares. This message-type takes an argument of the
  56 share name for which client connections will be closed, or the
  57 "*" character which will close all currently open shares.
  58 This may be useful if you made changes to the access controls on the share.
  59 This message can only be sent to smbd.
  60
  61 The debug message-type allows
  62 the debug level to be set to the value specified by the
  63 parameter. This can be sent to any of the destinations.
  64
  65 The force-election message-type can only be
  66 sent to the nmbd destination. This message
  67 causes the \fBnmbd\fR daemon to force a new browse
  68 master election.
  69
  70 The ping message-type sends the
  71 number of "ping" messages specified by the parameter and waits
  72 for the same number of reply "pong" messages. This can be sent to
  73 any of the destinations.
  74
  75 The profile message-type sends a
  76 message to an smbd to change the profile settings based on the
  77 parameter. The parameter can be "on" to turn on profile stats
  78 collection, "off" to turn off profile stats collection, "count"
  79 to enable only collection of count stats (time stats are
  80 disabled), and "flush" to zero the current profile stats. This can
  81 be sent to any smbd or nmbd destinations.
  82
  83 The debuglevel message-type sends
  84 a "request debug level" message. The current debug level setting
  85 is returned by a "debuglevel" message. This can be
  86 sent to any of the destinations.
  87
  88 The profilelevel message-type sends
  89 a "request profile level" message. The current profile level
  90 setting is returned by a "profilelevel" message. This can be sent
  91 to any smbd or nmbd destinations.
  92
  93 The printer-notify message-type sends a
  94 message to smbd which in turn sends a printer notify message to
  95 any Windows NT clients connected to a printer. This message-type
  96 takes an argument of the printer name to send notify messages to.
  97 This message can only be sent to smbd.
  98 .TP
  99 \fBparameters\fR
 100 any parameters required for the message-type
 101 .SH "VERSION"
 102 .PP
 103 This man page is correct for version 2.2 of
 104 the Samba suite.
 105 .SH "SEE ALSO"
 106 .PP
 107 \fBnmbd(8)\fR,
 108 and \fBsmbd(8)\fR.
 109 .SH "AUTHOR"
 110 .PP
 111 The original Samba software and related utilities
 112 were created by Andrew Tridgell. Samba is now developed
 113 by the Samba Team as an Open Source project similar
 114 to the way the Linux kernel is developed.
 115 .PP
 116 The original Samba man pages were written by Karl Auer.
 117 The man page sources were converted to YODL format (another
 118 excellent piece of Open Source software, available at
 119 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 120 release by Jeremy Allison. The conversion to DocBook for
 121 Samba 2.2 was done by Gerald Carter