README

   1 Elogind User, Seat and Session Manager
   2
   3 Introduction
   4 ------------
   5
   6 Elogind is the systemd project's "logind", extracted out to be a
   7 standalone daemon.  It integrates with PAM to know the set of users
   8 that are logged in to a system and whether they are logged in
   9 graphically, on the console, or remotely.  Elogind exposes this
  10 information via the standard org.freedesktop.login1 D-Bus interface,
  11 as well as through the file system using systemd's standard
  12 /run/systemd layout.  Elogind also provides "libelogind", which is a
  13 subset of the facilities offered by "libsystemd".  There is a
  14 "libelogind.pc" pkg-config file as well.
  15
  16 All of the credit for elogind should go to the systemd developers.
  17 For more on systemd, see
  18 http://www.freedesktop.org/wiki/Software/systemd.  All of the blame
  19 should go to Andy Wingo, who extracted elogind from systemd.
  20
  21 Contributing
  22 ------------
  23
  24 Elogind was branched from systemd version 219, and preserves the git
  25 history of the systemd project.  The version of elogind is the
  26 upstream systemd version, followed by the patchlevel of elogind.  For
  27 example version 219.12 is the twelfth elogind release, which aims to
  28 provide a subset of the interfaces of systemd 219.
  29
  30 To contribute to elogind, fork the current source code from github:
  31
  32   https://github.com/andywingo/elogind
  33
  34 Send a pull request for the changes you like.
  35
  36 To chat about elogind:
  37
  38   #guix on irc.freenode.org
  39
  40 Finally, bug reports:
  41
  42   https://github.com/andywingo/elogind/issues
  43
  44 Why bother?
  45 -----------
  46
  47 Elogind has been developed for use in GuixSD, the OS distribution of
  48 GNU Guix.  See http://gnu.org/s/guix for more on Guix.  GuixSD uses a
  49 specific init manager (DMD), for reasons that are not relevant here,
  50 but still aims to eventually be a full-featured distribution that can
  51 run GNOME and other desktop environments.  However, to run GNOME these
  52 days means that you need to have support for the login1 D-Bus
  53 interface, which is currently only provided by systemd.  That is the
  54 origin of this project: to take the excellent logind functionality
  55 from systemd and provide it as a standalone package.
  56
  57 We like systemd.  We realize that there are people out there that hate
  58 it.  You're welcome to use elogind for whatever purpose you like --
  59 as-is, or as a jumping-off point for other things -- but please don't
  60 use it as part of some anti-systemd vendetta.  Systemd hackers are
  61 smart folks that are trying to solve interesting problems on the free
  62 desktop, and their large adoption is largely because they solve
  63 problems that users and developers of user-focused applications care
  64 about.  We are appreciative of their logind effort and think that
  65 everyone deserves to run it if they like, even if they use a different
  66 PID 1.
  67
  68 Differences relative to systemd
  69 -------------------------------
  70
  71 The pkg-config file is called libelogind, not libsystemd or
  72 libsystemd-logind.
  73
  74 The headers are in <elogind/...>, so like <elogind/sd-login.h> instead
  75 of <systemd/sd-login.h>.
  76
  77 Libelogind just implements login-related functionality.  It also
  78 provides the sd-bus API.
  79
  80 Unlike systemd, whose logind arranges to run user sessions in cgroups
  81 via RPC calls to systemd, in elogind there is no systemd so there are
  82 no cgroups.  This has a few implications:
  83
  84   * Elogind does not create "slices" for users.  Elogind will not
  85     record that users are associated with slices.
  86
  87   * Systemd's logind waits for all user jobs to stop before recording
  88     that a user's session has gone away.  Since we have no cgroups,
  89     elogind just removes the session directly when pam_elogind.so
  90     indicates the user has logged out.
  91
  92   * The /run/systemd/slices directory will always be empty.
  93
  94   * Support for lingering is not so great.
  95
  96 Elogind does not manage virtual terminals.
  97
  98 Elogind does monitor power button and the lid switch, like systemd,
  99 but instead of doing RPC to systemd to suspend, poweroff, or restart
 100 the machine, elogind just does this directly.  For suspend, hybernate,
 101 and hybrid-sleep, elogind uses the same code as systemd-sleep.
 102 Instead of using a separate sleep.conf file to configure the sleep
 103 behavior, this is included in the [Sleep] section of
 104 /etc/elogind/login.conf.  See the example login.conf for more.  For
 105 shutdown, reboot, and kexec, elogind shells out to "halt", "reboot",
 106 and "kexec" binaries.
 107
 108 The loginctl command has the poweroff, reboot, sleep, hibernate, and
 109 hybrid-sleep commands from systemd, as well as the --ignore-inhibitors
 110 flag.
 111
 112 The PAM module is called pam_elogind.so, not pam_systemd.so.
 113
 114 License
 115 -------
 116
 117 LGPLv2.1+ for all code
 118
 119   - except src/shared/MurmurHash2.c which is Public Domain
 120   - except src/shared/siphash24.c which is CC0 Public Domain
 121   - except src/journal/lookup3.c which is Public Domain
 122
 123 Dependencies
 124 ------------
 125
 126   glibc >= 2.14
 127   libcap
 128   libmount >= 2.20 (from util-linux)
 129   libseccomp >= 1.0.0 (optional)
 130   libblkid >= 2.24 (from util-linux) (optional)
 131   PAM >= 1.1.2 (optional)
 132   libacl (optional)
 133   libselinux (optional)
 134   make, gcc, and similar tools
 135
 136 During runtime, you need the following additional dependencies:
 137
 138   dbus >= 1.4.0 (strictly speaking optional, but recommended)
 139   PolicyKit (optional)
 140
 141 When building from git, you need the following additional
 142 dependencies:
 143
 144   pkg-config
 145   docbook-xsl
 146   xsltproc
 147   automake
 148   autoconf
 149   libtool
 150   intltool
 151   gperf
 152   gtkdocize (optional)