summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/base/comment.xml
blob: 693268a0b0fe7f1c4d061365c9c0e456dd5b563e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<samba:parameter xmlns:samba="http://samba.org/common">
		<term><anchor id="COMMENT"/>comment (S)</term>
		<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>