Doc/lib/libgrp.tex

   1 \section{\module{grp} ---
   2          The group database}
   3
   4 \declaremodule{builtin}{grp}
   5   \platform{Unix}
   6 \modulesynopsis{The group database (\function{getgrnam()} and friends).}
   7
   8
   9 This module provides access to the \UNIX{} group database.
  10 It is available on all \UNIX{} versions.
  11
  12 Group database entries are reported as 4-tuples containing the
  13 following items from the group database (see \code{<grp.h>}), in order:
  14 \code{gr_name},
  15 \code{gr_passwd},
  16 \code{gr_gid},
  17 \code{gr_mem}.
  18 The gid is an integer, name and password are strings, and the member
  19 list is a list of strings.
  20 (Note that most users are not explicitly listed as members of the
  21 group they are in according to the password database.)
  22 \exception{KeyError} is raised if the entry asked for cannot be found.
  23
  24 It defines the following items:
  25
  26 \begin{funcdesc}{getgrgid}{gid}
  27 Return the group database entry for the given numeric group ID.
  28 \end{funcdesc}
  29
  30 \begin{funcdesc}{getgrnam}{name}
  31 Return the group database entry for the given group name.
  32 \end{funcdesc}
  33
  34 \begin{funcdesc}{getgrall}{}
  35 Return a list of all available group entries, in arbitrary order.
  36 \end{funcdesc}