Doc/lib/libpwd.tex

   1 \section{\module{pwd} ---
   2          The password database}
   3
   4 \declaremodule{builtin}{pwd}
   5   \platform{Unix}
   6 \modulesynopsis{The password database (\function{getpwnam()} and friends).}
   7
   8 This module provides access to the \UNIX{} password database.
   9 It is available on all \UNIX{} versions.
  10
  11 Password database entries are reported as 7-tuples containing the
  12 following items from the password database (see \code{<pwd.h>}), in order:
  13 \code{pw_name},
  14 \code{pw_passwd},
  15 \code{pw_uid},
  16 \code{pw_gid},
  17 \code{pw_gecos},
  18 \code{pw_dir},
  19 \code{pw_shell}.
  20 The uid and gid items are integers, all others are strings.
  21 \exception{KeyError} is raised if the entry asked for cannot be found.
  22
  23 It defines the following items:
  24
  25 \begin{funcdesc}{getpwuid}{uid}
  26 Return the password database entry for the given numeric user ID.
  27 \end{funcdesc}
  28
  29 \begin{funcdesc}{getpwnam}{name}
  30 Return the password database entry for the given user name.
  31 \end{funcdesc}
  32
  33 \begin{funcdesc}{getpwall}{}
  34 Return a list of all available password database entries, in arbitrary order.
  35 \end{funcdesc}