Next update of VFS modules development guide
[samba.git] / docs / smbdotconf / misc / utmp.xml
1 <samba:parameter name="utmp"
2                  context="G"
3                                  type="boolean"
4                  developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>
8         This boolean parameter is only available if Samba has been configured and compiled  
9         with the option <command moreinfo="none">--with-utmp</command>. If set to 
10          <constant>yes</constant> then Samba will attempt to add utmp or utmpx records 
11         (depending on the UNIX system) whenever a connection is made to a Samba server. 
12         Sites may use this to record the user connecting to a Samba share.
13         </para>
14
15         <para>
16         Due to the requirements of the utmp record, we  are required to create a unique 
17         identifier for the incoming user.  Enabling this option creates an n^2  algorithm 
18         to find this number.  This may impede performance on large installations. 
19         </para>
20 </description>
21
22 <related>utmp directory</related>
23
24 <value type="default">no</value>
25 </samba:parameter>