chiark / gitweb /
build-sys: make loadable module support optional
[elogind.git] / README
1 systemd System and Service Manager
2
3 DETAILS:
4         http://0pointer.de/blog/projects/systemd.html
5
6 WEB SITE:
7         http://www.freedesktop.org/wiki/Software/systemd
8
9 GIT:
10         git://anongit.freedesktop.org/systemd/systemd
11         ssh://git.freedesktop.org/git/systemd/systemd
12
13 GITWEB:
14         http://cgit.freedesktop.org/systemd/systemd
15
16 MAILING LIST:
17         http://lists.freedesktop.org/mailman/listinfo/systemd-devel
18         http://lists.freedesktop.org/mailman/listinfo/systemd-commits
19
20 IRC:
21         #systemd on irc.freenode.org
22
23 BUG REPORTS:
24         https://bugs.freedesktop.org/enter_bug.cgi?product=systemd
25
26 AUTHOR:
27         Lennart Poettering
28         Kay Sievers
29         ...and many others
30
31 LICENSE:
32         LGPLv2.1+ for all code
33         - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
34         - except src/udev/ which is GPLv2.0+
35
36 REQUIREMENTS:
37         Linux kernel >= 2.6.39
38                 with devtmpfs
39                 with cgroups (but it's OK to disable all controllers)
40                 optional but strongly recommended: autofs4, ipv6
41         dbus >= 1.4.0
42         libcap
43         libblkid >= 2.20 (from util-linux) (optional)
44         libkmod >= 5 (optional)
45         PAM >= 1.1.2 (optional)
46         libcryptsetup (optional)
47         libaudit (optional)
48         libacl (optional)
49         libattr (optional)
50         libselinux (optional)
51         liblzma (optional)
52         tcpwrappers (optional)
53         libgcrypt (optional)
54         libqrencode (optional)
55         libmicrohttpd (optional)
56
57         When you build from git you need the following additional dependencies:
58
59         docbook-xsl
60         xsltproc
61         automake
62         autoconf
63         libtool
64         intltool
65         gperf
66         gtkdocize (optional)
67         python (optional)
68         make, gcc, and similar tools
69
70         During runtime you need the following dependencies:
71
72         util-linux > v2.18 (requires fsck -l, agetty -s)
73         sulogin (from sysvinit-tools, optional but recommended)
74         dracut (optional)
75
76         When systemd-hostnamed is used it is strongly recommended to
77         install nss-myhostname to ensure that in a world of
78         dynamically changing hostnames the hostname stays resolvable
79         under all circumstances. In fact, systemd-hostnamed will warn
80         if nss-myhostname is not installed. Packagers are encouraged to
81         add a dependency on nss-myhostname to the package that
82         includes systemd-hostnamed.
83
84         Note that D-Bus can link against libsystemd-login.so, which
85         results in a cyclic build dependency. To accommodate for this
86         please build D-Bus without systemd first, then build systemd,
87         then rebuild D-Bus with systemd support.
88
89 WARNINGS:
90         systemd will warn you during boot if /etc/mtab is not a
91         symlink to /proc/mounts. Please ensure that /etc/mtab is a
92         proper symlink.
93
94         systemd will warn you during boot if /usr is on a different
95         file system than /. While in systemd itself very little will
96         break if /usr is on a separate partition many of its
97         dependencies very likely will break sooner or later in one
98         form or another. For example udev rules tend to refer to
99         binaries in /usr, binaries that link to libraries in /usr or
100         binaries that refer to data files in /usr. Since these
101         breakages are not always directly visible systemd will warn
102         about this, since this kind of file system setup is not really
103         supported anymore by the basic set of Linux OS components.
104
105         For more information on this issue consult
106         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
107
108         To run systemd under valgrind, compile with VALGRIND defined
109         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
110         false positives will be triggered by code which violates
111         some rules but is actually safe.
112
113 ENGINEERING AND CONSULTING SERVICES:
114         ProFUSION <http://profusion.mobi> offers professional
115         engineering and consulting services for systemd for embedded
116         and other use. Please contact Gustavo Barbieri
117         <barbieri@profusion.mobi> for more information.
118
119         Disclaimer: This notice is not a recommendation or official
120         endorsement. However, ProFUSION's upstream work has been very
121         beneficial for the systemd project.