updated the 3.0 branch from the head branch - ready for alpha18
[nivanova/samba-autobuild/.git] / docs / htmldocs / smbcontrol.1.html
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, nmbd or winbindd 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 >, 
69         an <A
70 HREF="nmbd.8.html"
71 TARGET="_top"
72 >nmbd(8)</A
73 >
74         or a <A
75 HREF="winbindd.8.html"
76 TARGET="_top"
77 >winbindd(8)</A
78
79         daemon running on the system.</P
80 ></DIV
81 ><DIV
82 CLASS="REFSECT1"
83 ><A
84 NAME="AEN26"
85 ></A
86 ><H2
87 >OPTIONS</H2
88 ><P
89 ></P
90 ><DIV
91 CLASS="VARIABLELIST"
92 ><DL
93 ><DT
94 >-i</DT
95 ><DD
96 ><P
97 >Run interactively. Individual commands 
98                 of the form destination message-type parameters can be entered 
99                 on STDIN. An empty command line or a "q" will quit the 
100                 program.</P
101 ></DD
102 ><DT
103 >destination</DT
104 ><DD
105 ><P
106 >One of <TT
107 CLASS="PARAMETER"
108 ><I
109 >nmbd</I
110 ></TT
111 >
112                 <TT
113 CLASS="PARAMETER"
114 ><I
115 >smbd</I
116 ></TT
117 > or a process ID.</P
118 ><P
119 >The <TT
120 CLASS="PARAMETER"
121 ><I
122 >smbd</I
123 ></TT
124 > destination causes the 
125                 message to "broadcast" to all smbd daemons.</P
126 ><P
127 >The <TT
128 CLASS="PARAMETER"
129 ><I
130 >nmbd</I
131 ></TT
132 > destination causes the 
133                 message to be sent to the nmbd daemon specified in the 
134                 <TT
135 CLASS="FILENAME"
136 >nmbd.pid</TT
137 > file.</P
138 ><P
139 >If a single process ID is given, the message is sent 
140                 to only that process.</P
141 ></DD
142 ><DT
143 >message-type</DT
144 ><DD
145 ><P
146 >One of: <TT
147 CLASS="CONSTANT"
148 >close-share</TT
149 >,
150                 <TT
151 CLASS="CONSTANT"
152 >debug</TT
153 >, 
154                 <TT
155 CLASS="CONSTANT"
156 >force-election</TT
157 >, <TT
158 CLASS="CONSTANT"
159 >ping
160                 </TT
161 >, <TT
162 CLASS="CONSTANT"
163 >profile</TT
164 >, <TT
165 CLASS="CONSTANT"
166 >               debuglevel</TT
167 >, <TT
168 CLASS="CONSTANT"
169 >profilelevel</TT
170 >, 
171                 or <TT
172 CLASS="CONSTANT"
173 >printer-notify</TT
174 >.</P
175 ><P
176 >The <TT
177 CLASS="CONSTANT"
178 >close-share</TT
179 > message-type sends a 
180                 message to smbd which will then close the client connections to
181                 the named share. Note that this doesn't affect client connections
182                 to any other shares. This message-type takes an argument of the
183                 share name for which client connections will be closed, or the
184                 "*" character which will close all currently open shares.
185                 This may be useful if you made changes to the access controls on the share.
186                 This message can only be sent to <TT
187 CLASS="CONSTANT"
188 >smbd</TT
189 >.</P
190 ><P
191 >The <TT
192 CLASS="CONSTANT"
193 >debug</TT
194 > message-type allows 
195                 the debug level to be set to the value specified by the 
196                 parameter. This can be sent to any of the destinations.</P
197 ><P
198 >The <TT
199 CLASS="CONSTANT"
200 >force-election</TT
201 > message-type can only be 
202                 sent to the <TT
203 CLASS="CONSTANT"
204 >nmbd</TT
205 > destination. This message 
206                 causes the <B
207 CLASS="COMMAND"
208 >nmbd</B
209 > daemon to force a new browse
210                 master election.</P
211 ><P
212 >The <TT
213 CLASS="CONSTANT"
214 >ping</TT
215 > message-type sends the 
216                 number of "ping" messages specified by the parameter and waits 
217                 for the same number of  reply "pong" messages. This can be sent to 
218                 any of the destinations.</P
219 ><P
220 >The <TT
221 CLASS="CONSTANT"
222 >profile</TT
223 > message-type sends a 
224                 message to an smbd to change the profile settings based on the 
225                 parameter. The parameter can be "on" to turn on profile stats 
226                 collection, "off" to turn off profile stats collection, "count"
227                 to enable only collection of count stats (time stats are 
228                 disabled), and "flush" to zero the current profile stats. This can 
229                 be sent to any smbd or nmbd destinations.</P
230 ><P
231 >The <TT
232 CLASS="CONSTANT"
233 >debuglevel</TT
234 > message-type sends 
235                 a "request debug level" message. The current debug level setting 
236                 is returned by a  "debuglevel" message. This can be 
237                 sent to any of the destinations.</P
238 ><P
239 >The <TT
240 CLASS="CONSTANT"
241 >profilelevel</TT
242 > message-type sends 
243                 a "request profile level" message.  The current profile level 
244                 setting is returned by a  "profilelevel" message. This can be sent 
245                 to any smbd or nmbd destinations.</P
246 ><P
247 >The <TT
248 CLASS="CONSTANT"
249 >printer-notify</TT
250 > message-type sends a 
251                 message to smbd which in turn sends a printer notify message to 
252                 any Windows NT clients connected to  a printer.  This message-type 
253                 takes an argument of the printer name to  send notify messages to.   
254                 This message can only be sent to <TT
255 CLASS="CONSTANT"
256 >smbd</TT
257 >.</P
258 ></DD
259 ><DT
260 >parameters</DT
261 ><DD
262 ><P
263 >any parameters required for the message-type</P
264 ></DD
265 ></DL
266 ></DIV
267 ></DIV
268 ><DIV
269 CLASS="REFSECT1"
270 ><A
271 NAME="AEN81"
272 ></A
273 ><H2
274 >VERSION</H2
275 ><P
276 >This man page is correct for version 2.2 of 
277         the Samba suite.</P
278 ></DIV
279 ><DIV
280 CLASS="REFSECT1"
281 ><A
282 NAME="AEN84"
283 ></A
284 ><H2
285 >SEE ALSO</H2
286 ><P
287 ><A
288 HREF="nmbd.8.html"
289 TARGET="_top"
290 ><B
291 CLASS="COMMAND"
292 >nmbd(8)</B
293 ></A
294 >, 
295         and <A
296 HREF="smbd.8.html"
297 TARGET="_top"
298 ><B
299 CLASS="COMMAND"
300 >smbd(8)</B
301 ></A
302 >.
303         </P
304 ></DIV
305 ><DIV
306 CLASS="REFSECT1"
307 ><A
308 NAME="AEN91"
309 ></A
310 ><H2
311 >AUTHOR</H2
312 ><P
313 >The original Samba software and related utilities 
314         were created by Andrew Tridgell. Samba is now developed
315         by the Samba Team as an Open Source project similar 
316         to the way the Linux kernel is developed.</P
317 ><P
318 >The original Samba man pages were written by Karl Auer. 
319         The man page sources were converted to YODL format (another 
320         excellent piece of Open Source software, available at
321         <A
322 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
323 TARGET="_top"
324 >       ftp://ftp.icce.rug.nl/pub/unix/</A
325 >) and updated for the Samba 2.0 
326         release by Jeremy Allison.  The conversion to DocBook for 
327         Samba 2.2 was done by Gerald Carter</P
328 ></DIV
329 ></BODY
330 ></HTML
331 >