Add usershare prefix allow/deny list docs.
[Samba.git] / docs / smbdotconf / misc / usershareprefixdenylist.xml
blob75d4ba9afc1aa77565d67c19149f993026916c70
1 <samba:parameter name="usershare prefix deny list"
2                  context="G"
3                  basic="1" advanced="1"
4                  type="string"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>This parameter specifies a list of absolute pathnames
8         the root of which are NOT allowed to be exported by user defined share definitions.
9         If the pathname exported starts with one of the strings in this
10         list the user defined share will not be allowed. Any pathname not
11         starting with one of these strings will be allowed to be exported
12         as a usershare. This allows the Samba administrator to restrict the
13         directories on the system that can be exported by user defined shares.
14         </para>
15         <para>
16         If there is a "usershare prefix deny list" and also a
17         "usershare prefix allow list" the deny list is processed
18         first, followed by the allow list, thus leading to the most
19         restrictive interpretation.
20         </para>
22 </description>
23 <value type="default">NULL</value>
24 <value type="example">/etc /dev /private</value>
25 </samba:parameter>