summaryrefslogtreecommitdiff
path: root/docs/manpages/smbcontrol.1
blob: 2dbe1212cfe161cc888a4a0de391cc5ba4658981 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
.TH SMBCONTROL 1 "23 Nov 2000" "smbcontrol 2.2.0-alpha1"
.PP 
.SH "NAME" 
smbcontrol \- send messages to smbd or nmbd processes
.PP 
.SH "SYNOPSIS" 
.PP 
\fBsmbcontrol\fP -i
.PP 
\fBsmbcontrol\fP destination message-type parameters
.PP 
.SH "DESCRIPTION" 
.PP 
This program is part of the \fBSamba\fP suite\&.
.PP 
\fBsmbcontrol\fP is a very small program, which sends messages to an 
\fBsmbd\fP or an \fBnmbd\fP daemon 
running on the system\&.
.PP 
.SH "OPTIONS" 
.PP 
.IP 
.IP "\fB-i\fP" 
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\&.
.IP 
.IP "\fBdestination\fP" 
is one of "nmbd", "smbd" or a process ID\&.
.IP 
The \fBsmbd\fP destination causes the message to be "broadcast" to all
smbd daemons\&.
.IP 
The \fBnmbd\fP destination causes the message to be sent to the nmbd
daemon specified in the \fBnmbd\&.pid\fP file\&.
.IP 
If a single process ID is given, the message is sent to only that
process\&.
.IP 
.IP "\fBmessage-type\fP" 
is one of: debug, force-election, ping, profile,
debuglevel, profilelevel, or printer-notify\&.
.IP 
The \fBdebug\fP message-type allows the debug level to be set to the value
specified by the parameter\&. This can be sent to any of the destinations\&.
.IP 
The \fBforce-election\fP message-type can only be sent to the \fBnmbd\fP
destination\&. This message causes the \fBnmbd\fP daemon to force a
new browse master election\&.
.IP 
The \fBping\fP message-type sends the number of "ping" messages specified 
by the parameter and waits for the same number of 
reply "pong" messages\&. This can be sent to any of the destinations\&.
.IP 
The \fBprofile\fP message-type sends a message to an smbd to change the profile
settings 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 of the destinations\&.
.IP 
The \fBdebuglevel\fP message-type sends a "request debug level" message\&.
The current debug level setting is returned by a 
"debuglevel" message\&. This can be sent to any of the destinations\&.
.IP 
The \fBprofilelevel\fP message-type sends a "request profile level" message\&.
The current profile level setting is returned by a 
"profilelevel" message\&. This can be sent to any of the destinations\&.
.IP 
The \fBprinter-notify\fP message-type sends a message to smbd which in turn 
sends a printer notify message to any Windows NT clients connected to 
a printer\&.  This message-type takes an argument of the printer name to 
send notify messages to\&.   This message can only be sent to smbd\&.
.IP 
.IP "\fBparameters\fP" 
is any parameters required for the message-type
.IP 
.PP 
.SH "VERSION" 
.PP 
This man page is correct for version 2\&.2\&.0 of the Samba suite\&.
.PP 
.SH "SEE ALSO" 
.PP 
\fBsmbd (8)\fP, \fBnmbd (8)\fP
.PP 
.SH "AUTHOR" 
.PP 
The original Samba software and related utilities were created by
Andrew Tridgell \fIsamba@samba\&.org\fP\&. Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed\&.
.PP 
This man page source was written in YODL format (another excellent piece of Open
Source software, available at
\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
for the Samba 2\&.2\&.0 release by Herb Lewis\&.
\fIsamba@samba\&.org\fP\&.
.PP 
See \fBsamba (7)\fP to find out how to get a full
list of contributors and details on how to submit bug reports,
comments etc\&.