Next update of VFS modules development guide
[sfrench/samba-autobuild/.git] / docs-xml / smbdotconf / misc / homedirmap.xml
1 <samba:parameter name="homedir map"
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         If <smbconfoption name="nis homedir"/> is <constant>yes</constant>, and <citerefentry><refentrytitle>smbd</refentrytitle>
9         <manvolnum>8</manvolnum></citerefentry> is also acting  as a Win95/98 <parameter moreinfo="none">logon server</parameter> 
10         then this parameter specifies the NIS (or YP) map from which the server for the user's  home directory should be extracted.  
11         At present, only the Sun auto.home map format is understood. The form of the map is:
12 <programlisting>
13 <command moreinfo="none">username server:/some/file/system</command>
14 </programlisting>
15         and the program will extract the servername from before the first ':'.  There should probably be a better parsing system 
16         that copes with different map formats and also Amd (another automounter) maps.
17         </para>
18                 
19         <note><para>
20         A working NIS client is required on the system for this option to work.
21         </para></note>
22 </description>
23 <related>nis homedir</related>
24 <related>domain logons</related>
25
26 <value type="default"></value>
27 <value type="example">amd.homedir</value>
28 </samba:parameter>