Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[kai/samba.git] / docs-xml / smbdotconf / base / comment.xml
1 <samba:parameter name="comment"
2                  context="S"
3                                  type="string"
4                  basic="1" advanced="1" share="1" print="1" developer="1" 
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7     <para>This is a text field that is seen next to a share 
8         when a client does a queries the server, either via the network 
9         neighborhood or via <command moreinfo="none">net view</command> to list what shares 
10         are available.</para>
11
12         <para>If you want to set the string that is displayed next to the 
13                 machine name then see the <smbconfoption name="server string"/> parameter.</para>
14
15 </description>
16 <value type="default"><comment>No comment</comment></value>
17 <value type="example">Fred's Files</value>
18 </samba:parameter>