source: vendor/current/docs/manpages/smbd.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 12.4 KB
Line 
1'\" t
2.\" Title: smbd
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "SMBD" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31smbd \- server to provide SMB/CIFS services to clients
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34smbd [\-D|\-\-daemon] [\-F|\-\-foreground] [\-S|\-\-log\-stdout] [\-i|\-\-interactive] [\-V] [\-b|\-\-build\-options] [\-d\ <debug\ level>] [\-l|\-\-log\-basename\ <log\ directory>] [\-p\ <port\ number(s)>] [\-P\ <profiling\ level>] [\-s\ <configuration\ file>] [\-\-no\-process\-group]
35.SH "DESCRIPTION"
36.PP
37This program is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41smbd
42is the server daemon that provides filesharing and printing services to Windows clients\&. The server provides filespace and printer services to clients using the SMB (or CIFS) protocol\&. This is compatible with the LanManager protocol, and can service LanManager clients\&. These include MSCLIENT 3\&.0 for DOS, Windows for Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, OS/2, DAVE for Macintosh, and smbfs for Linux\&.
43.PP
44An extensive description of the services that the server can provide is given in the man page for the configuration file controlling the attributes of those services (see
45\fBsmb.conf\fR(5)\&. This man page will not describe the services, but will concentrate on the administrative aspects of running the server\&.
46.PP
47Please note that there are significant security implications to running this server, and the
48\fBsmb.conf\fR(5)
49manual page should be regarded as mandatory reading before proceeding with installation\&.
50.PP
51A session is created whenever a client requests one\&. Each client gets a copy of the server for each session\&. This copy then services all connections made by the client during that session\&. When all connections from its client are closed, the copy of the server for that client terminates\&.
52.PP
53The configuration file, and any files that it includes, are automatically reloaded every minute, if they change\&. You can force a reload by sending a SIGHUP to the server\&. Reloading the configuration file will not affect connections to any service that is already established\&. Either the user will have to disconnect from the service, or
54smbd
55killed and restarted\&.
56.SH "OPTIONS"
57.PP
58\-D|\-\-daemon
59.RS 4
60If specified, this parameter causes the server to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. Operating the server as a daemon is the recommended way of running
61smbd
62for servers that provide more than casual use file and print services\&. This switch is assumed if
63smbd
64is executed on the command line of a shell\&.
65.RE
66.PP
67\-F|\-\-foreground
68.RS 4
69If specified, this parameter causes the main
70smbd
71process to not daemonize, i\&.e\&. double\-fork and disassociate with the terminal\&. Child processes are still created as normal to service each connection request, but the main process does not exit\&. This operation mode is suitable for running
72smbd
73under process supervisors such as
74supervise
75and
76svscan
77from Daniel J\&. Bernstein\*(Aqs
78daemontools
79package, or the AIX process monitor\&.
80.RE
81.PP
82\-S|\-\-log\-stdout
83.RS 4
84If specified, this parameter causes
85smbd
86to log to standard output rather than a file\&.
87.RE
88.PP
89\-i|\-\-interactive
90.RS 4
91If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell\&. Setting this parameter negates the implicit daemon mode when run from the command line\&.
92smbd
93will only accept one connection and terminate\&. It will also log to standard output, as if the
94\-S
95parameter had been given\&.
96.RE
97.PP
98\-\-no\-process\-group
99.RS 4
100Do not create a new process group for smbd\&.
101.RE
102.PP
103\-b|\-\-build\-options
104.RS 4
105Prints information about how Samba was built\&.
106.RE
107.PP
108\-p|\-\-port<port number(s)>
109.RS 4
110\fIport number(s)\fR
111is a space or comma\-separated list of TCP ports smbd should listen on\&. The default value is taken from the
112\m[blue]\fBports\fR\m[]
113parameter in
114.sp
115The default ports are 139 (used for SMB over NetBIOS over TCP) and port 445 (used for plain SMB over TCP)\&.
116.RE
117.PP
118\-P|\-\-profiling\-level<profiling level>
119.RS 4
120\fIprofiling level\fR
121is a number specifying the level of profiling data to be collected\&. 0 turns off profiling, 1 turns on counter profiling only, 2 turns on complete profiling, and 3 resets all profiling data\&.
122.RE
123.SH "FILES"
124.PP
125/etc/inetd\&.conf
126.RS 4
127If the server is to be run by the
128inetd
129meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&.
130.RE
131.PP
132/etc/rc
133.RS 4
134or whatever initialization script your system uses)\&.
135.sp
136If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\&.
137.RE
138.PP
139/etc/services
140.RS 4
141If running the server via the meta\-daemon
142inetd, this file must contain a mapping of service name (e\&.g\&., netbios\-ssn) to service port (e\&.g\&., 139) and protocol type (e\&.g\&., tcp)\&.
143.RE
144.PP
145/usr/local/samba/lib/smb\&.conf
146.RS 4
147This is the default location of the
148\fBsmb.conf\fR(5)
149server configuration file\&. Other common places that systems install this file are
150/usr/samba/lib/smb\&.conf
151and
152/etc/samba/smb\&.conf\&.
153.sp
154This file describes all the services the server is to make available to clients\&. See
155\fBsmb.conf\fR(5)
156for more information\&.
157.RE
158.SH "LIMITATIONS"
159.PP
160On some systems
161smbd
162cannot change uid back to root after a setuid() call\&. Such systems are called trapdoor uid systems\&. If you have such a system, you will be unable to connect from a client (such as a PC) as two different users at once\&. Attempts to connect the second user will result in access denied or similar\&.
163.SH "ENVIRONMENT VARIABLES"
164.PP
165\fBPRINTER\fR
166.RS 4
167If no printer name is specified to printable services, most systems will use the value of this variable (or
168\fBlp\fR
169if this variable is not defined) as the name of the printer to use\&. This is not specific to the server, however\&.
170.RE
171.SH "PAM INTERACTION"
172.PP
173Samba uses PAM for authentication (when presented with a plaintext password), for account checking (is this account disabled?) and for session management\&. The degree too which samba supports PAM is restricted by the limitations of the SMB protocol and the
174\m[blue]\fBobey pam restrictions\fR\m[]\fBsmb.conf\fR(5)
175parameter\&. When this is set, the following restrictions apply:
176.sp
177.RS 4
178.ie n \{\
179\h'-04'\(bu\h'+03'\c
180.\}
181.el \{\
182.sp -1
183.IP \(bu 2.3
184.\}
185\fIAccount Validation\fR: All accesses to a samba server are checked against PAM to see if the account is valid, not disabled and is permitted to login at this time\&. This also applies to encrypted logins\&.
186.RE
187.sp
188.RS 4
189.ie n \{\
190\h'-04'\(bu\h'+03'\c
191.\}
192.el \{\
193.sp -1
194.IP \(bu 2.3
195.\}
196\fISession Management\fR: When not using share level security, users must pass PAM\*(Aqs session checks before access is granted\&. Note however, that this is bypassed in share level security\&. Note also that some older pam configuration files may need a line added for session support\&.
197.RE
198.SH "VERSION"
199.PP
200This man page is correct for version 3 of the Samba suite\&.
201.SH "DIAGNOSTICS"
202.PP
203Most diagnostics issued by the server are logged in a specified log file\&. The log file name is specified at compile time, but may be overridden on the command line\&.
204.PP
205The number and nature of diagnostics available depends on the debug level used by the server\&. If you have problems, set the debug level to 3 and peruse the log files\&.
206.PP
207Most messages are reasonably self\-explanatory\&. Unfortunately, at the time this man page was created, there are too many diagnostics available in the source code to warrant describing each and every diagnostic\&. At this stage your best bet is still to grep the source code and inspect the conditions that gave rise to the diagnostics you are seeing\&.
208.SH "TDB FILES"
209.PP
210Samba stores it\*(Aqs data in several TDB (Trivial Database) files, usually located in
211/var/lib/samba\&.
212.PP
213(*) information persistent across restarts (but not necessarily important to backup)\&.
214.PP
215account_policy\&.tdb*
216.RS 4
217NT account policy settings such as pw expiration, etc\&.\&.\&.
218.RE
219.PP
220brlock\&.tdb
221.RS 4
222byte range locks
223.RE
224.PP
225browse\&.dat
226.RS 4
227browse lists
228.RE
229.PP
230gencache\&.tdb
231.RS 4
232generic caching db
233.RE
234.PP
235group_mapping\&.tdb*
236.RS 4
237group mapping information
238.RE
239.PP
240locking\&.tdb
241.RS 4
242share modes & oplocks
243.RE
244.PP
245login_cache\&.tdb*
246.RS 4
247bad pw attempts
248.RE
249.PP
250messages\&.tdb
251.RS 4
252Samba messaging system
253.RE
254.PP
255netsamlogon_cache\&.tdb*
256.RS 4
257cache of user net_info_3 struct from net_samlogon() request (as a domain member)
258.RE
259.PP
260ntdrivers\&.tdb*
261.RS 4
262installed printer drivers
263.RE
264.PP
265ntforms\&.tdb*
266.RS 4
267installed printer forms
268.RE
269.PP
270ntprinters\&.tdb*
271.RS 4
272installed printer information
273.RE
274.PP
275printing/
276.RS 4
277directory containing tdb per print queue of cached lpq output
278.RE
279.PP
280registry\&.tdb
281.RS 4
282Windows registry skeleton (connect via regedit\&.exe)
283.RE
284.PP
285smbXsrv_session_global\&.tdb
286.RS 4
287session information (e\&.g\&. support for \*(Aqutmp = yes\*(Aq)
288.RE
289.PP
290smbXsrv_tcon_global\&.tdb
291.RS 4
292share connections (used to enforce max connections, etc\&.\&.\&.)
293.RE
294.PP
295smbXsrv_open_global\&.tdb
296.RS 4
297open file handles (used durable handles, etc\&.\&.\&.)
298.RE
299.PP
300share_info\&.tdb*
301.RS 4
302share acls
303.RE
304.PP
305winbindd_cache\&.tdb
306.RS 4
307winbindd\*(Aqs cache of user lists, etc\&.\&.\&.
308.RE
309.PP
310winbindd_idmap\&.tdb*
311.RS 4
312winbindd\*(Aqs local idmap db
313.RE
314.PP
315wins\&.dat*
316.RS 4
317wins database when \*(Aqwins support = yes\*(Aq
318.RE
319.SH "SIGNALS"
320.PP
321Sending the
322smbd
323a SIGHUP will cause it to reload its
324smb\&.conf
325configuration file within a short period of time\&.
326.PP
327To shut down a user\*(Aqs
328smbd
329process it is recommended that
330SIGKILL (\-9)\fINOT\fR
331be used, except as a last resort, as this may leave the shared memory area in an inconsistent state\&. The safe way to terminate an
332smbd
333is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&.
334.PP
335The debug log level of
336smbd
337may be raised or lowered using
338\fBsmbcontrol\fR(1)
339program (SIGUSR[1|2] signals are no longer used since Samba 2\&.2)\&. This is to allow transient problems to be diagnosed, whilst still running at a normally low log level\&.
340.PP
341Note that as the signal handlers send a debug write, they are not re\-entrant in
342smbd\&. This you should wait until
343smbd
344is in a state of waiting for an incoming SMB before issuing them\&. It is possible to make the signal handlers safe by un\-blocking the signals before the select call and re\-blocking them after, however this would affect performance\&.
345.SH "SEE ALSO"
346.PP
347\fBhosts_access\fR(5),
348\fBinetd\fR(8),
349\fBnmbd\fR(8),
350\fBsmb.conf\fR(5),
351\fBsmbclient\fR(1),
352\fBtestparm\fR(1), and the Internet RFC\*(Aqs
353rfc1001\&.txt,
354rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
355http://samba\&.org/cifs/\&.
356.SH "AUTHOR"
357.PP
358The 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\&.
359.PP
360The 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
361ftp://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.