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