Merge branch 'master' of ctdb into 'master' of samba
[samba.git] / docs-xml / smbdotconf / misc / nishomedir.xml
1 <samba:parameter name="NIS homedir"
2                  context="G"
3                          type="boolean"
4                  advanced="1" developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>Get the home share server from a NIS map. For 
8         UNIX systems that use an automounter, the user's home directory 
9         will often be mounted on a workstation on demand from a remote 
10         server. </para>
11
12         <para>When the Samba logon server is not the actual home directory 
13         server, but is mounting the home directories via NFS then two 
14         network hops would be required to access the users home directory 
15         if the logon server told the client to use itself as the SMB server 
16         for home directories (one over SMB and one over NFS). This can 
17         be very slow.</para>
18
19         <para>This option allows Samba to return the home share as 
20         being on a different server to the logon server and as 
21         long as a Samba daemon is running on the home directory server, 
22         it will be mounted on the Samba client directly from the directory 
23         server. When Samba is returning the home share to the client, it 
24         will consult the NIS map specified in
25         <smbconfoption name="homedir map"/> and return the server 
26         listed there.</para>
27
28         <para>Note that for this option to work there must be a working 
29         NIS system and the Samba server with this option must also 
30         be a logon server.</para>
31 </description>
32 <value type="default">no</value>
33 </samba:parameter>