syncing up with SAMBA_2_2
[samba.git] / 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" "01 June 2001" "" ""
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: debug, 
46 force-election, ping
47 , profile,  debuglevel, profilelevel, 
48 or printer-notify.
49
50 The debug message-type allows 
51 the debug level to be set to the value specified by the 
52 parameter. This can be sent to any of the destinations.
53
54 The force-election message-type can only be 
55 sent to the nmbd destination. This message 
56 causes the \fBnmbd\fR daemon to force a new browse
57 master election.
58
59 The ping message-type sends the 
60 number of "ping" messages specified by the parameter and waits 
61 for the same number of reply "pong" messages. This can be sent to 
62 any of the destinations.
63
64 The profile message-type sends a 
65 message to an smbd to change the profile settings based on the 
66 parameter. The parameter can be "on" to turn on profile stats 
67 collection, "off" to turn off profile stats collection, "count"
68 to enable only collection of count stats (time stats are 
69 disabled), and "flush" to zero the current profile stats. This can 
70 be sent to any of the destinations.
71
72 The debuglevel message-type sends 
73 a "request debug level" message. The current debug level setting 
74 is returned by a "debuglevel" message. This can be 
75 sent to any of the destinations.
76
77 The profilelevel message-type sends 
78 a "request profile level" message. The current profile level 
79 setting is returned by a "profilelevel" message. This can be sent 
80 to any of the destinations.
81
82 The printer-notify message-type sends a 
83 message to smbd which in turn sends a printer notify message to 
84 any Windows NT clients connected to a printer. This message-type 
85 takes an argument of the printer name to send notify messages to. 
86 This message can only be sent to smbd.
87 .TP
88 \fBparameters\fR
89 any parameters required for the message-type
90 .SH "VERSION"
91 .PP
92 This man page is correct for version 2.2 of 
93 the Samba suite.
94 .SH "SEE ALSO"
95 .PP
96 \fBnmbd(8)\fR, 
97 and \fBsmbd(8)\fR.
98 .SH "AUTHOR"
99 .PP
100 The original Samba software and related utilities 
101 were created by Andrew Tridgell. Samba is now developed
102 by the Samba Team as an Open Source project similar 
103 to the way the Linux kernel is developed.
104 .PP
105 The original Samba man pages were written by Karl Auer. 
106 The man page sources were converted to YODL format (another 
107 excellent piece of Open Source software, available at
108 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
109 release by Jeremy Allison. The conversion to DocBook for 
110 Samba 2.2 was done by Gerald Carter