summaryrefslogtreecommitdiff
path: root/docs-xml
diff options
context:
space:
mode:
authorMichael Adam <obnox@samba.org>2008-07-10 13:46:25 +0200
committerKarolin Seeger <kseeger@samba.org>2008-07-16 08:42:12 +0200
commit5c0ecab1e80d4cbb0c1dfa7bd888dd91e93c21ab (patch)
tree536c95e442aba9ef1754119891ac68e1c0152443 /docs-xml
parent7ae9f594d962ea39d233b6024f3ef3ebcaf73581 (diff)
downloadsamba-5c0ecab1e80d4cbb0c1dfa7bd888dd91e93c21ab.tar.gz
docs: update the section about net conf in the net(8) manpage.
The description of the "net conf {get,set,del}includes" commands was missing. Michael (cherry picked from commit 671988c7b5891deeca23e2305fe101a3be1a44d2) (cherry picked from commit baae7347e94b1b849e80d8da323afc179523430a)
Diffstat (limited to 'docs-xml')
-rw-r--r--docs-xml/manpages-3/net.8.xml42
1 files changed, 41 insertions, 1 deletions
diff --git a/docs-xml/manpages-3/net.8.xml b/docs-xml/manpages-3/net.8.xml
index 9e2558eb322..f3ee6b5bd8a 100644
--- a/docs-xml/manpages-3/net.8.xml
+++ b/docs-xml/manpages-3/net.8.xml
@@ -1409,6 +1409,9 @@ registry.</member>
<member>net conf setparm - Store a parameter.</member>
<member>net conf getparm - Retrieve the value of a parameter.</member>
<member>net conf delparm - Delete a parameter.</member>
+<member>net conf getincludes - Show the includes of a share definition.</member>
+<member>net conf setincludes - Set includes for a share.</member>
+<member>net conf delincludes - Delete includes from a share definition.</member>
</simplelist>
</para>
@@ -1509,9 +1512,46 @@ Delete a parameter stored in registry.
</refsect3>
<refsect3>
-<title></title>
+<title>CONF GETINCLUDES <replaceable>section</replaceable></title>
<para>
+Get the list of includes for the provided section (global or share).
+</para>
+
+<para>
+Note that due to the nature of the registry database and the nature of include directives,
+the includes need special treatment: Parameters are stored in registry by the parameter
+name as valuename, so there is only ever one instance of a parameter per share.
+Also, a specific order like in a text file is not guaranteed. For all real
+parameters, this is perfectly ok, but the include directive is rather a meta
+parameter, for which, in the smb.conf text file, the place where it is specified
+between the other parameters is very important. This can not be achieved by the
+simple registry smbconf data model, so there is one ordered list of includes
+per share, and this list is evaluated after all the parameters of the share.
+</para>
+
+<para>
+Further note that currently, only files can be included from registry
+configuration. In the future, there will be the ability to include configuration
+data from other registry keys.
+</para>
+</refsect3>
+
+<refsect3>
+<title>CONF SETINCLUDES <replaceable>section</replaceable> [<replaceable>filename</replaceable>]+</title>
+
+<para>
+Set the list of includes for the provided section (global or share) to the given
+list of one or more filenames. The filenames may contain the usual smb.conf
+macros like %I.
+</para>
+</refsect3>
+
+<refsect3>
+<title>CONF DELINCLUDES <replaceable>section</replaceable></title>
+
+<para>
+Delete the list of includes from the provided section (global or share).
</para>
</refsect3>