summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/base/comment.xml
blob: f08d06ef255d51b073180f0fe8c6520a74e42a39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<samba:parameter name="comment"
                 context="S"
                 basic="1" advanced="1" share="1" print="1" developer="1" 
                 xmlns:samba="http://samba.org/common">
<listitem>
        <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 <link linkend="SERVERSTRING"><parameter moreinfo="none">
	server string</parameter></link> parameter.</para>

	<para>Default: <emphasis>No comment string</emphasis></para>
	<para>Example: <command moreinfo="none">comment = Fred's Files</command></para>
</listitem>
</samba:parameter>