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