summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/base/comment.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/base/comment.xml')
-rw-r--r--docs-xml/smbdotconf/base/comment.xml18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/base/comment.xml b/docs-xml/smbdotconf/base/comment.xml
new file mode 100644
index 0000000..c5aba83
--- /dev/null
+++ b/docs-xml/smbdotconf/base/comment.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="comment"
+ context="S"
+ type="string"
+ substitution="1"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This is a text field that is seen next to a share
+ when a client does a queries the server, either via the network
+ neighborhood or via <command moreinfo="none">net view</command> to list what shares
+ are available.</para>
+
+ <para>If you want to set the string that is displayed next to the
+ machine name then see the <smbconfoption name="server string"/> parameter.</para>
+
+</description>
+<value type="default"><comment>No comment</comment></value>
+<value type="example">Fred's Files</value>
+</samba:parameter>