docs-xml/smbdotconf/logon/logonhome.xml

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