chiark / gitweb /
man: introduce new "Desktop" property for sessions
[elogind.git] / README
diff --git a/README b/README
index b8d1f42..509b45f 100644 (file)
--- a/README
+++ b/README
@@ -31,10 +31,13 @@ AUTHOR:
 LICENSE:
         LGPLv2.1+ for all code
         - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
-        - except src/udev/ which is (currently still) GPLv2+
+        - except src/shared/MurmurHash2.c which is Public Domain
+        - except src/shared/siphash24.c which is CC0 Public Domain
+        - except src/journal/lookup3.c which is Public Domain
+        - except src/udev/* which is (currently still) GPLv2, GPLv2+
 
 REQUIREMENTS:
-        Linux kernel >= 2.6.39
+        Linux kernel >= 3.0
           CONFIG_DEVTMPFS
           CONFIG_CGROUPS (it's OK to disable all controllers)
           CONFIG_INOTIFY_USER
@@ -43,6 +46,8 @@ REQUIREMENTS:
           CONFIG_EPOLL
           CONFIG_NET
           CONFIG_SYSFS
+          CONFIG_PROC_FS
+          CONFIG_FHANDLE (mount and bind mount handling)
 
         Linux kernel >= 3.8 for Smack support
 
@@ -59,8 +64,9 @@ REQUIREMENTS:
         Some udev rules and virtualization detection relies on it:
           CONFIG_DMIID
 
-        Mount and bind mount handling might require it:
-          CONFIG_FHANDLE
+        Support for some SCSI devices serial number retrieval, to
+        create additional symlinks in /dev/disk/ and /dev/tape:
+          CONFIG_BLK_DEV_BSG
 
         Optional but strongly recommended:
           CONFIG_IPV6
@@ -69,9 +75,7 @@ REQUIREMENTS:
           CONFIG_TMPFS_XATTR
           CONFIG_SECCOMP
 
-        For systemd-bootchart a kernel with procfs support and several
-        proc output options enabled is required:
-          CONFIG_PROC_FS
+        For systemd-bootchart, several proc debug interfaces are required:
           CONFIG_SCHEDSTATS
           CONFIG_SCHED_DEBUG
 
@@ -79,10 +83,17 @@ REQUIREMENTS:
           CONFIG_EFI_VARS
           CONFIG_EFI_PARTITION
 
-        dbus >= 1.4.0
+        Note that kernel auditing is broken when used with systemd's
+        container code. When using systemd in conjunction with
+        containers, please make sure to either turn off auditing at
+        runtime using the kernel command line option "audit=0", or
+        turn it off at kernel compile time using:
+          CONFIG_AUDIT=n
+
+        glibc >= 2.14
         libcap
         libblkid >= 2.20 (from util-linux) (optional)
-        libkmod >= 5 (optional)
+        libkmod >= 15 (optional)
         PAM >= 1.1.2 (optional)
         libcryptsetup (optional)
         libaudit (optional)
@@ -97,14 +108,21 @@ REQUIREMENTS:
         libpython (optional)
         make, gcc, and similar tools
 
-        During runtime you need the following additional dependencies:
+        To sucessfully use --compat-libs, gcc >= 4.8 seems necessary.
 
-        util-linux >= v2.19 (requires fsck -l, agetty -s)
-        sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
+        During runtime, you need the following additional
+        dependencies:
+
+        util-linux >= v2.19 (requires fsck -l, agetty -s),
+                      v2.21 required for tests in test/
+        dbus >= 1.4.0 (strictly speaking optional, but recommended)
+        sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended,
+                 required for tests in test/)
         dracut (optional)
         PolicyKit (optional)
 
-        When building from git you need the following additional dependencies:
+        When building from git, you need the following additional
+        dependencies:
 
         docbook-xsl
         xsltproc
@@ -118,17 +136,12 @@ REQUIREMENTS:
         sphinx (optional)
         python-lxml (entirely optional)
 
-        When systemd-hostnamed is used it is strongly recommended to
-        install nss-myhostname to ensure that in a world of
-        dynamically changing hostnames the hostname stays resolvable
+        When systemd-hostnamed is used, it is strongly recommended to
+        install nss-myhostname to ensure that, in a world of
+        dynamically changing hostnames, the hostname stays resolvable
         under all circumstances. In fact, systemd-hostnamed will warn
         if nss-myhostname is not installed.
 
-        Note that D-Bus can link against libsystemd-login.so, which
-        results in a cyclic build dependency. To accommodate for this
-        please build D-Bus without systemd first, then build systemd,
-        then rebuild D-Bus with systemd support.
-
         To build HTML documentation for python-systemd using sphinx,
         please first install systemd (using 'make install'), and then
         invoke sphinx-build with 'make sphinx-<target>', with <target>
@@ -143,9 +156,9 @@ USERS AND GROUPS:
 
         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
 
-        During runtime the journal daemon requires the
+        During runtime, the journal daemon requires the
         "systemd-journal" system group to exist. New journal files will
-        be readable by this group (but not writable) which may be used
+        be readable by this group (but not writable), which may be used
         to grant specific users read access.
 
         It is also recommended to grant read access to all journal
@@ -167,12 +180,12 @@ WARNINGS:
 
         systemd will warn you during boot if /usr is on a different
         file system than /. While in systemd itself very little will
-        break if /usr is on a separate partition many of its
+        break if /usr is on a separate partition, many of its
         dependencies very likely will break sooner or later in one
-        form or another. For example udev rules tend to refer to
+        form or another. For example, udev rules tend to refer to
         binaries in /usr, binaries that link to libraries in /usr or
         binaries that refer to data files in /usr. Since these
-        breakages are not always directly visible systemd will warn
+        breakages are not always directly visible, systemd will warn
         about this, since this kind of file system setup is not really
         supported anymore by the basic set of Linux OS components.