Manpage version of yodl doc.
[kai/samba.git] / docs / manpages / winbindd.8
1 .TH "winbindd " "1" "8 May 2000" "Samba" "SAMBA" 
2 .PP 
3 .SH "NAME" 
4 winbindd \- Name Service Switch daemon for resolving names from NT servers
5 .PP 
7 .PP 
8 \fBwinbindd\fP [-d debuglevel] [-i]
9 .PP 
11 .PP 
12 This program is part of the \fBSamba\fP suite version 3\&.0 and describes
13 functionality not yet implemented in the main version of Samba\&.
14 .PP 
15 \fBwinbindd\fP is a daemon that provides a service for the Name Service
16 Switch capability that is present in most modern C libraries\&.  The Name
17 Service Switch allows user and system information to be obtained from
18 different databases services such as NIS or DNS\&.  The exact behaviour can
19 be configured throught the \f(CW/etc/nsswitch\&.conf\fP file\&.  Users and groups
20 are allocated as they are resolved to a range of user and group ids
21 specified by the administrator of the Samba system\&.  
22 .PP 
23 The service provided by \fBwinbindd\fP is called `winbind\' and can be used to
24 resolve user and group information from a Windows NT server\&.  
25 .PP 
26 The following nsswitch databases are implemented by the \fBwinbindd\fP
27 service:
28 .PP 
29 .IP 
30 .IP "passwd" 
31 .IP 
32 User information traditionally stored in the \fBpasswd(5)\fP file and used by
33 \fBgetpwent(3)\fP functions\&.
34 .IP 
35 .IP "group" 
36 .IP 
37 Group information traditionally stored in the \fBgroup(5)\fP file and used by
38 \fBgetgrent(3)\fP functions\&.
39 .IP 
40 .PP 
41 For example, the following simple configuration in the
42 \f(CW/etc/nsswitch\&.conf\fP file can be used to initially resolve user and group
43 information from \f(CW/etc/passwd\fP and \f(CW/etc/group\fP and then from the
44 Windows NT server\&.
45 .PP 
46 \f(CWpasswd:         files winbind\fP
47 .PP 
48 \f(CWgroup:          files winbind\fP
49 .PP 
51 .PP 
52 The following options are available to the \fBwinbindd\fP daemon:
53 .PP 
54 .IP 
55 .IP "\fB-d debuglevel\fP" 
56 Sets the debuglevel to an integer between 0 and 100\&. 0 is for no debugging
57 and 100 is for reams and reams\&. To submit a bug report to the Samba Team,
58 use debug level 100 (see \fBBUGS\&.txt\fP)\&.  
59 .IP 
60 .IP "\fB-i\fP" 
61 Tells winbindd to not become a daemon and detach from the current terminal\&.
62 This option is used by developers when interactive debugging of winbindd is
63 required\&.
64 .IP 
65 .PP 
67 .PP 
68 Users and groups on a Windows NT server are assigned a relative id (rid)
69 which is unique for the domain when the user or group is created\&.  To
70 convert the Windows NT user or group into a unix user or group, a mapping
71 between rids and unix user and group ids is required\&.  This is one of the
72 jobs that \fBwinbindd\fP performs\&.
73 .PP 
74 As \fBwinbindd\fP users and groups are resolved from a server, user and group
75 ids are allocated from a specified range\&.  This is done on a first come,
76 first served basis, although all existing users and groups will be mapped
77 as soon as a client performs a user or group enumeration command\&.  The
78 allocated unix ids are stored in a database file under the Samba lock
79 directory and will be remembered\&.
80 .PP 
81 WARNING: The rid to unix id database is the only location where the user
82 and group mappings are stored by \fBwinbindd\fP\&.  If this file is deleted or
83 corrupted, there is no way for \fBwinbindd\fP to determine which user and
84 group ids correspond to Windows NT user and group rids\&.
85 .PP 
87 .PP 
88 Configuration of the \fBwinbindd\fP daemon is done through configuration
89 parameters in the \fBsmb\&.conf\fP file\&.  All parameters
90 should be specified in the [global] section of
91 \fBsmb\&.conf\fP\&.
92 .PP 
93 .IP 
94 .IP "winbind uid" 
95 .IP 
96 The winbind uid parameter specifies the range of user ids that are
97 allocated by the \fBwinbindd\fP daemon\&.  This range of
98 ids should have no existing local or nis users within it as strange
99 conflicts can occur otherwise\&.
100 .IP 
101 \fBDefault:\fP
102 \f(CW     winbind uid = <empty string>\fP
103 .IP 
104 \fBExample:\fP
105 \f(CW     winbind uid = 10000-20000\fP
106 .IP 
107 .IP "winbind gid" 
108 .IP 
109 The winbind gid parameter specifies the range of group ids that are
110 allocated by the \fBwinbindd\fP daemon\&.  This range of
111 group ids should have no existing local or nis groups within it as strange
112 conflicts can occur otherwise\&.
113 .IP 
114 \fBDefault:\fP
115 \f(CW     winbind gid = <empty string>\fP
116 .IP 
117 \fBExample:\fP
118 \f(CW     winbind gid = 10000-20000\fP
119 .IP 
120 .IP "winbind cache time" 
121 .IP 
122 This parameter specifies the number of seconds the
123 \fBwinbindd\fP daemon will cache user and group
124 information before querying a Windows NT server again\&.
125 .IP 
126 \fBDefault:\fP
127 \f(CW     winbind cache type = 15\fP
128 .IP 
129 .IP "template homedir" 
130 .IP 
131 When filling out the user information for a Windows NT user, the
132 \fBwinbindd\fP daemon uses this parameter to fill in
133 the home directory for that user\&.  If the string \f(CW%D\fP is present it is
134 substituted with the user\'s Windows NT domain name\&.  If the string \f(CW%U\fP
135 is present it is substituted with the user\'s Windows NT user name\&.
136 .IP 
137 \fBDefault:\fP
138 \f(CW     template homedir = /home/%D/%U\fP
139 .IP 
140 .IP "template shell" 
141 .IP 
142 When filling out the user information for a Windows NT user, the
143 \fBwinbindd\fP daemon uses this parameter to fill in
144 the home directory for that user\&.  If the string \f(CW%D\fP is present it is
145 substituted with the user\'s Windows NT domain name\&.  If the string \f(CW%U\fP
146 is present it is substituted with the user\'s Windows NT user name\&.
147 .IP 
148 \fBDefault:\fP
149 \f(CW     template homedir = /home/%D/%U\fP
150 .IP 
151 .PP 
152 .SH "FILES" 
153 .PP 
154 The following files are relevant to the operation of the \fBwinbindd\fP
155 daemon\&.
156 .PP 
157 .IP 
158 .IP "/etc/nsswitch\&.conf(5)" 
159 .IP 
160 Name service switch configuration file\&.
161 .IP 
162 .IP "/tmp/\&.winbindd/pipe" 
163 .IP 
164 The UNIX pipe over which clients communicate with the \fBwinbindd\fP program\&.
165 For security reasons, the winbind client will only attempt to connect to the
166 \fBwinbindd\fP daemon if both the \f(CW/tmp/\&.winbindd\fP directory and
167 \f(CW/tmp/\&.winbindd/pipe\fP file are owned by root\&.
168 .IP 
169 .IP "/lib/libnss_winbind\&.so\&.X" 
170 .IP 
171 Implementation of name service switch library\&. 
172 .IP 
173 .IP "$LOCKDIR/winbindd_idmap\&.tdb" 
174 .IP 
175 Storage for the Windows NT rid to UNIX user/group id mapping\&.  If this file
176 is damaged or destroyed then the mappings will be lost\&.
177 .IP 
178 The lock directory is specified when Samba is initially compiled using the
179 \f(CW--with-lockdir\fP option\&.  This directory is by default
180 \f(CW/usr/local/samba/var/locks\fP\&.
181 .IP 
182 .IP "$LOCKDIR/winbindd_cache\&.tdb" 
183 .IP 
184 Storage for cached user and group information\&.
185 .IP 
186 .PP 
187 .SH "SEE ALSO" 
188 .PP 
189 \fBsamba(7)\fP, \fBsmb\&.conf(5)\fP, 
190 \fBnsswitch\&.conf(5)\fP
191 .PP 
192 .SH "AUTHOR" 
193 .PP 
194 The original Samba software and related utilities were created by
195 Andrew Tridgell samba-bugs@samba\&.org\&. Samba is now developed
196 by the Samba Team as an Open Source project similar to the way the
197 Linux kernel is developed\&.
198 .PP 
199 Winbindd was written by Tim Potter\&.