chiark / gitweb /
journal: fix memleak, call set_free before return
[elogind.git] / README
diff --git a/README b/README
index a1d100c6343c8db930dba796e89a355ff3a24b2f..d947f27e28773c67bc4f16fe38943b6823ac81cb 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-systemd System and Session Manager
+systemd System and Service Manager
 
 DETAILS:
         http://0pointer.de/blog/projects/systemd.html
 
 DETAILS:
         http://0pointer.de/blog/projects/systemd.html
@@ -7,11 +7,11 @@ WEB SITE:
         http://www.freedesktop.org/wiki/Software/systemd
 
 GIT:
         http://www.freedesktop.org/wiki/Software/systemd
 
 GIT:
-        git://anongit.freedesktop.org/systemd
-        ssh://git.freedesktop.org/git/systemd
+        git://anongit.freedesktop.org/systemd/systemd
+        ssh://git.freedesktop.org/git/systemd/systemd
 
 GITWEB:
 
 GITWEB:
-        http://cgit.freedesktop.org/systemd/
+        http://cgit.freedesktop.org/systemd/systemd
 
 MAILING LIST:
         http://lists.freedesktop.org/mailman/listinfo/systemd-devel
 
 MAILING LIST:
         http://lists.freedesktop.org/mailman/listinfo/systemd-devel
@@ -24,38 +24,69 @@ BUG REPORTS:
         https://bugs.freedesktop.org/enter_bug.cgi?product=systemd
 
 AUTHOR:
         https://bugs.freedesktop.org/enter_bug.cgi?product=systemd
 
 AUTHOR:
-        Lennart Poettering with major support from Kay Sievers
+        Lennart Poettering
+        Kay Sievers
+        ...and many others
+
+LICENSE:
+        LGPLv2.1+ for all code
+        - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
+        - except src/udev/ which is GPLv2.0+
 
 REQUIREMENTS:
 
 REQUIREMENTS:
-        Linux kernel >= 2.6.30 (with devtmpfs, cgroups; optional but strongly recommended: autofs4, ipv6)
-        libudev >= 163
+        Linux kernel >= 2.6.39
+                with devtmpfs
+                with cgroups (but it's OK to disable all controllers)
+                optional but strongly recommended: autofs4, ipv6
         dbus >= 1.4.0
         libcap
         dbus >= 1.4.0
         libcap
-        gtk+ >= 2.20 (optional)
+        libblkid >= 2.20 (from util-linux)
+        libkmod >= 5
         PAM >= 1.1.2 (optional)
         libcryptsetup (optional)
         PAM >= 1.1.2 (optional)
         libcryptsetup (optional)
+        libgcrypt (optional)
         libaudit (optional)
         libaudit (optional)
+        libacl (optional)
+        libattr (optional)
         libselinux (optional)
         libselinux (optional)
+        liblzma (optional)
         tcpwrappers (optional)
         tcpwrappers (optional)
-        libnotify (optional)
+        libgcrypt (optional)
+        libqrencode (optional)
+        libmicrohttpd (optional)
 
         When you build from git you need the following additional dependencies:
 
 
         When you build from git you need the following additional dependencies:
 
-        vala >= 0.10
         docbook-xsl
         xsltproc
         automake
         autoconf
         libtool
         docbook-xsl
         xsltproc
         automake
         autoconf
         libtool
+        intltool
+        gperf
+        gtkdocize (optional)
+        python (optional)
         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)
         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)
 
         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 accommodate 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
 WARNINGS:
         systemd will warn you during boot if /etc/mtab is not a
         symlink to /proc/mounts. Please ensure that /etc/mtab is a
@@ -72,6 +103,14 @@ WARNINGS:
         about this, since this kind of file system setup is not really
         supported anymore by the basic set of Linux OS components.
 
         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
+
+        To run systemd under valgrind, compile with VALGRIND defined
+        (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
+        false positives will be triggered by code which violates
+        some rules but is actually safe.
+
 ENGINEERING AND CONSULTING SERVICES:
         ProFUSION <http://profusion.mobi> offers professional
         engineering and consulting services for systemd for embedded
 ENGINEERING AND CONSULTING SERVICES:
         ProFUSION <http://profusion.mobi> offers professional
         engineering and consulting services for systemd for embedded