Samba3-HOWTO: mention NTDB.

Not sure if we're keeping this up-to-date, but try to document which
databases can be NTDB now.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Reviewed-by: Jeremy Allison <jra@samba.org>

1 files changed, 32 insertions, 27 deletions

diff --git a/docs-xml/Samba3-HOWTO/TOSHARG-TDBFiles.xml b/docs-xml/Samba3-HOWTO/TOSHARG-TDBFiles.xml
index 9bda64d275..19fe6813db 100644
--- a/docs-xml/Samba3-HOWTO/TOSHARG-TDBFiles.xml
+++ b/docs-xml/Samba3-HOWTO/TOSHARG-TDBFiles.xml
@@ -32,87 +32,92 @@
 	is at system shutdown (backup) and startup (restore from backup).
 	</para>
 
+<para>
+<indexterm><primary>NTDB</primary></indexterm>
+</para>
+	As of Samba 4.1, the NTDB format can be used if 'use ntdb' is set.  In this case, tdb files are automatically converted to ntdb files (with the .ntdb extension).  The old .tdb file is turned into a dangling symlink to 'This is now in an NTDB' to prevent it being accidentally used).  The table indicates what databases are currently available as NTDB files.
+
 <table frame="all" id="TOSH-TDB">
                 <title>Samba's Trivial Database Files</title>
                 <tgroup align="center" cols="2">
                 <thead>
-                <row><entry>File name</entry><entry>Preserve</entry><entry>Description</entry></row>
+                <row><entry>File name</entry><entry>Preserve</entry><entry>NTDB</entry><entry>Description</entry></row>
                 </thead>
 
                 <tbody>
-                        <row><entry>account_policy.tdb</entry><entry>Y</entry>
+                        <row><entry>account_policy.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>NT account policy settings such as pw expiration, etc...</para></entry></row>
-                        <row><entry>brlock.tdb</entry><entry>N</entry>
+                        <row><entry>brlock.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Byte range locks.</para></entry></row>
-                        <row><entry>browse.dat</entry><entry>N</entry>
+                        <row><entry>browse.dat</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Browse lists - gets rebuilt automatically.</para></entry></row>
-                        <row><entry>connections.tdb</entry><entry>N</entry>
+                        <row><entry>connections.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Share connections. Used to enforce max connections, etc.</para></entry></row>
-                        <row><entry>gencache.tdb</entry><entry>N</entry>
+                        <row><entry>gencache.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Generic caching database.</para></entry></row>
-                        <row><entry>group_mapping.tdb</entry><entry>Y</entry>
+                        <row><entry>group_mapping.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Stores group mapping information. Not used when using LDAP backend.</para></entry></row>
-                        <row><entry>  lang_en.tdb</entry><entry>Y</entry>
+                        <row><entry>  lang_en.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Stores language encoding information.</para></entry></row>
-                        <row><entry>locking.tdb</entry><entry>N</entry>
+                        <row><entry>locking.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Stores share mode and oplock information.</para></entry></row>
-                        <row><entry>login_cache.tdb</entry><entry>N</entry>
+                        <row><entry>login_cache.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Keeps a log of bad pw attempts.</para></entry></row>
-                        <row><entry>messages.tdb</entry><entry>N</entry>
+                        <row><entry>messages.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Used to keep track of Samba internal messaging.</para></entry></row>
-                        <row><entry>netsamlogon_cache.tdb</entry><entry>Y</entry>
+                        <row><entry>netsamlogon_cache.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>
 					Cache of user net_info_3 struct from <emphasis>net_samlogon()</emphasis>
 					requests from domain member machines.
 				</para></entry></row>
-                        <row><entry>ntdrivers.tdb</entry><entry>Y</entry>
+                        <row><entry>ntdrivers.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Stores installed printer driver information.</para></entry></row>
-                        <row><entry>ntforms.tdb</entry><entry>Y</entry>
+                        <row><entry>ntforms.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Stores installed printer forms information.</para></entry></row>
-                        <row><entry>ntprinters.tdb</entry><entry>Y</entry>
+                        <row><entry>ntprinters.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Stores installed printers information.</para></entry></row>
-                        <row><entry>printing directory</entry><entry>Y</entry>
+                        <row><entry>printing directory</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Directory containing tdb per print queue of cached lpq output.</para></entry></row>
-                        <row><entry>registry.tdb</entry><entry>Y</entry>
+                        <row><entry>registry.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Windows registry skeleton (connect via regedit.exe).</para></entry></row>
-                        <row><entry>sessionid.tdb</entry><entry>N</entry>
+                        <row><entry>sessionid.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Session information to support <literal>utmp = yes</literal> capabilities.</para></entry></row>
-                        <row><entry>share_info.tdb</entry><entry>Y</entry>
+                        <row><entry>share_info.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Stores share-level ACL configuration settings.
 					Default ACL is <emphasis>Everyone - Full Control</emphasis>.
 				</para></entry></row>
-                        <row><entry>unexpected.tdb</entry><entry>N</entry>
+                        <row><entry>unexpected.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>
 					Unexpected packet queue needed to support windows clients that respond on a 
 					different port that the originating reques.
 				</para></entry></row>
-                        <row><entry>winbindd_cache.tdb</entry><entry>N</entry>
+                        <row><entry>winbindd_cache.tdb</entry><entry>N</entry><entry>N</entry>
 				<entry><para>Winbind's cache of user lists.</para></entry></row>
-                        <row><entry>winbindd_idmap.tdb</entry><entry>Y</entry>
+                        <row><entry>winbindd_idmap.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>Winbind's local IDMAP database.</para></entry></row>
-                        <row><entry>wins.dat</entry><entry>N</entry>
+                        <row><entry>wins.dat</entry><entry>N</entry><entry>N</entry>
 				<entry><para>
 				WINS database iused only when <parameter>wins support = yes</parameter>
 				has been set. This gets rebuilt or updated at every restart.
 				</para></entry></row>
-                        <row><entry>wins.tdb</entry><entry>Y</entry>
+                        <row><entry>wins.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>
 				The working permanent storage for all WINS data. This database is used only
 				when <parameter>wins support = yes</parameter> has been set in the &smb.conf; file.
 				Note: This retains all manually configured WINS entries. Manual setting can be done use the net utility.
 				</para></entry></row>
-                        <row><entry>secrets.tdb</entry><entry>Y</entry>
+                        <row><entry>secrets.tdb</entry><entry>Y</entry><entry>Y</entry>
 				<entry><para>
 				This tdb file stores internal settings such as the machine and the domain SID, secret passwords
 				that are used with LDAP, the machine secret token, etc. This is an essential file that is stored
 				in a secure area. Vendors locate this in various folders. Check <command>smbd -b</command> to
 				find its location on your system.
 				</para></entry></row>
-                        <row><entry>schannel_store.tdb</entry><entry>Y</entry>
+                        <row><entry>schannel_store.tdb</entry><entry>Y</entry><entry>Y</entry>
 				<entry><para>
 				This stores secure channel access token information used with SMB signing.
 				</para></entry></row>
-                        <row><entry>passdb.tdb</entry><entry>Y</entry>
+                        <row><entry>passdb.tdb</entry><entry>Y</entry><entry>N</entry>
 				<entry><para>
 				This stores the Samba SAM account information when using a tdbsam password backend.
 				</para></entry></row>