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