docs: Bump version up to 4.6.
[sfrench/samba-autobuild/.git] / docs-xml / manpages / idmap_tdb.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="idmap_tdb.8">
4
5 <refmeta>
6         <refentrytitle>idmap_tdb</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>idmap_tdb</refname>
16         <refpurpose>Samba's idmap_tdb Backend for Winbind</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <title>DESCRIPTION</title>
21
22         <para>
23         The idmap_tdb plugin is the default backend used by winbindd
24         for storing SID/uid/gid mapping tables.
25         </para>
26
27         <para>
28         In contrast to read only backends like idmap_rid, it is an allocating
29         backend: This means that it needs to allocate new user and group IDs in
30         order to create new mappings.
31         </para>
32 </refsynopsisdiv>
33
34 <refsect1>
35         <title>IDMAP OPTIONS</title>
36
37         <variablelist>
38                 <varlistentry>
39                 <term>range = low - high</term>
40                 <listitem><para>
41                         Defines the available matching uid and gid range for which the
42                         backend is authoritative.
43                 </para></listitem>
44                 </varlistentry>
45         </variablelist>
46 </refsect1>
47
48 <refsect1>
49         <title>EXAMPLES</title>
50
51         <para>
52         This example shows how tdb is used as a the default idmap backend.
53         This configured range is used for uid and gid allocation.
54         </para>
55
56         <programlisting>
57         [global]
58         # "backend = tdb" is redundant here since it is the default
59         idmap config * : backend = tdb
60         idmap config * : range = 1000000-2000000
61         </programlisting>
62 </refsect1>
63
64 <refsect1>
65         <title>AUTHOR</title>
66
67         <para>
68         The original Samba software and related utilities
69         were created by Andrew Tridgell. Samba is now developed
70         by the Samba Team as an Open Source project similar
71         to the way the Linux kernel is developed.
72         </para>
73 </refsect1>
74
75 </refentry>