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