From 4287b412e99d33a0a5b4e2cc8a2ad3c937cdb266 Mon Sep 17 00:00:00 2001
From: Tim Potter <tpot@samba.org>
Date: Tue, 17 Oct 2000 02:28:24 +0000
Subject: Added documentation for winbind enum users and winbind enum groups
 configuration parameters. (This used to be commit
 c76dfab559003c9194f519cb89869d191cc0d6c0)

---
 docs/htmldocs/winbindd.8.html | 19 +++++++++++++++++++
 docs/manpages/winbindd.8      | 27 +++++++++++++++++++++++++++
 docs/yodldocs/winbindd.8.yo   | 27 +++++++++++++++++++++++++++
 3 files changed, 73 insertions(+)

(limited to 'docs')

diff --git a/docs/htmldocs/winbindd.8.html b/docs/htmldocs/winbindd.8.html
index d9e8017daa..0e0d70c2f4 100644
--- a/docs/htmldocs/winbindd.8.html
+++ b/docs/htmldocs/winbindd.8.html
@@ -149,6 +149,25 @@ database is not actively changing <strong>winbindd</strong> will only have to se
 sequence number query packet every "winbind cache time" seconds.
 <p><strong>Default:</strong>
 <code>     winbind cache time = 15</code>
+<p><p></p><dt><strong>winbind enum users</strong><dd>
+<p>On large installations it may be necessary to suppress the enumeration of
+users through the <code>setpwent</code>, <code>getpwent</code> and <code>endpwent</code> group of
+system calls.  If the <code>winbind enum users</code> parameter is false, calls to
+the <code>getpwent</code> system call will not return any data.
+<p>Warning: Turning off user enumeration may cause some programs to behave
+oddly.  For example, the finger program relies on having access to the full
+user list when searching for matching usernames.
+<p><strong>Default:</strong>
+<code>     winbind enum users = true</code>
+<p><p></p><dt><strong>winbind enum groups</strong><dd>
+<p>On large installations it may be necessary to suppress the enumeration of
+groups through the <code>setgrent</code>, <code>getgrent</code> and <code>endgrent</code> group of
+system calls.  If the <code>winbind enum groups</code> parameter is false, calls to
+the <code>getgrent</code> system call will not return any data.
+<p>Warning: Turning off group enumeration may cause some programs to behave
+oddly.
+<p><strong>Default:</strong>
+<code>     winbind enum groups = true</code>
 <p><p></p><dt><strong>template homedir</strong><dd>
 <p>When filling out the user information for a Windows NT user, the
 <strong>winbindd</strong> daemon uses this parameter to fill in the home directory for
diff --git a/docs/manpages/winbindd.8 b/docs/manpages/winbindd.8
index c2c890d0b8..9655f51bee 100644
--- a/docs/manpages/winbindd.8
+++ b/docs/manpages/winbindd.8
@@ -161,6 +161,33 @@ sequence number query packet every "winbind cache time" seconds\&.
 \fBDefault:\fP
 \f(CW     winbind cache time = 15\fP
 .IP 
+.IP "winbind enum users" 
+.IP 
+On large installations it may be necessary to suppress the enumeration of
+users through the \f(CWsetpwent\fP, \f(CWgetpwent\fP and \f(CWendpwent\fP group of
+system calls\&.  If the \f(CWwinbind enum users\fP parameter is false, calls to
+the \f(CWgetpwent\fP system call will not return any data\&.
+.IP 
+Warning: Turning off user enumeration may cause some programs to behave
+oddly\&.  For example, the finger program relies on having access to the full
+user list when searching for matching usernames\&.
+.IP 
+\fBDefault:\fP
+\f(CW     winbind enum users = true\fP
+.IP 
+.IP "winbind enum groups" 
+.IP 
+On large installations it may be necessary to suppress the enumeration of
+groups through the \f(CWsetgrent\fP, \f(CWgetgrent\fP and \f(CWendgrent\fP group of
+system calls\&.  If the \f(CWwinbind enum groups\fP parameter is false, calls to
+the \f(CWgetgrent\fP system call will not return any data\&.
+.IP 
+Warning: Turning off group enumeration may cause some programs to behave
+oddly\&.
+.IP 
+\fBDefault:\fP
+\f(CW     winbind enum groups = true\fP
+.IP 
 .IP "template homedir" 
 .IP 
 When filling out the user information for a Windows NT user, the
diff --git a/docs/yodldocs/winbindd.8.yo b/docs/yodldocs/winbindd.8.yo
index 41f566b4d2..a2128be393 100644
--- a/docs/yodldocs/winbindd.8.yo
+++ b/docs/yodldocs/winbindd.8.yo
@@ -168,6 +168,33 @@ sequence number query packet every "winbind cache time" seconds.
   bf(Default:)
 tt(     winbind cache time = 15)
 
+dit(winbind enum users)
+
+On large installations it may be necessary to suppress the enumeration of
+users through the tt(setpwent), tt(getpwent) and tt(endpwent) group of
+system calls.  If the tt(winbind enum users) parameter is false, calls to
+the tt(getpwent) system call will not return any data.
+
+Warning: Turning off user enumeration may cause some programs to behave
+oddly.  For example, the finger program relies on having access to the full
+user list when searching for matching usernames.
+
+  bf(Default:)
+tt(     winbind enum users = true)
+
+dit(winbind enum groups)
+
+On large installations it may be necessary to suppress the enumeration of
+groups through the tt(setgrent), tt(getgrent) and tt(endgrent) group of
+system calls.  If the tt(winbind enum groups) parameter is false, calls to
+the tt(getgrent) system call will not return any data.
+
+Warning: Turning off group enumeration may cause some programs to behave
+oddly.
+
+  bf(Default:)
+tt(     winbind enum groups = true)
+
 dit(template homedir)
 
 When filling out the user information for a Windows NT user, the
-- 
cgit