docs: Bump version up to 4.0.
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_dirsort.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_dirsort.8">
4
5 <refmeta>
6         <refentrytitle>vfs_dirsort</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.0</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_dirsort</refname>
16         <refpurpose>Sort directory contents</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = dirsort</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>vfs_dirsort</command> module sorts directory
33         entries alphabetically before sending them to the client.</para>
34
35         <para>Please be aware that adding this module might have negative
36         performance implications for large directories.</para>
37
38 </refsect1>
39
40 <refsect1>
41         <title>EXAMPLES</title>
42
43         <para>Sort directories for all shares:</para>
44
45 <programlisting>
46         <smbconfsection name="[global]"/>
47         <smbconfoption name="vfs objects">dirsort</smbconfoption>
48 </programlisting>
49
50 </refsect1>
51
52 <refsect1>
53         <title>VERSION</title>
54
55         <para>This man page is correct for version 3.3 of the Samba suite.
56         </para>
57 </refsect1>
58
59 <refsect1>
60         <title>AUTHOR</title>
61
62         <para>The original Samba software and related utilities
63         were created by Andrew Tridgell. Samba is now developed
64         by the Samba Team as an Open Source project similar
65         to the way the Linux kernel is developed.</para>
66
67 </refsect1>
68
69 </refentry>