docs-xml/smbdotconf/logon/logonhome.xml

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