~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs/manpages/swat.8

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"     Title: swat
 
2
.\"    Author: [see the "AUTHOR" section]
 
3
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
 
4
.\"      Date: 05/10/2010
 
5
.\"    Manual: System Administration tools
 
6
.\"    Source: Samba 3.4
 
7
.\"  Language: English
 
8
.\"
 
9
.TH "SWAT" "8" "05/10/2010" "Samba 3\&.4" "System Administration tools"
 
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
swat \- Samba Web Administration Tool
 
171
.SH "Synopsis"
 
172
.fam C
 
173
.HP \w'\ 'u
 
174
\FCswat\F[] [\-s\ <smb\ config\ file>] [\-a] [\-P]
 
175
.fam
 
176
.SH "DESCRIPTION"
 
177
.PP
 
178
This tool is part of the
 
179
\fBsamba\fR(7)
 
180
suite\&.
 
181
.PP
 
182
\FCswat\F[]
 
183
allows a Samba administrator to configure the complex
 
184
\fBsmb.conf\fR(5)
 
185
file via a Web browser\&. In addition, a
 
186
\FCswat\F[]
 
187
configuration page has help links to all the configurable options in the
 
188
\FCsmb\&.conf\F[]
 
189
file allowing an administrator to easily look up the effects of any change\&.
 
190
.PP
 
191
\FCswat\F[]
 
192
is run from
 
193
\FCinetd\F[]
 
194
.SH "OPTIONS"
 
195
.PP
 
196
\-s smb configuration file
 
197
.RS 4
 
198
The default configuration file path is determined at compile time\&. The file specified contains the configuration details required by the
 
199
\fBsmbd\fR(8)
 
200
server\&. This is the file that
 
201
\FCswat\F[]
 
202
will modify\&. 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
 
203
\FCsmb\&.conf\F[]
 
204
for more information\&.
 
205
.RE
 
206
.PP
 
207
\-a
 
208
.RS 4
 
209
This option disables authentication and places
 
210
\FCswat\F[]
 
211
in demo mode\&. In that mode anyone will be able to modify the
 
212
\FCsmb\&.conf\F[]
 
213
file\&.
 
214
.sp
 
215
\fIWARNING: Do NOT enable this option on a production server\&. \fR
 
216
.RE
 
217
.PP
 
218
\-P
 
219
.RS 4
 
220
This option restricts read\-only users to the password management page\&.
 
221
\FCswat\F[]
 
222
can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\&.
 
223
.RE
 
224
.PP
 
225
\-d|\-\-debuglevel=level
 
226
.RS 4
 
227
\fIlevel\fR
 
228
is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
 
229
.sp
 
230
The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
 
231
.sp
 
232
Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
 
233
.sp
 
234
Note that specifying this parameter here will override the
 
235
\m[blue]\fB\%smb.conf.5.html#\fR\m[]
 
236
parameter in the
 
237
\FCsmb\&.conf\F[]
 
238
file\&.
 
239
.RE
 
240
.PP
 
241
\-V|\-\-version
 
242
.RS 4
 
243
Prints the program version number\&.
 
244
.RE
 
245
.PP
 
246
\-s|\-\-configfile <configuration file>
 
247
.RS 4
 
248
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
 
249
\FCsmb\&.conf\F[]
 
250
for more information\&. The default configuration file name is determined at compile time\&.
 
251
.RE
 
252
.PP
 
253
\-l|\-\-log\-basename=logdirectory
 
254
.RS 4
 
255
Base directory name for log/debug files\&. The extension
 
256
\fB"\&.progname"\fR
 
257
will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
 
258
.RE
 
259
.PP
 
260
\-h|\-\-help
 
261
.RS 4
 
262
Print a summary of command line options\&.
 
263
.RE
 
264
.SH "INSTALLATION"
 
265
.PP
 
266
Swat is included as binary package with most distributions\&. The package manager in this case takes care of the installation and configuration\&. This section is only for those who have compiled swat from scratch\&.
 
267
.PP
 
268
After you compile SWAT you need to run
 
269
\FCmake install \F[]
 
270
to install the
 
271
\FCswat\F[]
 
272
binary and the various help files and images\&. A default install would put these in:
 
273
.sp
 
274
.RS 4
 
275
.ie n \{\
 
276
\h'-04'\(bu\h'+03'\c
 
277
.\}
 
278
.el \{\
 
279
.sp -1
 
280
.IP \(bu 2.3
 
281
.\}
 
282
/usr/local/samba/sbin/swat
 
283
.RE
 
284
.sp
 
285
.RS 4
 
286
.ie n \{\
 
287
\h'-04'\(bu\h'+03'\c
 
288
.\}
 
289
.el \{\
 
290
.sp -1
 
291
.IP \(bu 2.3
 
292
.\}
 
293
/usr/local/samba/swat/images/*
 
294
.RE
 
295
.sp
 
296
.RS 4
 
297
.ie n \{\
 
298
\h'-04'\(bu\h'+03'\c
 
299
.\}
 
300
.el \{\
 
301
.sp -1
 
302
.IP \(bu 2.3
 
303
.\}
 
304
/usr/local/samba/swat/help/*
 
305
.sp
 
306
.RE
 
307
.SS "Inetd Installation"
 
308
.PP
 
309
You need to edit your
 
310
\FC/etc/inetd\&.conf \F[]
 
311
and
 
312
\FC/etc/services\F[]
 
313
to enable SWAT to be launched via
 
314
\FCinetd\F[]\&.
 
315
.PP
 
316
In
 
317
\FC/etc/services\F[]
 
318
you need to add a line like this:
 
319
.PP
 
320
\FCswat 901/tcp\F[]
 
321
.PP
 
322
Note for NIS/YP and LDAP users \- you may need to rebuild the NIS service maps rather than alter your local
 
323
\FC /etc/services\F[]
 
324
file\&.
 
325
.PP
 
326
the choice of port number isn\'t really important except that it should be less than 1024 and not currently used (using a number above 1024 presents an obscure security hole depending on the implementation details of your
 
327
\FCinetd\F[]
 
328
daemon)\&.
 
329
.PP
 
330
In
 
331
\FC/etc/inetd\&.conf\F[]
 
332
you should add a line like this:
 
333
.PP
 
334
\FCswat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat\F[]
 
335
.PP
 
336
Once you have edited
 
337
\FC/etc/services\F[]
 
338
and
 
339
\FC/etc/inetd\&.conf\F[]
 
340
you need to send a HUP signal to inetd\&. To do this use
 
341
\FCkill \-1 PID \F[]
 
342
where PID is the process ID of the inetd daemon\&.
 
343
.SH "LAUNCHING"
 
344
.PP
 
345
To launch SWAT just run your favorite web browser and point it at "http://localhost:901/"\&.
 
346
.PP
 
347
Note that you can attach to SWAT from any IP connected machine but connecting from a remote machine leaves your connection open to password sniffing as passwords will be sent in the clear over the wire\&.
 
348
.SH "FILES"
 
349
.PP
 
350
\FC/etc/inetd\&.conf\F[]
 
351
.RS 4
 
352
This file must contain suitable startup information for the meta\-daemon\&.
 
353
.RE
 
354
.PP
 
355
\FC/etc/services\F[]
 
356
.RS 4
 
357
This file must contain a mapping of service name (e\&.g\&., swat) to service port (e\&.g\&., 901) and protocol type (e\&.g\&., tcp)\&.
 
358
.RE
 
359
.PP
 
360
\FC/usr/local/samba/lib/smb\&.conf\F[]
 
361
.RS 4
 
362
This is the default location of the
 
363
\fBsmb.conf\fR(5)
 
364
server configuration file that swat edits\&. Other common places that systems install this file are
 
365
\FC /usr/samba/lib/smb\&.conf\F[]
 
366
and
 
367
\FC/etc/smb\&.conf \F[]\&. This file describes all the services the server is to make available to clients\&.
 
368
.RE
 
369
.SH "WARNINGS"
 
370
.PP
 
371
\FCswat\F[]
 
372
will rewrite your
 
373
\fBsmb.conf\fR(5)
 
374
file\&. It will rearrange the entries and delete all comments,
 
375
\fIinclude=\fR
 
376
and
 
377
\fIcopy= \fR
 
378
options\&. If you have a carefully crafted
 
379
\FC smb\&.conf\F[]
 
380
then back it up or don\'t use swat!
 
381
.SH "VERSION"
 
382
.PP
 
383
This man page is correct for version 3 of the Samba suite\&.
 
384
.SH "SEE ALSO"
 
385
.PP
 
386
\FCinetd(5)\F[],
 
387
\fBsmbd\fR(8),
 
388
\fBsmb.conf\fR(5)
 
389
.SH "AUTHOR"
 
390
.PP
 
391
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\&.
 
392
.PP
 
393
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
 
394
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\&.