service: change default stdout/stderr to syslog

[elogind.git] / README

diff --git a/README b/README
index cc30683c06a6b69a4a1c6841e6fdb62bc772d83d..15afb2cf95de36106e34798727f18a518fe050a1 100644 (file)
--- a/README
+++ b/README
@@ -26,12 +26,78 @@ BUG REPORTS:
 AUTHOR:
         Lennart Poettering with major support from Kay Sievers
 
+LICENSE:
+        GPLv2+ for all code, except sd-daemon.[ch] which is MIT
+
 REQUIREMENTS:
-        Linux kernel >= 2.6.30 (with autofs4, devtmpfs, cgroups)
-        libudev >= 163
+        Linux kernel >= 2.6.39 (with devtmpfs, cgroups; optional but strongly recommended: autofs4, ipv6)
+        libudev >= 172
         dbus >= 1.4.0
-        vala >= 0.10
-        util-linux > v2.18 (requires fsck -l, agetty -s)
-        gtk+ >= 2.20
         libcap
+        gtk+ >= 2.20 (optional)
         PAM >= 1.1.2 (optional)
+        libcryptsetup (optional)
+        libaudit (optional)
+        libselinux (optional)
+        tcpwrappers (optional)
+        libnotify (optional)
+
+        When you build from git you need the following additional dependencies:
+
+        vala >= 0.10
+        docbook-xsl
+        xsltproc
+        automake
+        autoconf
+        libtool
+        gperf
+        make, gcc, and similar tools
+
+        During runtime you need the following dependencies:
+
+        util-linux > v2.18 (requires fsck -l, agetty -s)
+        sulogin (from sysvinit-tools, optional but recommended)
+        plymouth (optional)
+        dracut (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 resolveable
+        under all circumstances. In fact, systemd-hostnamed will warn
+        if nss-myhostname is not installed. Packagers are encouraged to
+        add a dependency on nss-myhostname to the package that
+        includes systemd-hostnamed.
+
+        Note that D-Bus can link against libsystemd-login.so, which
+        results in a cyclic build dependency. To accomodate for this
+        please build D-Bus without systemd first, then build systemd,
+        then rebuild D-Bus with systemd support.
+
+WARNINGS:
+        systemd will warn you during boot if /etc/mtab is not a
+        symlink to /proc/mounts. Please ensure that /etc/mtab is a
+        proper symlink.
+
+        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
+        dependencies very likely will break sooner or later in one
+        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
+        about this, since this kind of file system setup is not really
+        supported anymore by the basic set of Linux OS components.
+
+        For more information on this issue consult
+        http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
+
+ENGINEERING AND CONSULTING SERVICES:
+        ProFUSION <http://profusion.mobi> offers professional
+        engineering and consulting services for systemd for embedded
+        and other use. Please contact Gustavo Barbieri
+        <barbieri@profusion.mobi> for more information.
+
+        Disclaimer: This notice is not a recommendation or official
+        endorsement. However, ProFUSION's upstream work has been very
+        beneficial for the systemd project.