samba-tool: Unify usage messages.
[Samba/gbeck.git] / source4 / NEWS
blobf7c03c60bfd561478b550dda65fd91991545ec54
1 This file aims to document the major changes since the latest released version 
2 of Samba, 3.0. Samba 4.0 contains rewrites of several subsystems 
3 and uses a different internal format for most data. Since this 
4 file is an initial draft, please update missing items.
6 One of the main goals of Samba 4 was Active Directory Domain Controller 
7 support. This means Samba now implements several protocols that are required 
8 by AD such as Kerberos and DNS.
10 An (experimental) upgrade script that performs a one-way upgrade 
11 from Samba 3 is available in source/setup/upgrade.
13 Removal of nmbd and introduction of process models
14 ==================================================
15 smbd now implements several network protocols other than just CIFS and 
16 DCE/RPC. nmbd's functionality has been merged into smbd. smbd supports 
17 various 'process models' that specify how concurrent connections are 
18 handled (when to fork, use threads, etc). 
20 Introduction of LDB
21 ===================
22 Samba now stores most of its persistent data in a LDAP-like database 
23 called LDB (see ldb(7) for more info). 
25 Removed SWAT
26 ==================
27 Unlike previous versions, Samba4 does not provide a web interface at this time.
29 Built-in KDC
30 ============
31 Samba4 ships with an integrated KDC (Kerberos Key Distribution
32 Center).  Backed directly onto our main internal database, and
33 integrated with custom code to handle the PAC, Samba4's KDC is an
34 integral part of our support for AD logon protocols.
36 Built-in LDAP Server
37 ====================
38 Like the situation with the KDC, Samba4 ships with it's own LDAP
39 server, included to provide simple, built-in LDAP services in an AD
40 (rather than distinctly standards) matching manner.  The database is
41 LDB, and it shares that in common with the rest of Samba.
43 Changed configuration options
44 =============================
45 Several configuration options have been removed in Samba4 while others have 
46 been introduced. This section contains a summary of changes to smb.conf and 
47 where these settings moved. Configuration options that have disappeared may be 
48 re-added later when the functionality that uses them gets reimplemented in 
49 Samba 4.
51 The 'security' parameter has been split up. It is now only used to choose 
52 between the 'user' and 'share' security levels (the latter is not supported 
53 in Samba 4 yet). The other values of this option and the 'domain master' and 
54 'domain logons' parameters have been merged into a 'server role' parameter 
55 that can be either 'domain controller', 'member server' or 'standalone'. Note that 
56 member server support does not work yet.
58 The following parameters have been removed:
59 - passdb backend: accounts are now stored in a LDB-based SAM database
60 - update encrypted
61 - public
62 - guest ok
63 - client schannel
64 - server schannel
65 - allow trusted domains
66 - hosts equiv
67 - map to guest
68 - smb passwd file
69 - algorithmic rid base
70 - root directory
71 - root dir
72 - root
73 - guest account
74 - enable privileges
75 - pam password change
76 - passwd program
77 - passwd chat debug
78 - passwd chat timeout
79 - check password script
80 - username map
81 - username level
82 - unix password sync
83 - restrict anonymous
84 - username
85 - user
86 - users
87 - invalid users
88 - valid users
89 - admin users
90 - read list
91 - write list
92 - printer admin
93 - force user
94 - force group
95 - group
96 - write ok
97 - writeable
98 - writable
99 - acl check permissions
100 - acl group control
101 - acl map full control
102 - create mask
103 - create mode
104 - force create mode
105 - security mask
106 - force security mode
107 - directory mask
108 - directory mode
109 - force directory mode
110 - directory security mask
111 - force directory security mode
112 - force unknown acl user
113 - inherit permissions
114 - inherit acls
115 - inherit owner
116 - guest only
117 - only guest
118 - only user
119 - allow hosts
120 - deny hosts
121 - preload modules
122 - use kerberos keytab
123 - syslog
124 - syslog only
125 - max log size
126 - debug timestamp
127 - timestamp logs
128 - debug hires timestamp
129 - debug pid
130 - debug uid
131 - allocation roundup size
132 - aio read size
133 - aio write size
134 - aio write behind
135 - large readwrite
136 - protocol
137 - read bmpx
138 - reset on zero vc
139 - acl compatibility
140 - defer sharing violations
141 - ea support
142 - nt acl support
143 - nt pipe support
144 - profile acls
145 - map acl inherit
146 - afs share
147 - max ttl
148 - client use spnego
149 - enable asu support
150 - svcctl list
151 - block size
152 - change notify timeout
153 - deadtime
154 - getwd cache
155 - keepalive
156 - kernel change notify
157 - lpq cache time
158 - max smbd processes
159 - max disk size
160 - max open files
161 - min print space
162 - strict allocate
163 - sync always
164 - use mmap
165 - use sendfile
166 - hostname lookups
167 - write cache size
168 - name cache timeout
169 - max reported print jobs
170 - load printers
171 - printcap cache time
172 - printcap name
173 - printcap
174 - printing
175 - cups options
176 - cups server
177 - iprint server
178 - print command
179 - disable spoolss
180 - enable spoolss
181 - lpq command
182 - lprm command
183 - lppause command
184 - lpresume command
185 - queuepause command
186 - queueresume command
187 - enumports command
188 - addprinter command
189 - deleteprinter command
190 - show add printer wizard
191 - os2 driver map
192 - use client driver
193 - default devmode
194 - force printername
195 - mangling method
196 - mangle prefix
197 - default case
198 - case sensitive
199 - casesignames
200 - preserve case
201 - short preserve case
202 - mangling char
203 - hide dot files
204 - hide special files
205 - hide unreadable
206 - hide unwriteable files
207 - delete veto files
208 - veto files
209 - hide files
210 - veto oplock files
211 - map readonly
212 - mangled names
213 - mangled map
214 - max stat cache size
215 - stat cache
216 - store dos attributes
217 - machine password timeout
218 - add user script
219 - rename user script
220 - delete user script
221 - add group script
222 - delete group script
223 - add user to group script
224 - delete user from group script
225 - set primary group script
226 - add machine script
227 - shutdown script
228 - abort shutdown script
229 - username map script
230 - logon script
231 - logon path
232 - logon drive
233 - logon home
234 - domain logons
235 - os level
236 - lm announce
237 - lm interval
238 - domain master
239 - browse list
240 - enhanced browsing
241 - wins proxy
242 - wins hook
243 - wins partners
244 - blocking locks
245 - fake oplocks
246 - kernel oplocks
247 - locking
248 - lock spin count
249 - lock spin time
250 - level2 oplocks
251 - oplock break wait time
252 - oplock contention limit
253 - posix locking
254 - share modes
255 - ldap server
256 - ldap port
257 - ldap admin dn
258 - ldap delete dn
259 - ldap group suffix
260 - ldap idmap suffix
261 - ldap machine suffix
262 - ldap passwd sync
263 - ldap password sync
264 - ldap replication sleep
265 - ldap suffix
266 - ldap ssl
267 - ldap timeout
268 - ldap page size
269 - ldap user suffix
270 - add share command
271 - change share command
272 - delete share command
273 - eventlog list
274 - utmp directory
275 - wtmp directory
276 - utmp
277 - default service
278 - default
279 - message command
280 - dfree cache time
281 - dfree command
282 - get quota command
283 - set quota command
284 - remote announce
285 - remote browse sync
286 - homedir map
287 - afs username map
288 - afs token lifetime
289 - log nt token command
290 - time offset
291 - NIS homedir
292 - preexec
293 - exec
294 - preexec close
295 - postexec
296 - root preexec
297 - root preexec close
298 - root postexec
299 - set directory
300 - wide links
301 - follow symlinks
302 - dont descend
303 - magic script
304 - magic output
305 - delete readonly
306 - dos filemode
307 - dos filetimes
308 - dos filetime resolution
309 - fake directory create times
310 - panic action
311 - vfs objects
312 - vfs object
313 - msdfs root
314 - msdfs proxy
315 - host msdfs
316 - enable rid algorithm
317 - passdb expand explicit
318 - idmap backend
319 - idmap uid
320 - winbind uid
321 - idmap gid
322 - winbind gid
323 - template homedir
324 - template shell
325 - winbind separator
326 - winbind cache time
327 - winbind enum users
328 - winbind enum groups
329 - winbind use default domain
330 - winbind trusted domains only
331 - winbind nested groups
332 - winbind max idle children
333 - winbind nss info
335 The following parameters have been added:
336 + rpc big endian (G)
337         Make Samba fake it is running on a bigendian machine when using DCE/RPC. 
338         Useful for debugging.
340         Default: no
342 + case insensitive filesystem (S)
343         Set to true if this share is located on a case-insensitive filesystem.
344         This disables looking for a filename by trying all possible combinations of 
345         uppercase/lowercase characters and thus speeds up operations when a 
346         file cannot be found. 
348         Default: no
349         
350 + setup directory
351         Path to data used by provisioning script.
353         Default: Set at compile-time
354         
355 + ncalrpc dir
356         Directory to use for UNIX sockets used by the 'ncalrpc' DCE/RPC transport.
358         Default: Set at compile-time
359         
360 + ntvfs handler
361         Backend to the NT VFS to use (more than one can be specified). Available
362         backends include: 
363         
364         - posix:
365                 Maps POSIX FS semantics to NT semantics
367         - simple:
368                 Very simple backend (original testing backend).
370         - unixuid:
371                 Sets up user credentials based on POSIX gid/uid.
373         - cifs:
374                 Proxies a remote CIFS FS. Mainly useful for testing.
376         - nbench:
377                 Filter module that saves data useful to the nbench benchmark suite.
379         - ipc:
380                 Allows using SMB for inter process communication. Only used for 
381                 the IPC$ share.
383         - print:
384                 Allows printing over SMB. This is LANMAN-style printing (?), not 
385                 the be confused with the spoolss DCE/RPC interface used by later 
386                 versions of Windows.
387         
388         Default: unixuid default
390 + ntptr providor
391         FIXME
393 + dcerpc endpoint servers
394         What DCE/RPC servers to start.
396         Default: epmapper srvsvc wkssvc rpcecho samr netlogon lsarpc spoolss drsuapi winreg dssetup
398 + server services
399         Services Samba should provide.
401         Default: smb rpc nbt wrepl ldap cldap web kdc
403 + spoolss database
404         Spoolss (printer) DCE/RPC server database. This should be a LDB URL.
406         Default: set at compile-time
408 + wins config database
409         WINS configuration database location. This should be a LDB URL.
411         Default: set at compile-time
412         
413 + wins database
414         WINS database location. This should be a LDB URL.
416         Default: set at compile-time
417         
418 + client use spnego principal
419         Tells the client to use the Kerberos service principal specified by the 
420         server during the security protocol negotation rather than 
421         looking up the principal itself (cifs/hostname).
423         Default: false
425 + nbt port
426         TCP/IP Port used by the NetBIOS over TCP/IP (NBT) implementation.
428         Default: 137
430 + dgram port
431         UDP/IP port used by the NetBIOS over TCP/IP (NBT) implementation.
432         
433         Default: 138
435 + cldap port
436         UDP/IP port used by the CLDAP protocol.
438         Default: 389
440 + krb5 port
441         IP port used by the kerberos KDC.       
442         
443         Default: 88
444         
445 + kpasswd port
446         IP port used by the kerberos password change protocol.
448         Default: 464
449         
450 + web port
451         TCP/IP port SWAT should listen on.
453         Default: 901
455 + tls enabled
456         Enable TLS support for SWAT
457         
458         Default: true
459         
460 + tls keyfile
461         Path to TLS key file (PEM format) to be used by SWAT. If no 
462         path is specified, Samba will create a key.
464         Default: none
466 + tls certfile
467         Path to TLS certificate file (PEM format) to be used by SWAT. If no 
468         path is specified, Samba will create a certificate.
470         Default: none
471         
472 + tls cafile
473         Path to CA authority file Samba will use to sign TLS keys it generates. If 
474         no path is specified, Samba will create a self-signed CA certificate.
476         Default: none
478 + tls crlfile
479         Path to TLS certificate revocation lists file.
481         Default: none
483 + swat directory
484         SWAT data directory.
486         Default: set at compile-time
488 + large readwrite
489         Indicate the CIFS server is able to do large reads/writes.
491         Default: true
492         
493 + unicode
494         Enable/disable unicode support in the protocol.
496         Default: true