~ubuntu-branches/ubuntu/lucid/samba/lucid-proposed

« back to all changes in this revision

Viewing changes to .pc/fix-manpages-warnings.patch/docs/manpages/smbcontrol.1

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2009-12-28 05:02:32 UTC
  • mfrom: (0.34.3 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091228050232-jdd4xy3otxp71kdt
Tags: 2:3.4.3-2ubuntu1
* Merge from debian testing.  Remaining changes:
  + debian/patches/VERSION.patch:
    - set SAMBA_VERSION_SUFFIX to Ubuntu.
  + debian/smb.conf:
    - Add "(Samba, Ubuntu)" to server string.
    - Comment out the default [homes] share, and add a comment about "valid users = %s" 
      to show users how to restrict access to \\server\username to only username.
    - Set 'usershare allow guests', so that usershare admins are allowed to create
      public shares in additon to authenticated ones.
    - add map to guest = Bad user, maps bad username to gues access.
  + debian/samba-common.conf:
    - Do not change priority to high if dhclient3 is installed.
    - Use priority medium instead of high for the workgroup question.
  + debian/mksambapasswd.awk:
    - Do not add user with UID less than 1000 to smbpasswd.
  + debian/control:
    - Make libswbclient0 replace/conflickt with hardy's likewise-open.
    - Don't build against ctdb.
    - Build-depend on libreadline-dev instead of libreadline5-dev.
  + debian/rules:
    - Enable "native" PIE hardening.
    - Add BIND_NOW to maximize benefit of RELRO hardening.
  + Add ufw integration:
    - Created debian/samba.ufw.profile.
    - debian/rules, debian/samba.dirs, debian/samba.files: install

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"     Title: smbcontrol
 
2
.\"    Author: [see the "AUTHOR" section]
 
3
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
 
4
.\"      Date: 10/29/2009
 
5
.\"    Manual: User Commands
 
6
.\"    Source: Samba 3.4
 
7
.\"  Language: English
 
8
.\"
 
9
.TH "SMBCONTROL" "1" "10/29/2009" "Samba 3\&.4" "User Commands"
 
10
.\" -----------------------------------------------------------------
 
11
.\" * (re)Define some macros
 
12
.\" -----------------------------------------------------------------
 
13
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
14
.\" toupper - uppercase a string (locale-aware)
 
15
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
16
.de toupper
 
17
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
 
18
\\$*
 
19
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
 
20
..
 
21
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
22
.\" SH-xref - format a cross-reference to an SH section
 
23
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
24
.de SH-xref
 
25
.ie n \{\
 
26
.\}
 
27
.toupper \\$*
 
28
.el \{\
 
29
\\$*
 
30
.\}
 
31
..
 
32
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
33
.\" SH - level-one heading that works better for non-TTY output
 
34
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
35
.de1 SH
 
36
.\" put an extra blank line of space above the head in non-TTY output
 
37
.if t \{\
 
38
.sp 1
 
39
.\}
 
40
.sp \\n[PD]u
 
41
.nr an-level 1
 
42
.set-an-margin
 
43
.nr an-prevailing-indent \\n[IN]
 
44
.fi
 
45
.in \\n[an-margin]u
 
46
.ti 0
 
47
.HTML-TAG ".NH \\n[an-level]"
 
48
.it 1 an-trap
 
49
.nr an-no-space-flag 1
 
50
.nr an-break-flag 1
 
51
\." make the size of the head bigger
 
52
.ps +3
 
53
.ft B
 
54
.ne (2v + 1u)
 
55
.ie n \{\
 
56
.\" if n (TTY output), use uppercase
 
57
.toupper \\$*
 
58
.\}
 
59
.el \{\
 
60
.nr an-break-flag 0
 
61
.\" if not n (not TTY), use normal case (not uppercase)
 
62
\\$1
 
63
.in \\n[an-margin]u
 
64
.ti 0
 
65
.\" if not n (not TTY), put a border/line under subheading
 
66
.sp -.6
 
67
\l'\n(.lu'
 
68
.\}
 
69
..
 
70
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
71
.\" SS - level-two heading that works better for non-TTY output
 
72
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
73
.de1 SS
 
74
.sp \\n[PD]u
 
75
.nr an-level 1
 
76
.set-an-margin
 
77
.nr an-prevailing-indent \\n[IN]
 
78
.fi
 
79
.in \\n[IN]u
 
80
.ti \\n[SN]u
 
81
.it 1 an-trap
 
82
.nr an-no-space-flag 1
 
83
.nr an-break-flag 1
 
84
.ps \\n[PS-SS]u
 
85
\." make the size of the head bigger
 
86
.ps +2
 
87
.ft B
 
88
.ne (2v + 1u)
 
89
.if \\n[.$] \&\\$*
 
90
..
 
91
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
92
.\" BB/BE - put background/screen (filled box) around block of text
 
93
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
94
.de BB
 
95
.if t \{\
 
96
.sp -.5
 
97
.br
 
98
.in +2n
 
99
.ll -2n
 
100
.gcolor red
 
101
.di BX
 
102
.\}
 
103
..
 
104
.de EB
 
105
.if t \{\
 
106
.if "\\$2"adjust-for-leading-newline" \{\
 
107
.sp -1
 
108
.\}
 
109
.br
 
110
.di
 
111
.in
 
112
.ll
 
113
.gcolor
 
114
.nr BW \\n(.lu-\\n(.i
 
115
.nr BH \\n(dn+.5v
 
116
.ne \\n(BHu+.5v
 
117
.ie "\\$2"adjust-for-leading-newline" \{\
 
118
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 
119
.\}
 
120
.el \{\
 
121
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 
122
.\}
 
123
.in 0
 
124
.sp -.5v
 
125
.nf
 
126
.BX
 
127
.in
 
128
.sp .5v
 
129
.fi
 
130
.\}
 
131
..
 
132
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
133
.\" BM/EM - put colored marker in margin next to block of text
 
134
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
135
.de BM
 
136
.if t \{\
 
137
.br
 
138
.ll -2n
 
139
.gcolor red
 
140
.di BX
 
141
.\}
 
142
..
 
143
.de EM
 
144
.if t \{\
 
145
.br
 
146
.di
 
147
.ll
 
148
.gcolor
 
149
.nr BH \\n(dn
 
150
.ne \\n(BHu
 
151
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 
152
.in 0
 
153
.nf
 
154
.BX
 
155
.in
 
156
.fi
 
157
.\}
 
158
..
 
159
.\" -----------------------------------------------------------------
 
160
.\" * set default formatting
 
161
.\" -----------------------------------------------------------------
 
162
.\" disable hyphenation
 
163
.nh
 
164
.\" disable justification (adjust text to left margin only)
 
165
.ad l
 
166
.\" -----------------------------------------------------------------
 
167
.\" * MAIN CONTENT STARTS HERE *
 
168
.\" -----------------------------------------------------------------
 
169
.SH "Name"
 
170
smbcontrol \- send messages to smbd, nmbd or winbindd processes
 
171
.SH "Synopsis"
 
172
.fam C
 
173
.HP \w'\ 'u
 
174
\FCsmbcontrol\F[] [\-i] [\-s]
 
175
.fam
 
176
.fam C
 
177
.HP \w'\ 'u
 
178
\FCsmbcontrol\F[] [destination] [message\-type] [parameter]
 
179
.fam
 
180
.SH "DESCRIPTION"
 
181
.PP
 
182
This tool is part of the
 
183
\fBsamba\fR(7)
 
184
suite\&.
 
185
.PP
 
186
\FCsmbcontrol\F[]
 
187
is a very small program, which sends messages to a
 
188
\fBsmbd\fR(8), a
 
189
\fBnmbd\fR(8), or a
 
190
\fBwinbindd\fR(8)
 
191
daemon running on the system\&.
 
192
.SH "OPTIONS"
 
193
.PP
 
194
\-h|\-\-help
 
195
.RS 4
 
196
Print a summary of command line options\&.
 
197
.RE
 
198
.PP
 
199
\-s <configuration file>
 
200
.RS 4
 
201
The 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
 
202
\FCsmb\&.conf\F[]
 
203
for more information\&. The default configuration file name is determined at compile time\&.
 
204
.RE
 
205
.PP
 
206
\-i
 
207
.RS 4
 
208
Run 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\&.
 
209
.RE
 
210
.PP
 
211
destination
 
212
.RS 4
 
213
One of
 
214
\fInmbd\fR,
 
215
\fIsmbd\fR
 
216
or a process ID\&.
 
217
.sp
 
218
The
 
219
\fIall\fR
 
220
destination causes the message to "broadcast" to all running daemons including nmbd and winbind\&. This is a change for Samba 3\&.3, prior to this the parameter smbd used to do this\&.
 
221
.sp
 
222
The
 
223
\fIsmbd\fR
 
224
destination causes the message to be sent to the smbd daemon specified in the
 
225
\FCsmbd\&.pid\F[]
 
226
file\&.
 
227
.sp
 
228
The
 
229
\fInmbd\fR
 
230
destination causes the message to be sent to the nmbd daemon specified in the
 
231
\FCnmbd\&.pid\F[]
 
232
file\&.
 
233
.sp
 
234
The
 
235
\fIwinbindd\fR
 
236
destination causes the message to be sent to the winbind daemon specified in the
 
237
\FCwinbindd\&.pid\F[]
 
238
file\&.
 
239
.sp
 
240
If a single process ID is given, the message is sent to only that process\&.
 
241
.RE
 
242
.PP
 
243
message\-type
 
244
.RS 4
 
245
Type of message to send\&. See the section
 
246
\fBMESSAGE\-TYPES\fR
 
247
for details\&.
 
248
.RE
 
249
.PP
 
250
parameters
 
251
.RS 4
 
252
any parameters required for the message\-type
 
253
.RE
 
254
.SH "MESSAGE-TYPES"
 
255
.PP
 
256
Available message types are:
 
257
.PP
 
258
close\-share
 
259
.RS 4
 
260
Order 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
 
261
\fBsmbd\fR\&.
 
262
.RE
 
263
.PP
 
264
debug
 
265
.RS 4
 
266
Set debug level to the value specified by the parameter\&. This can be sent to any of the destinations\&.
 
267
.RE
 
268
.PP
 
269
force\-election
 
270
.RS 4
 
271
This message causes the
 
272
\FCnmbd\F[]
 
273
daemon to force a new browse master election\&.
 
274
.RE
 
275
.PP
 
276
ping
 
277
.RS 4
 
278
Send specified number of "ping" messages and wait for the same number of reply "pong" messages\&. This can be sent to any of the destinations\&.
 
279
.RE
 
280
.PP
 
281
profile
 
282
.RS 4
 
283
Change 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\&.
 
284
.RE
 
285
.PP
 
286
debuglevel
 
287
.RS 4
 
288
Request debuglevel of a certain daemon and write it to stdout\&. This can be sent to any of the destinations\&.
 
289
.RE
 
290
.PP
 
291
profilelevel
 
292
.RS 4
 
293
Request profilelevel of a certain daemon and write it to stdout\&. This can be sent to any smbd or nmbd destinations\&.
 
294
.RE
 
295
.PP
 
296
printnotify
 
297
.RS 4
 
298
Order smbd to send a printer notify message to any Windows NT clients connected to a printer\&. This message\-type takes the following arguments:
 
299
.PP
 
300
queuepause printername
 
301
.RS 4
 
302
Send a queue pause change notify message to the printer specified\&.
 
303
.RE
 
304
.PP
 
305
queueresume printername
 
306
.RS 4
 
307
Send a queue resume change notify message for the printer specified\&.
 
308
.RE
 
309
.PP
 
310
jobpause printername unixjobid
 
311
.RS 4
 
312
Send a job pause change notify message for the printer and unix jobid specified\&.
 
313
.RE
 
314
.PP
 
315
jobresume printername unixjobid
 
316
.RS 4
 
317
Send a job resume change notify message for the printer and unix jobid specified\&.
 
318
.RE
 
319
.PP
 
320
jobdelete printername unixjobid
 
321
.RS 4
 
322
Send a job delete change notify message for the printer and unix jobid specified\&.
 
323
.RE
 
324
.sp
 
325
Note that this message only sends notification that an event has occured\&. It doesn\'t actually cause the event to happen\&.
 
326
.sp
 
327
This message can only be sent to
 
328
\fBsmbd\fR\&.
 
329
.RE
 
330
.PP
 
331
samsync
 
332
.RS 4
 
333
Order smbd to synchronise sam database from PDC (being BDC)\&. Can only be sent to
 
334
\fBsmbd\fR\&.
 
335
.if n \{\
 
336
.sp
 
337
.\}
 
338
.RS 4
 
339
.BM yellow
 
340
.it 1 an-trap
 
341
.nr an-no-space-flag 1
 
342
.nr an-break-flag 1
 
343
.br
 
344
.ps +1
 
345
\fBNote\fR
 
346
.ps -1
 
347
.br
 
348
Not working at the moment
 
349
.sp .5v
 
350
.EM yellow
 
351
.RE
 
352
.RE
 
353
.PP
 
354
samrepl
 
355
.RS 4
 
356
Send sam replication message, with specified serial\&. Can only be sent to
 
357
\fBsmbd\fR\&. Should not be used manually\&.
 
358
.RE
 
359
.PP
 
360
dmalloc\-mark
 
361
.RS 4
 
362
Set a mark for dmalloc\&. Can be sent to both smbd and nmbd\&. Only available if samba is built with dmalloc support\&.
 
363
.RE
 
364
.PP
 
365
dmalloc\-log\-changed
 
366
.RS 4
 
367
Dump 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\&.
 
368
.RE
 
369
.PP
 
370
shutdown
 
371
.RS 4
 
372
Shut down specified daemon\&. Can be sent to both smbd and nmbd\&.
 
373
.RE
 
374
.PP
 
375
pool\-usage
 
376
.RS 4
 
377
Print a human\-readable description of all talloc(pool) memory usage by the specified daemon/process\&. Available for both smbd and nmbd\&.
 
378
.RE
 
379
.PP
 
380
drvupgrade
 
381
.RS 4
 
382
Force clients of printers using specified driver to update their local version of the driver\&. Can only be sent to smbd\&.
 
383
.RE
 
384
.PP
 
385
reload\-config
 
386
.RS 4
 
387
Force daemon to reload smb\&.conf configuration file\&. Can be sent to
 
388
\fBsmbd\fR,
 
389
\fBnmbd\fR, or
 
390
\fBwinbindd\fR\&.
 
391
.RE
 
392
.SH "VERSION"
 
393
.PP
 
394
This man page is correct for version 3 of the Samba suite\&.
 
395
.SH "SEE ALSO"
 
396
.PP
 
397
\fBnmbd\fR(8)
 
398
and
 
399
\fBsmbd\fR(8)\&.
 
400
.SH "AUTHOR"
 
401
.PP
 
402
The 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\&.
 
403
.PP
 
404
The 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
 
405
ftp://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\&.