Add new framework for smb.conf(5). Please read README before trying to compile.
[Samba/gebeck_regimport.git] / docs / docbook / smbdotconf / logon / logonhome.xml
blobec19c54043c53667d9ee25214a0914997b7da8e1
1 <samba:parameter xmlns:samba="http://samba.org/common">
2                 <term><anchor id="LOGONHOME"/>logon home (G)</term>
3                 <listitem><para>This parameter specifies the home directory 
4                 location when a Win95/98 or NT Workstation logs into a Samba PDC.  
5                 It allows you to do </para>
6                 
7                 <para><prompt moreinfo="none">C:\&gt; </prompt><userinput moreinfo="none">NET USE H: /HOME</userinput>
8                 </para>
10                 <para>from a command prompt, for example.</para>
12                 <para>This option takes the standard substitutions, allowing 
13                 you to have separate logon scripts for each user or machine.</para>
15                 <para>This parameter can be used with Win9X workstations to ensure 
16                 that roaming profiles are stored in a subdirectory of the user's 
17                 home directory.  This is done in the following way:</para>
19                 <para><command moreinfo="none">logon home = \\%N\%U\profile</command></para>
21                 <para>This tells Samba to return the above string, with 
22                 substitutions made when a client requests the info, generally 
23                 in a NetUserGetInfo request.  Win9X clients truncate the info to
24                 \\server\share when a user does <command moreinfo="none">net use /home</command>
25                 but use the whole string when dealing with profiles.</para>
27                 <para>Note that in prior versions of Samba, the <link linkend="LOGONPATH">
28                 <parameter moreinfo="none">logon path</parameter></link> was returned rather than 
29                 <parameter moreinfo="none">logon home</parameter>.  This broke <command moreinfo="none">net use 
30                 /home</command> but allowed profiles outside the home directory.  
31                 The current implementation is correct, and can be used for 
32                 profiles if you use the above trick.</para>
33                 
34                 <para>This option is only useful if Samba is set up as a logon 
35                 server.</para>
37                 <para>Default: <command moreinfo="none">logon home = &quot;\\%N\%U&quot;</command></para>
38                 <para>Example: <command moreinfo="none">logon home = &quot;\\remote_smb_server\%U&quot;</command>
39                 </para></listitem>
40                 </samba:parameter>