chiark / gitweb /
docs: install README files into /var/log and 7etc/rc.d/init.d
[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)
44         libkmod >= 5
45         PAM >= 1.1.2 (optional)
46         libcryptsetup (optional)
47         libgcrypt (optional)
48         libaudit (optional)
49         libacl (optional)
50         libattr (optional)
51         libselinux (optional)
52         liblzma (optional)
53         tcpwrappers (optional)
54         libgcrypt (optional)
55         libqrencode (optional)
56         libmicrohttpd (optional)
57
58         When you build from git you need the following additional dependencies:
59
60         docbook-xsl
61         xsltproc
62         automake
63         autoconf
64         libtool
65         intltool
66         gperf
67         gtkdocize (optional)
68         python (optional)
69         make, gcc, and similar tools
70
71         During runtime you need the following dependencies:
72
73         util-linux > v2.18 (requires fsck -l, agetty -s)
74         sulogin (from sysvinit-tools, optional but recommended)
75         dracut (optional)
76
77         When systemd-hostnamed is used it is strongly recommended to
78         install nss-myhostname to ensure that in a world of
79         dynamically changing hostnames the hostname stays resolveable
80         under all circumstances. In fact, systemd-hostnamed will warn
81         if nss-myhostname is not installed. Packagers are encouraged to
82         add a dependency on nss-myhostname to the package that
83         includes systemd-hostnamed.
84
85         Note that D-Bus can link against libsystemd-login.so, which
86         results in a cyclic build dependency. To accommodate for this
87         please build D-Bus without systemd first, then build systemd,
88         then rebuild D-Bus with systemd support.
89
90 WARNINGS:
91         systemd will warn you during boot if /etc/mtab is not a
92         symlink to /proc/mounts. Please ensure that /etc/mtab is a
93         proper symlink.
94
95         systemd will warn you during boot if /usr is on a different
96         file system than /. While in systemd itself very little will
97         break if /usr is on a separate partition many of its
98         dependencies very likely will break sooner or later in one
99         form or another. For example udev rules tend to refer to
100         binaries in /usr, binaries that link to libraries in /usr or
101         binaries that refer to data files in /usr. Since these
102         breakages are not always directly visible systemd will warn
103         about this, since this kind of file system setup is not really
104         supported anymore by the basic set of Linux OS components.
105
106         For more information on this issue consult
107         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
108
109         To run systemd under valgrind, compile with VALGRIND defined
110         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
111         false positives will be triggered by code which violates
112         some rules but is actually safe.
113
114 ENGINEERING AND CONSULTING SERVICES:
115         ProFUSION <http://profusion.mobi> offers professional
116         engineering and consulting services for systemd for embedded
117         and other use. Please contact Gustavo Barbieri
118         <barbieri@profusion.mobi> for more information.
119
120         Disclaimer: This notice is not a recommendation or official
121         endorsement. However, ProFUSION's upstream work has been very
122         beneficial for the systemd project.