docs: Update doc to use absolute path for 'dedicated keytab file'
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_fileid.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="vfs_fileid.8">
4
5 <refmeta>
6         <refentrytitle>vfs_fileid</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>vfs_fileid</refname>
16         <refpurpose>Generates file_id structs with unique device id values for
17         cluster setups</refpurpose>
18 </refnamediv>
19
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>vfs objects = fileid</command>
23         </cmdsynopsis>
24 </refsynopsisdiv>
25
26 <refsect1>
27         <title>DESCRIPTION</title>
28
29         <para>This VFS module is part of the
30         <citerefentry><refentrytitle>samba</refentrytitle>
31         <manvolnum>7</manvolnum></citerefentry>
32         suite.</para>
33
34         <para>Samba uses file_id structs to uniquely identify files
35         for locking purpose. By default the file_id contains the device
36         and inode number returned by the <command>stat()</command> system call.
37         As the file_id is a unique identifier of a file, it must be the same
38         on all nodes in a cluster setup. This module overloads the
39         <command>SMB_VFS_FILE_ID_CREATE()</command> operation and
40         generates the device number based on the configured algorithm
41         (see the "fileid:algorithm" option).
42         </para>
43 </refsect1>
44
45
46 <refsect1>
47         <title>OPTIONS</title>
48
49         <variablelist>
50
51                 <varlistentry>
52                 <term>fileid:algorithm = ALGORITHM</term>
53                 <listitem>
54                 <para>Available algorithms are <command>fsname</command>
55                 and <command>fsid</command>. The default value is
56                 <command>fsname</command>.
57                 </para>
58                 <para>The <command>fsname</command> algorithm generates
59                 device id by hashing the kernel device name.
60                 </para>
61                 <para>The <command>fsid</command> algorithm generates
62                 the device id from the <command>f_fsid</command> returned
63                 from the <command>statfs()</command> syscall.
64                 </para>
65                 </listitem>
66                 </varlistentry>
67
68                 <varlistentry>
69                 <term>fileid:mapping = ALGORITHM</term>
70                 <listitem>
71                 <para>This option is the legacy version of the
72                 <command>fileid:algorithm</command> option, which was used in earlier
73                 versions of fileid mapping feature in custom Samba 3.0 versions.
74                 </para>
75                 </listitem>
76                 </varlistentry>
77
78         </variablelist>
79 </refsect1>
80
81 <refsect1>
82         <title>EXAMPLES</title>
83
84         <para>Usage of the <command>fileid</command> module with the
85         <command>fsid</command> algorithm:</para>
86
87 <programlisting>
88         <smbconfsection name="[global]"/>
89         <smbconfoption name="vfs objects">fileid</smbconfoption>
90         <smbconfoption name="fileid:algorithm">fsid</smbconfoption>
91 </programlisting>
92
93 </refsect1>
94
95 <refsect1>
96         <title>VERSION</title>
97
98         <para>This man page is correct for version 3.2 of the Samba suite.
99         </para>
100 </refsect1>
101
102 <refsect1>
103         <title>AUTHOR</title>
104
105         <para>The original Samba software and related utilities
106         were created by Andrew Tridgell. Samba is now developed
107         by the Samba Team as an Open Source project similar
108         to the way the Linux kernel is developed.</para>
109
110 </refsect1>
111
112 </refentry>