Another fixup.
[Samba.git] / docs / smbdotconf / logon / logonpath.xml
blobab87c77bb9b99aa7136c07c9c8beac3f7623143c
1 <samba:parameter name="logon path"
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>This parameter specifies the home directory 
8         where roaming profiles (NTuser.dat etc files for Windows NT) are 
9         stored.  Contrary to previous versions of these manual pages, it has 
10         nothing to do with Win 9X roaming profiles.  To find out how to 
11         handle roaming profiles for Win 9X system, see the <link linkend="LOGONHOME">
12         <parameter moreinfo="none">logon home</parameter></link> parameter.</para>
14         <para>This option takes the standard substitutions, allowing you 
15         to have separate logon scripts for each user or machine.  It also 
16         specifies the directory from which the &quot;Application Data&quot;, 
17         (<filename moreinfo="none">desktop</filename>, <filename moreinfo="none">start menu</filename>,
18         <filename moreinfo="none">network neighborhood</filename>, <filename moreinfo="none">programs</filename> 
19         and other folders, and their contents, are loaded and displayed on 
20         your Windows NT client.</para>
22         <para>The share and the path must be readable by the user for 
23         the preferences and directories to be loaded onto the Windows NT
24         client. The share must be writeable when the user logs in for the first
25         time, in order that the Windows NT client can create the NTuser.dat
26         and other directories.</para>
28         <para>Thereafter, the directories and any of the contents can, 
29         if required, be made read-only.  It is not advisable that the 
30         NTuser.dat file be made read-only - rename it to NTuser.man to 
31         achieve the desired effect (a <emphasis>MAN</emphasis>datory 
32         profile). </para>
34         <para>Windows clients can sometimes maintain a connection to 
35         the [homes] share, even though there is no user logged in.  
36         Therefore, it is vital that the logon path does not include a 
37         reference to the homes share (i.e. setting this parameter to
38         \%N\%U\profile_path will cause problems).</para>
40         <para>This option takes the standard substitutions, allowing 
41         you to have separate logon scripts for each user or machine.</para>
43         <warning>
44         <para>
45         Do not quote the value. Setting this as <quote>\\%N\profile\%U</quote>
46                 will break profile handling. Where the tdbsam or ldapsam passdb backend
47                 is used, at the time the user account is created the value configured
48                 for this parameter is written to the passdb backend and that value will
49                 over-ride the parameter value present in the smb.conf file. Any error
50                 present in the passdb backend account record must be editted using the
51                 appropriate tool (pdbedit on the command-line, or any other locally
52                 provided system tool.
53                 </para>
54         </warning>
56         <para>Note that this option is only useful if Samba is set up 
57         as a logon server.</para>
59         <para>
60         An example of use is:
61 <screen>
62 logon path = \\PROFILESERVER\PROFILE\%U
63 </screen>
64         </para>
65 </description>
66 <value type="default">\\%N\%U\profile</value>
67 </samba:parameter>