source: branches/samba-3.0/docs/manpages/smbcontrol.1@ 135

Last change on this file since 135 was 135, checked in by Paul Smedley, 17 years ago

Update source to 3.0.30

File size: 6.5 KB
Line 
1.\" Title: smbcontrol
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4.\" Date: 05/28/2008
5.\" Manual: User Commands
6.\" Source: Samba 3.0
7.\"
8.TH "SMBCONTROL" "1" "05/28/2008" "Samba 3\.0" "User Commands"
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14smbcontrol - send messages to smbd, nmbd or winbindd processes
15.SH "SYNOPSIS"
16.HP 1
17smbcontrol [\-i] [\-s]
18.HP 1
19smbcontrol [destination] [message\-type] [parameter]
20.SH "DESCRIPTION"
21.PP
22This tool is part of the
23\fBsamba\fR(7)
24suite\.
25.PP
26smbcontrol
27is a very small program, which sends messages to a
28\fBsmbd\fR(8), a
29\fBnmbd\fR(8), or a
30\fBwinbindd\fR(8)
31daemon running on the system\.
32.SH "OPTIONS"
33.PP
34\-h|\-\-help
35.RS 4
36Print a summary of command line options\.
37.RE
38.PP
39\-s <configuration file>
40.RS 4
41The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See
42\fIsmb\.conf\fR
43for more information\. The default configuration file name is determined at compile time\.
44.RE
45.PP
46\-i
47.RS 4
48Run interactively\. Individual commands of the form destination message\-type parameters can be entered on STDIN\. An empty command line or a "q" will quit the program\.
49.RE
50.PP
51destination
52.RS 4
53One of
54\fInmbd\fR,
55\fIsmbd\fR
56or a process ID\.
57.sp
58The
59\fIsmbd\fR
60destination causes the message to "broadcast" to all smbd daemons\.
61.sp
62The
63\fInmbd\fR
64destination causes the message to be sent to the nmbd daemon specified in the
65\fInmbd\.pid\fR
66file\.
67.sp
68If a single process ID is given, the message is sent to only that process\.
69.RE
70.PP
71message\-type
72.RS 4
73Type of message to send\. See the section
74\fBMESSAGE\-TYPES\fR
75for details\.
76.RE
77.PP
78parameters
79.RS 4
80any parameters required for the message\-type
81.RE
82.SH "MESSAGE-TYPES"
83.PP
84Available message types are:
85.PP
86close\-share
87.RS 4
88Order smbd to close the client connections to the named share\. Note that this doesn\'t affect client connections to any other shares\. This message\-type takes an argument of the share name for which client connections will be closed, or the "*" character which will close all currently open shares\. This may be useful if you made changes to the access controls on the share\. This message can only be sent to
89\fBsmbd\fR\.
90.RE
91.PP
92debug
93.RS 4
94Set debug level to the value specified by the parameter\. This can be sent to any of the destinations\.
95.RE
96.PP
97force\-election
98.RS 4
99This message causes the
100nmbd
101daemon to force a new browse master election\.
102.RE
103.PP
104ping
105.RS 4
106Send specified number of "ping" messages and wait for the same number of reply "pong" messages\. This can be sent to any of the destinations\.
107.RE
108.PP
109profile
110.RS 4
111Change profile settings of a daemon, based on the parameter\. The parameter can be "on" to turn on profile stats collection, "off" to turn off profile stats collection, "count" to enable only collection of count stats (time stats are disabled), and "flush" to zero the current profile stats\. This can be sent to any smbd or nmbd destinations\.
112.RE
113.PP
114debuglevel
115.RS 4
116Request debuglevel of a certain daemon and write it to stdout\. This can be sent to any of the destinations\.
117.RE
118.PP
119profilelevel
120.RS 4
121Request profilelevel of a certain daemon and write it to stdout\. This can be sent to any smbd or nmbd destinations\.
122.RE
123.PP
124printnotify
125.RS 4
126Order smbd to send a printer notify message to any Windows NT clients connected to a printer\. This message\-type takes the following arguments:
127.PP
128queuepause printername
129.RS 4
130Send a queue pause change notify message to the printer specified\.
131.RE
132.PP
133queueresume printername
134.RS 4
135Send a queue resume change notify message for the printer specified\.
136.RE
137.PP
138jobpause printername unixjobid
139.RS 4
140Send a job pause change notify message for the printer and unix jobid specified\.
141.RE
142.PP
143jobresume printername unixjobid
144.RS 4
145Send a job resume change notify message for the printer and unix jobid specified\.
146.RE
147.PP
148jobdelete printername unixjobid
149.RS 4
150Send a job delete change notify message for the printer and unix jobid specified\.
151.RE
152.sp
153Note that this message only sends notification that an event has occured\. It doesn\'t actually cause the event to happen\.
154.sp
155This message can only be sent to
156\fBsmbd\fR\.
157.RE
158.PP
159samsync
160.RS 4
161Order smbd to synchronise sam database from PDC (being BDC)\. Can only be sent to
162\fBsmbd\fR\.
163.sp
164.it 1 an-trap
165.nr an-no-space-flag 1
166.nr an-break-flag 1
167.br
168Note
169Not working at the moment
170.RE
171.PP
172samrepl
173.RS 4
174Send sam replication message, with specified serial\. Can only be sent to
175\fBsmbd\fR\. Should not be used manually\.
176.RE
177.PP
178dmalloc\-mark
179.RS 4
180Set a mark for dmalloc\. Can be sent to both smbd and nmbd\. Only available if samba is built with dmalloc support\.
181.RE
182.PP
183dmalloc\-log\-changed
184.RS 4
185Dump the pointers that have changed since the mark set by dmalloc\-mark\. Can be sent to both smbd and nmbd\. Only available if samba is built with dmalloc support\.
186.RE
187.PP
188shutdown
189.RS 4
190Shut down specified daemon\. Can be sent to both smbd and nmbd\.
191.RE
192.PP
193pool\-usage
194.RS 4
195Print a human\-readable description of all talloc(pool) memory usage by the specified daemon/process\. Available for both smbd and nmbd\.
196.RE
197.PP
198drvupgrade
199.RS 4
200Force clients of printers using specified driver to update their local version of the driver\. Can only be sent to smbd\.
201.RE
202.PP
203reload\-config
204.RS 4
205Force daemon to reload smb\.conf configuration file\. Can be sent to
206\fBsmbd\fR,
207\fBnmbd\fR, or
208\fBwinbindd\fR\.
209.RE
210.SH "VERSION"
211.PP
212This man page is correct for version 3\.0 of the Samba suite\.
213.SH "SEE ALSO"
214.PP
215\fBnmbd\fR(8)
216and
217\fBsmbd\fR(8)\.
218.SH "AUTHOR"
219.PP
220The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\.
221.PP
222The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at
223ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\.
Note: See TracBrowser for help on using the repository browser.