summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Allison <jra@samba.org>2006-05-08 23:21:03 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:18 -0500
commit22cb3cb2830a0f72ba76f0a02f30131dce78fcb0 (patch)
treedf574fae7338b8205143ac80e4cfc1be0439d1ef
parent16d36acb00e4e188495aab549b3ff3fe1f858ec4 (diff)
downloadsamba-22cb3cb2830a0f72ba76f0a02f30131dce78fcb0.tar.gz
samba-22cb3cb2830a0f72ba76f0a02f30131dce78fcb0.tar.bz2
samba-22cb3cb2830a0f72ba76f0a02f30131dce78fcb0.zip
Add section describing usershares. Let me know if the
XML here is not valid (or looks bad). Jeremy. (This used to be commit 60e57ae84bc68d740fe18ffd018f46af0fb01cb6)
-rw-r--r--docs/manpages-3/smb.conf.5.xml88
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/manpages-3/smb.conf.5.xml b/docs/manpages-3/smb.conf.5.xml
index b9e092bf57..5376b74c23 100644
--- a/docs/manpages-3/smb.conf.5.xml
+++ b/docs/manpages-3/smb.conf.5.xml
@@ -295,6 +295,94 @@ alias|alias|alias|alias...
</refsect1>
<refsect1>
+ <title>USERSHARES</title>
+
+ <para>Starting with Samba version 3.0.23 the capability for non-root users to add, modify, and delete
+ their own share definitions has been added. This capability is called <emphasis>usershares</emphasis> and
+ is controlled by a set of parameters in the <literal>[global]</literal> section of the smb.conf.
+ The relevent parameters are :
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>usershare allow guests</term>
+ <listitem><para>Controls if usershares can permit guest access.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usershare max shares</term>
+ <listitem><para>Maximum number of user defined shares allowed.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usershare owner only</term>
+ <listitem><para>If set only directories owned by the sharing user can be shared.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usershare path</term>
+ <listitem><para>Points to the directory containing the user defined share definitions.
+ The filesystem permissions on this directory control who can create user defined shares.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usershare prefix allow list</term>
+ <listitem><para>Comma-separated list of abolute pathnames restricting what directories
+ can be shared. Only directories below the pathnames in this list are permitted.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usershare prefix deny list</term>
+ <listitem><para>Comma-separated list of abolute pathnames restricting what directories
+ can be shared. Directories below the pathnames in this list are prohibited.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usershare template share</term>
+ <listitem><para>Names a pre-existing share used as a template for creating new usershares.
+ All other share parameters not specified in the user defined share definition
+ are copied from this named share.</para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>To allow members of the UNIX group <literal>foo</literal> to create user defined
+ shares, create the directory to contain the share definitions as follows:
+ </para>
+ <para>Become root:</para>
+ <programlisting>
+ mkdir /usr/local/samba/lib/usershares
+ chgrp foo /usr/local/samba/lib/usershares
+ chmod 1770 /usr/local/samba/lib/usershares
+ </programlisting>
+ <para>Then add the parameters <literal>usershare path = /usr/local/samba/lib/usershares</literal>,
+ <literal>usershare max shares = 10</literal> (or the desired number of shares) to the global
+ section of your smb.conf. Members of the group foo may then manipulate the user defined shares
+ using the following commands.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]</term>
+ <listitem><para>To create or modify (overwrite) a user defined share.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>net usershare delete sharename</term>
+ <listitem><para>To delete a user defined share.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>net usershare list wildcard-sharename</term>
+ <listitem><para>To list user defined shares.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>net usershare info wildcard-sharename</term>
+ <listitem><para>To print information about user defined shares.</para></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
+
+<refsect1>
<title>PARAMETERS</title>
<para>Parameters define the specific attributes of sections.</para>