From: Gerald Carter <jerry@samba.org>
Date: Wed, 21 Mar 2007 19:16:56 +0000 (+0000)
Subject: fill in the idmap_tdb man page
X-Git-Tag: samba-4.0.0alpha6~801^2~1801
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7def9e40b622a859c8f38e32854ffb384d0c2a8b;p=thirdparty%2Fsamba.git

fill in the idmap_tdb man page
(This used to be commit a8edd19522ae06ba42af6d356156bc8a9f7ee86f)
---

diff --git a/docs/manpages-3/idmap_tdb.8.xml b/docs/manpages-3/idmap_tdb.8.xml
new file mode 100644
index 00000000000..6a62906f81a
--- /dev/null
+++ b/docs/manpages-3/idmap_tdb.8.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="idmap_tdb.8">
+
+<refmeta>
+	<refentrytitle>idmap_tdb</refentrytitle>
+	<manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+	<refname>idmap_tdb</refname>
+	<refpurpose>Samba's idmap_tdb Backend for winbindd</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<title>DESCRIPTION</title>
+
+	<para>The idmap_tdb plugin is the default backend used by winbindd
+	for storing SID/uid/gid mapping tables and implements
+	both the &quot;idmap&quot; and &quot;idmap alloc&quot; APIs.
+	</para>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>IDMAP OPTIONS</title>
+
+	<variablelist>		
+                <varlistentry>
+		<term>range = low - high</term>
+                <listitem><para>
+			Defines the available matching uid and gid range for which the
+			backend is authoritative.  Note that the range commonly matches
+			the allocation range due to the fact that the same backend will
+			store and retreive SID/uid/gid mapping entries.  If the parameter 
+			is absent, Winbind fail over to use the &quot;idmap uid&quot; and 
+			&quot;idmap gid&quot; options from smb.conf.  
+                </para></listitem>
+                </varlistentry>
+	</variablelist>
+</refsect1>
+
+<refsect1>
+	<title>IDMAP ALLOC OPTIONS</title>
+
+	<variablelist>
+                <varlistentry>
+		<term>range = low - high</term>
+                <listitem><para>
+			Defines the available matching uid and gid range from which 
+			winbindd can allocate for users and groups.  If the parameter 
+			is absent, Winbind fail over to use the &quot;idmap uid&quot; 
+			and &quot;idmap gid&quot; options from smb.conf.
+                </para></listitem>
+                </varlistentry>
+	</variablelist>
+</refsect1>
+
+<refsect1>
+	<title>EXAMPLES</title>
+
+	<para>
+	The following example is equivalent to the pre-3.0.25 default idmap 
+	configuration using the &quot;idmap backend = tdb&quot; setting.
+	</para>
+
+	<programlisting>
+	[global]
+	    idmap domain = default
+
+	    idmap config default:backend = tdb
+	    idmap config default:default = yes
+	    idmap config default:range   = 10000 - 50000
+
+	    idmap alloc backend = tdb
+	    idmap alloc config:range = 10000 - 50000
+	</programlisting>
+</refsect1>
+
+<refsect1>
+	<title>AUTHOR</title>
+
+	<para>
+	The 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.
+	</para>	
+</refsect1>
+
+</refentry>