Add the primary nonlocal gid to local users in MAGIC_NONLOCAL_GROUPNAME

[nss_nonlocal.git] / README

diff --git a/README b/README
index 1e0d6b2ecab81abc6ef776fa4c0ca66be47b20df..6dc464b02ff67a569f791895af36a1c7265396d0 100644 (file)
--- a/README
+++ b/README
@@ -9,6 +9,17 @@ passwd_nonlocal: hesiod
 group:          compat nonlocal
 group_nonlocal: hesiod
 
+The module also assigns special properties to two local groups, if
+they exist:
+
+• If the local group ‘nss-nonlocal-users’ exists, then nonlocal users
+  will be automatically added to it.  Furthermore, if a local user is
+  added to this group, then that user will inherit any nonlocal gids
+  from a nonlocal user of the same name, as supplementary gids.
+
+• If the local group ‘nss-local-users’ exists, then local users will
+  be automatically added to it.
+
 Copyright © 2007–2010 Anders Kaseorg <andersk@mit.edu> and Tim Abbott
 <tabbott@mit.edu>