merge from 2.2
[Samba/gbeck.git] / docs / htmldocs / smbcontrol.1.html
blob1f3b020c87b2b70c7bb742be4adb97aff7fcb0c4
1 <HTML
2 ><HEAD
3 ><TITLE
4 >smbcontrol</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
8 ><BODY
9 CLASS="REFENTRY"
10 BGCOLOR="#FFFFFF"
11 TEXT="#000000"
12 LINK="#0000FF"
13 VLINK="#840084"
14 ALINK="#0000FF"
15 ><H1
16 ><A
17 NAME="SMBCONTROL"
18 >smbcontrol</A
19 ></H1
20 ><DIV
21 CLASS="REFNAMEDIV"
22 ><A
23 NAME="AEN5"
24 ></A
25 ><H2
26 >Name</H2
27 >smbcontrol&nbsp;--&nbsp;send messages to smbd or nmbd processes</DIV
28 ><DIV
29 CLASS="REFSYNOPSISDIV"
30 ><A
31 NAME="AEN8"
32 ></A
33 ><H2
34 >Synopsis</H2
35 ><P
36 ><B
37 CLASS="COMMAND"
38 >smbcontrol</B
39 > [-i]</P
40 ><P
41 ><B
42 CLASS="COMMAND"
43 >smbcontrol</B
44 > [destination] [message-type] [parameter]</P
45 ></DIV
46 ><DIV
47 CLASS="REFSECT1"
48 ><A
49 NAME="AEN17"
50 ></A
51 ><H2
52 >DESCRIPTION</H2
53 ><P
54 >This tool is part of the <A
55 HREF="samba.7.html"
56 TARGET="_top"
57 > Samba</A
58 > suite.</P
59 ><P
60 ><B
61 CLASS="COMMAND"
62 >smbcontrol</B
63 > is a very small program, which
64 sends messages to an <A
65 HREF="smbd.8.html"
66 TARGET="_top"
67 >smbd(8)</A
68 > or
69 an <A
70 HREF="nmbd.8.html"
71 TARGET="_top"
72 >nmbd(8)</A
73 > daemon running on the
74 system.</P
75 ></DIV
76 ><DIV
77 CLASS="REFSECT1"
78 ><A
79 NAME="AEN25"
80 ></A
81 ><H2
82 >OPTIONS</H2
83 ><P
84 ></P
85 ><DIV
86 CLASS="VARIABLELIST"
87 ><DL
88 ><DT
89 >-i</DT
90 ><DD
91 ><P
92 >Run interactively. Individual commands
93 of the form destination message-type parameters can be entered
94 on STDIN. An empty command line or a "q" will quit the
95 program.</P
96 ></DD
97 ><DT
98 >destination</DT
99 ><DD
101 >One of <TT
102 CLASS="PARAMETER"
104 >nmbd</I
105 ></TT
108 CLASS="PARAMETER"
110 >smbd</I
111 ></TT
112 > or a process ID.</P
114 >The <TT
115 CLASS="PARAMETER"
117 >smbd</I
118 ></TT
119 > destination causes the
120 message to "broadcast" to all smbd daemons.</P
122 >The <TT
123 CLASS="PARAMETER"
125 >nmbd</I
126 ></TT
127 > destination causes the
128 message to be sent to the nmbd daemon specified in the
130 CLASS="FILENAME"
131 >nmbd.pid</TT
132 > file.</P
134 >If a single process ID is given, the message is sent
135 to only that process.</P
136 ></DD
137 ><DT
138 >message-type</DT
139 ><DD
141 >One of: <TT
142 CLASS="CONSTANT"
143 >debug</TT
146 CLASS="CONSTANT"
147 >force-election</TT
148 >, <TT
149 CLASS="CONSTANT"
150 >ping
151 </TT
152 >, <TT
153 CLASS="CONSTANT"
154 >profile</TT
155 >, <TT
156 CLASS="CONSTANT"
157 > debuglevel</TT
158 >, <TT
159 CLASS="CONSTANT"
160 >profilelevel</TT
162 or <TT
163 CLASS="CONSTANT"
164 >printer-notify</TT
165 >.</P
167 >The <TT
168 CLASS="CONSTANT"
169 >debug</TT
170 > message-type allows
171 the debug level to be set to the value specified by the
172 parameter. This can be sent to any of the destinations.</P
174 >The <TT
175 CLASS="CONSTANT"
176 >force-election</TT
177 > message-type can only be
178 sent to the <TT
179 CLASS="CONSTANT"
180 >nmbd</TT
181 > destination. This message
182 causes the <B
183 CLASS="COMMAND"
184 >nmbd</B
185 > daemon to force a new browse
186 master election.</P
188 >The <TT
189 CLASS="CONSTANT"
190 >ping</TT
191 > message-type sends the
192 number of "ping" messages specified by the parameter and waits
193 for the same number of reply "pong" messages. This can be sent to
194 any of the destinations.</P
196 >The <TT
197 CLASS="CONSTANT"
198 >profile</TT
199 > message-type sends a
200 message to an smbd to change the profile settings based on the
201 parameter. The parameter can be "on" to turn on profile stats
202 collection, "off" to turn off profile stats collection, "count"
203 to enable only collection of count stats (time stats are
204 disabled), and "flush" to zero the current profile stats. This can
205 be sent to any of the destinations.</P
207 >The <TT
208 CLASS="CONSTANT"
209 >debuglevel</TT
210 > message-type sends
211 a "request debug level" message. The current debug level setting
212 is returned by a "debuglevel" message. This can be
213 sent to any of the destinations.</P
215 >The <TT
216 CLASS="CONSTANT"
217 >profilelevel</TT
218 > message-type sends
219 a "request profile level" message. The current profile level
220 setting is returned by a "profilelevel" message. This can be sent
221 to any of the destinations.</P
223 >The <TT
224 CLASS="CONSTANT"
225 >printer-notify</TT
226 > message-type sends a
227 message to smbd which in turn sends a printer notify message to
228 any Windows NT clients connected to a printer. This message-type
229 takes an argument of the printer name to send notify messages to.
230 This message can only be sent to <TT
231 CLASS="CONSTANT"
232 >smbd</TT
233 >.</P
235 >The <TT
236 CLASS="CONSTANT"
237 >close-share</TT
238 > message-type sends a
239 message to smbd which forces smbd to close the share that was
240 specified as an argument. This may be useful if you made changes
241 to the access controls on the share. </P
242 ></DD
243 ><DT
244 >parameters</DT
245 ><DD
247 >any parameters required for the message-type</P
248 ></DD
249 ></DL
250 ></DIV
251 ></DIV
252 ><DIV
253 CLASS="REFSECT1"
255 NAME="AEN78"
256 ></A
257 ><H2
258 >VERSION</H2
260 >This man page is correct for version 2.2 of
261 the Samba suite.</P
262 ></DIV
263 ><DIV
264 CLASS="REFSECT1"
266 NAME="AEN81"
267 ></A
268 ><H2
269 >SEE ALSO</H2
272 HREF="nmbd.8.html"
273 TARGET="_top"
275 CLASS="COMMAND"
276 >nmbd(8)</B
277 ></A
279 and <A
280 HREF="smbd.8.html"
281 TARGET="_top"
283 CLASS="COMMAND"
284 >smbd(8)</B
285 ></A
288 ></DIV
289 ><DIV
290 CLASS="REFSECT1"
292 NAME="AEN88"
293 ></A
294 ><H2
295 >AUTHOR</H2
297 >The original Samba software and related utilities
298 were created by Andrew Tridgell. Samba is now developed
299 by the Samba Team as an Open Source project similar
300 to the way the Linux kernel is developed.</P
302 >The original Samba man pages were written by Karl Auer.
303 The man page sources were converted to YODL format (another
304 excellent piece of Open Source software, available at
306 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
307 TARGET="_top"
308 > ftp://ftp.icce.rug.nl/pub/unix/</A
309 >) and updated for the Samba 2.0
310 release by Jeremy Allison. The conversion to DocBook for
311 Samba 2.2 was done by Gerald Carter</P
312 ></DIV
313 ></BODY
314 ></HTML