Added swat html & manpage.
[kai/samba.git] / docs / manpages / smbd.8
1 .TH "smbd" "8" "23 Oct 1998" "Samba" "SAMBA" 
2 .PP 
3 .SH "NAME" 
4 smbd \- server to provide SMB/CIFS services to clients
5 .PP 
7 .PP 
8 \fBsmbd\fP [-D] [-a] [-o] [-d debuglevel] [-l log file] [-p port number] [-O socket options] [-s configuration file] [-i scope] [-P] [-h]
9 .PP 
11 .PP 
12 This program is part of the \fBSamba\fP suite\&.
13 .PP 
14 \fBsmbd\fP is the server daemon that provides filesharing services to
15 Windows clients\&. The server provides filespace and printer services to
16 clients using the SMB (or CIFS) protocol\&. This is compatible with the
17 LanManager protocol, and can service LanManager clients\&.  These
18 include MSCLIENT 3\&.0 for DOS, Windows for Workgroups, Windows 95,
19 Windows NT, OS/2, DAVE for Macintosh, and smbfs for Linux\&.
20 .PP 
21 An extensive description of the services that the server can provide
22 is given in the man page for the configuration file controlling the
23 attributes of those services (see \fBsmb\&.conf (5)\fP)\&.  This man page
24 will not describe the services, but will concentrate on the
25 administrative aspects of running the server\&.
26 .PP 
27 Please note that there are significant security implications to
28 running this server, and the \fBsmb\&.conf (5)\fP manpage should be
29 regarded as mandatory reading before proceeding with installation\&.
30 .PP 
31 A session is created whenever a client requests one\&. Each client gets
32 a copy of the server for each session\&. This copy then services all
33 connections made by the client during that session\&. When all
34 connections from its client are are closed, the copy of the server for
35 that client terminates\&.
36 .PP 
37 The configuration file, and any files that it includes, are
38 automatically reloaded every minute, if they change\&.  You can force a
39 reload by sending a SIGHUP to the server\&.  Reloading the configuration
40 file will not affect connections to any service that is already
41 established\&.  Either the user will have to disconnect from the
42 service, or smbd killed and restarted\&.
43 .PP 
45 .PP 
46 .IP 
47 .IP "\fB-D\fP" 
48 If specified, this parameter causes the server to operate as a
49 daemon\&. That is, it detaches itself and runs in the background,
50 fielding requests on the appropriate port\&. Operating the server as a
51 daemon is the recommended way of running smbd for servers that provide
52 more than casual use file and print services\&.
53 .IP 
54 By default, the server will NOT operate as a daemon\&. 
55 .IP 
56 .IP "\fB-a\fP" 
57 If this parameter is specified, each new connection will
58 append log messages to the log file\&.  This is the default\&.
59 .IP 
60 .IP "\fB-o\fP" 
61 If this parameter is specified, the log files will be
62 overwritten when opened\&.  By default, the log files will be appended
63 to\&.
64 .IP 
65 .IP "\fB-d debuglevel\fP" 
66 debuglevel is an integer from 0 to 10\&.
67 .IP 
68 The default value if this parameter is not specified is zero\&.
69 .IP 
70 The higher this value, the more detail will be logged to the log files
71 about the activities of the server\&. At level 0, only critical errors
72 and serious warnings will be logged\&. Level 1 is a reasonable level for
73 day to day running - it generates a small amount of information about
74 operations carried out\&.
75 .IP 
76 Levels above 1 will generate considerable amounts of log data, and
77 should only be used when investigating a problem\&. Levels above 3 are
78 designed for use only by developers and generate HUGE amounts of log
79 data, most of which is extremely cryptic\&.
80 .IP 
81 Note that specifying this parameter here will override the \fBlog
82 level\fP parameter in the \fBsmb\&.conf
83 (5)\fP file\&.
84 .IP 
85 .IP "\fB-l log file\fP" 
86 If specified, \fIlog file\fP specifies
87 a log filename into which informational and debug messages from the
88 running server will be logged\&. The log file generated is never removed
89 by the server although its size may be controlled by the \fBmax
90 log size\fP option in the \fBsmb\&.conf
91 (5)\fP file\&.  The default log file name is specified
92 at compile time\&.
93 .IP 
94 .IP "\fB-O socket options\fP" 
95 See the \fBsocket
96 options\fP parameter in the
97 \fBsmb\&.conf (5)\fP file for details\&.
98 .IP 
99 .IP "\fB-p port number\fP" 
100 port number is a positive integer value\&.  The
101 default value if this parameter is not specified is 139\&.
102 .IP 
103 This number is the port number that will be used when making
104 connections to the server from client software\&. The standard
105 (well-known) port number for the SMB over TCP is 139, hence the
106 default\&. If you wish to run the server as an ordinary user rather than
107 as root, most systems will require you to use a port number greater
108 than 1024 - ask your system administrator for help if you are in this
109 situation\&.
110 .IP 
111 In order for the server to be useful by most clients, should you
112 configure it on a port other than 139, you will require port
113 redirection services on port 139, details of which are outlined in
114 rfc1002\&.txt section 4\&.3\&.5\&.
115 .IP 
116 This parameter is not normally specified except in the above
117 situation\&.
118 .IP 
119 .IP "\fB-s configuration file\fP" 
120 The default configuration file name is
121 determined at compile time\&.
122 .IP 
123 The file specified contains the configuration details required by the
124 server\&.  The information in this file includes server-specific
125 information such as what printcap file to use, as well as descriptions
126 of all the services that the server is to provide\&. See \fBsmb\&.conf
127 (5)\fP for more information\&.
128 .IP 
129 .IP "\fB-i scope\fP" 
130 This specifies a NetBIOS scope that the server will use
131 to communicate with when generating NetBIOS names\&. For details on the
132 use of NetBIOS scopes, see rfc1001\&.txt and rfc1002\&.txt\&. NetBIOS scopes
133 are \fIvery\fP rarely used, only set this parameter if you are the
134 system administrator in charge of all the NetBIOS systems you
135 communicate with\&.
136 .IP 
137 .IP "\fB-h\fP" 
138 Prints the help information (usage) for smbd\&.
139 .IP 
140 .IP "\fB-P\fP" 
141 Passive option\&. Causes smbd not to send any network traffic
142 out\&. Used for debugging by the developers only\&.
143 .IP 
144 .PP 
145 .SH "FILES" 
146 .PP 
147 \fB/etc/inetd\&.conf\fP
148 .PP 
149 If the server is to be run by the inetd meta-daemon, this file must
150 contain suitable startup information for the meta-daemon\&. See the
151 section \fIINSTALLATION\fP below\&.
152 .PP 
153 \fB/etc/rc\fP
154 .PP 
155 (or whatever initialisation script your system uses)\&.
156 .PP 
157 If running the server as a daemon at startup, this file will need to
158 contain an appropriate startup sequence for the server\&. See the
159 section \fIINSTALLATION\fP below\&.
160 .PP 
161 \fB/etc/services\fP
162 .PP 
163 If running the server via the meta-daemon inetd, this file must
164 contain a mapping of service name (eg\&., netbios-ssn) to service port
165 (eg\&., 139) and protocol type (eg\&., tcp)\&. See the section
166 \fIINSTALLATION\fP below\&.
167 .PP 
168 \fB/usr/local/samba/lib/smb\&.conf\fP
169 .PP 
170 This is the default location of the \fIsmb\&.conf\fP server configuration
171 file\&. Other common places that systems install this file are
172 \fI/usr/samba/lib/smb\&.conf\fP and \fI/etc/smb\&.conf\fP\&.
173 .PP 
174 This file describes all the services the server is to make available
175 to clients\&. See \fBsmb\&.conf (5)\fP for more information\&.
176 .PP 
178 .PP 
179 On some systems \fBsmbd\fP cannot change uid back to root after a
180 setuid() call\&.  Such systems are called "trapdoor" uid systems\&. If you
181 have such a system, you will be unable to connect from a client (such
182 as a PC) as two different users at once\&. Attempts to connect the
183 second user will result in "access denied" or similar\&.
184 .PP 
186 .PP 
188 .PP 
189 If no printer name is specified to printable services, most systems
190 will use the value of this variable (or "lp" if this variable is not
191 defined) as the name of the printer to use\&. This is not specific to
192 the server, however\&.
193 .PP 
195 .PP 
196 The location of the server and its support files is a matter for
197 individual system administrators\&. The following are thus suggestions
198 only\&.
199 .PP 
200 It is recommended that the server software be installed under the
201 /usr/local/samba hierarchy, in a directory readable by all, writeable
202 only by root\&. The server program itself should be executable by all,
203 as users may wish to run the server themselves (in which case it will
204 of course run with their privileges)\&.  The server should NOT be
205 setuid\&. On some systems it may be worthwhile to make smbd setgid to an
206 empty group\&. This is because some systems may have a security hole
207 where daemon processes that become a user can be attached to with a
208 debugger\&. Making the smbd file setgid to an empty group may prevent
209 this hole from being exploited\&. This security hole and the suggested
210 fix has only been confirmed on old versions (pre-kernel 2\&.0) of Linux
211 at the time this was written\&. It is possible that this hole only
212 exists in Linux, as testing on other systems has thus far shown them
213 to be immune\&.
214 .PP 
215 The server log files should be put in a directory readable and
216 writable only by root, as the log files may contain sensitive
217 information\&.
218 .PP 
219 The configuration file should be placed in a directory readable and
220 writable only by root, as the configuration file controls security for
221 the services offered by the server\&. The configuration file can be made
222 readable by all if desired, but this is not necessary for correct
223 operation of the server and is not recommended\&. A sample configuration
224 file "smb\&.conf\&.sample" is supplied with the source to the server -
225 this may be renamed to "smb\&.conf" and modified to suit your needs\&.
226 .PP 
227 The remaining notes will assume the following:
228 .PP 
229 .IP 
230 .IP o 
231 \fBsmbd\fP (the server program) installed in /usr/local/samba/bin
232 .IP 
233 .IP o 
234 \fBsmb\&.conf\fP (the configuration file) installed in /usr/local/samba/lib
235 .IP 
236 .IP o 
237 log files stored in /var/adm/smblogs
238 .IP 
239 .PP 
240 The server may be run either as a daemon by users or at startup, or it
241 may be run from a meta-daemon such as inetd upon request\&. If run as a
242 daemon, the server will always be ready, so starting sessions will be
243 faster\&. If run from a meta-daemon some memory will be saved and
244 utilities such as the tcpd TCP-wrapper may be used for extra security\&.
245 For serious use as file server it is recommended that \fBsmbd\fP be run
246 as a daemon\&.
247 .PP 
248 When you\'ve decided, continue with either \fIRUNNING THE SERVER AS A
250 .PP 
252 .PP 
253 To run the server as a daemon from the command line, simply put the
254 \fB-D\fP option on the command line\&. There is no need to place an
255 ampersand at the end of the command line - the \fB-D\fP option causes
256 the server to detach itself from the tty anyway\&.
257 .PP 
258 Any user can run the server as a daemon (execute permissions
259 permitting, of course)\&. This is useful for testing purposes, and may
260 even be useful as a temporary substitute for something like ftp\&. When
261 run this way, however, the server will only have the privileges of the
262 user who ran it\&.
263 .PP 
264 To ensure that the server is run as a daemon whenever the machine is
265 started, and to ensure that it runs as root so that it can serve
266 multiple clients, you will need to modify the system startup
267 files\&. Wherever appropriate (for example, in /etc/rc), insert the
268 following line, substituting port number, log file location,
269 configuration file location and debug level as desired:
270 .PP 
271 \f(CW/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log -s /usr/local/samba/lib/smb\&.conf\fP
272 .PP 
273 (The above should appear in your initialisation script as a single line\&. 
274 Depending on your terminal characteristics, it may not appear that way in
275 this man page\&. If the above appears as more than one line, please treat any 
276 newlines or indentation as a single space or TAB character\&.)
277 .PP 
278 If the options used at compile time are appropriate for your system,
279 all parameters except the desired debug level and \fB-D\fP may be
280 omitted\&. See the section \fIOPTIONS\fP above\&.
281 .PP 
283 .PP 
284 If your system uses a meta-daemon such as inetd, you can arrange to
285 have the smbd server started whenever a process attempts to connect to
286 it\&. This requires several changes to the startup files on the host
287 machine\&. If you are experimenting as an ordinary user rather than as
288 root, you will need the assistance of your system administrator to
289 modify the system files\&.
290 .PP 
291 You will probably want to set up the NetBIOS name server \fBnmbd\fP at
292 the same time as \fBsmbd\fP\&. To do this refer to the man page for
293 \fBnmbd (8)\fP\&.
294 .PP 
295 First, ensure that a port is configured in the file \f(CW/etc/services\fP\&. The
296 well-known port 139 should be used if possible, though any port may be
297 used\&.
298 .PP 
299 Ensure that a line similar to the following is in \f(CW/etc/services\fP:
300 .PP 
301 \f(CWnetbios-ssn        139/tcp\fP
302 .PP 
303 Note for NIS/YP users - you may need to rebuild the NIS service maps
304 rather than alter your local \f(CW/etc/services file\fP\&.
305 .PP 
306 Next, put a suitable line in the file \f(CW/etc/inetd\&.conf\fP (in the unlikely
307 event that you are using a meta-daemon other than inetd, you are on
308 your own)\&. Note that the first item in this line matches the service
309 name in \f(CW/etc/services\fP\&.  Substitute appropriate values for your system
310 in this line (see \fBinetd (8)\fP):
311 .PP 
312 \f(CWnetbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd -d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb\&.conf\fP
313 .PP 
314 (The above should appear in \f(CW/etc/inetd\&.conf\fP as a single
315 line\&. Depending on your terminal characteristics, it may not appear
316 that way in this man page\&.  If the above appears as more than one
317 line, please treat any newlines or indentation as a single space or
318 TAB character\&.)
319 .PP 
320 Note that there is no need to specify a port number here, even if you
321 are using a non-standard port number\&.
322 .PP 
323 Lastly, edit the configuration file to provide suitable services\&. To
324 start with, the following two services should be all you need:
325 .PP 
327 .DS 
331 [homes]
332   writable = yes
334 [printers]
335  writable = no
336  printable = yes
337  path = /tmp
338  public = yes
341 .DE 
344 .PP 
345 This will allow you to connect to your home directory and print to any
346 printer supported by the host (user privileges permitting)\&.
347 .PP 
349 .PP 
350 If running the server as a daemon, execute it before proceeding\&. If
351 using a meta-daemon, either restart the system or kill and restart the
352 meta-daemon\&. Some versions of inetd will reread their configuration
353 tables if they receive a HUP signal\&.
354 .PP 
355 If your machine\'s name is "fred" and your name is "mary", you should
356 now be able to connect to the service \f(CW\e\efred\emary\fP\&.
357 .PP 
358 To properly test and experiment with the server, we recommend using
359 the smbclient program (see \fBsmbclient (1)\fP) and also going through
360 the steps outlined in the file \fIDIAGNOSIS\&.txt\fP in the \fIdocs/\fP
361 directory of your Samba installation\&.
362 .PP 
363 .SH "VERSION" 
364 .PP 
365 This man page is correct for version 2\&.0 of the Samba suite\&.
366 .PP 
368 .PP 
369 Most diagnostics issued by the server are logged in a specified log
370 file\&. The log file name is specified at compile time, but may be
371 overridden on the command line\&.
372 .PP 
373 The number and nature of diagnostics available depends on the debug
374 level used by the server\&. If you have problems, set the debug level to
375 3 and peruse the log files\&.
376 .PP 
377 Most messages are reasonably self-explanatory\&. Unfortunately, at time
378 of creation of this man page there are too many diagnostics available
379 in the source code to warrant describing each and every diagnostic\&. At
380 this stage your best bet is still to grep the source code and inspect
381 the conditions that gave rise to the diagnostics you are seeing\&.
382 .PP 
383 .SH "SIGNALS" 
384 .PP 
385 Sending the smbd a SIGHUP will cause it to re-load its smb\&.conf
386 configuration file within a short period of time\&.
387 .PP 
388 To shut down a users smbd process it is recommended that SIGKILL (-9)
389 \fINOT\fP be used, except as a last resort, as this may leave the shared
390 memory area in an inconsistant state\&. The safe way to terminate an
391 smbd is to send it a SIGTERM (-15) signal and wait for it to die on
392 its own\&.
393 .PP 
394 The debug log level of smbd may be raised
395 by sending it a SIGUSR1 \f(CW(kill -USR1 <smbd-pid>)\fP and lowered by
396 sending it a SIGUSR2 \f(CW(kill -USR2 <smbd-pid>)\fP\&. This is to allow
397 transient problems to be diagnosed, whilst still running at a normally
398 low log level\&.
399 .PP 
400 Note that as the signal handlers send a debug write, they are not
401 re-entrant in smbd\&. This you should wait until smbd is in a state of
402 waiting for an incoming smb before issuing them\&. It is possible to
403 make the signal handlers safe by un-blocking the signals before the
404 select call and re-blocking them after, however this would affect
405 performance\&.
406 .PP 
407 .SH "SEE ALSO" 
408 .PP 
409 \fBhosts_access (5)\fP, \fBinetd (8)\fP, \fBnmbd (8)\fP,
410 \fBsmb\&.conf (5)\fP, \fBsmbclient
411 (1)\fP, \fBtestparm (1)\fP,
412 \fBtestprns (1)\fP, and the Internet RFC\'s
413 \fBrfc1001\&.txt\fP, \fBrfc1002\&.txt\fP\&. In addition the CIFS (formerly SMB)
414 specification is available as a link from the Web page :
415 http://samba\&.anu\&.edu\&.au/cifs/\&.
416 .PP 
417 .SH "AUTHOR" 
418 .PP 
419 The original Samba software and related utilities were created by
420 Andrew Tridgell (samba-bugs@samba\&.anu\&.edu\&.au)\&. Samba is now developed
421 by the Samba Team as an Open Source project similar to the way the
422 Linux kernel is developed\&.
423 .PP 
424 The original Samba man pages were written by Karl Auer\&. The man page
425 sources were converted to YODL format (another excellent piece of Open
426 Source software, available at
427 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
428 and updated for the Samba2\&.0 release by Jeremy Allison\&.
429 \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&.
430 .PP 
431 See \fBsamba (7)\fP to find out how to get a full list of contributors
432 and details on how to submit bug reports, comments etc\&.