docs-xml/smbdotconf/logon/logonhome.xml

   1 <samba:parameter name="logon home"
   2                  context="G"
   3                  type="string"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>
   7         This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC.
   8         It allows you to do
   9         </para>
  10
  11         <para>
  12         <prompt moreinfo="none">C:\&gt;</prompt><userinput moreinfo="none">NET USE H: /HOME</userinput>
  13         </para>
  14
  15         <para>
  16         from a command prompt, for example.
  17         </para>
  18
  19         <para>
  20         This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
  21         </para>
  22
  23         <para>
  24         This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a
  25         subdirectory of the user's      home directory.  This is done in the following way:
  26         </para>
  27
  28         <para>
  29         <command moreinfo="none">logon home = \\%N\%U\profile</command>
  30         </para>
  31
  32         <para>
  33         This tells Samba to return the above string, with substitutions made when a client requests the info, generally
  34         in a NetUserGetInfo request.  Win9X clients truncate the info to \\server\share when a user does
  35          <command moreinfo="none">net use /home</command> but use the whole string when dealing with profiles.
  36         </para>
  37
  38         <para>
  39         Note that in prior versions of Samba, the <smbconfoption name="logon path"/> was returned rather than
  40         <parameter moreinfo="none">logon home</parameter>.  This broke <command moreinfo="none">net use /home</command>
  41         but allowed profiles outside the home directory. The current implementation is correct, and can be used for
  42         profiles if you use the above trick.
  43         </para>
  44
  45         <para>
  46         Disable this feature by setting <smbconfoption name="logon home">""</smbconfoption> - using the empty string.
  47         </para>
  48
  49         <para>
  50         This option is only useful if Samba is set up as a logon server.
  51         </para>
  52 </description>
  53
  54 <value type="default">\\%N\%U</value>
  55 <value type="example">\\remote_smb_server\%U</value>
  56 </samba:parameter>