docs/docbook/smbdotconf/base/comment.xml

   1 <samba:parameter name="comment"
   2                  context="S"
   3                  basic="1" advanced="1" share="1" print="1" developer="1"
   4                  xmlns:samba="http://samba.org/common">
   5 <listitem>
   6         <para>This is a text field that is seen next to a share
   7         when a client does a queries the server, either via the network
   8         neighborhood or via <command moreinfo="none">net view</command> to list what shares
   9         are available.</para>
  10
  11         <para>If you want to set the string that is displayed next to the
  12         machine name then see the <link linkend="SERVERSTRING"><parameter moreinfo="none">
  13         server string</parameter></link> parameter.</para>
  14
  15         <para>Default: <emphasis>No comment string</emphasis></para>
  16         <para>Example: <command moreinfo="none">comment = Fred's Files</command></para>
  17 </listitem>
  18 </samba:parameter>