chiark / gitweb /
man: document journal features of systemctl(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 with major support from Kay Sievers
28
29 LICENSE:
30         GPLv2+ for all code, except sd-daemon.[ch] and
31         sd-readahead.[ch] which are MIT
32
33 REQUIREMENTS:
34         Linux kernel >= 2.6.39
35                 with devtmpfs
36                 with cgroups (but it's OK to disable all controllers)
37                 optional but strongly recommended: autofs4, ipv6
38         libudev >= 172
39         dbus >= 1.4.0
40         libcap
41         gtk+ >= 2.20 (optional)
42         PAM >= 1.1.2 (optional)
43         libcryptsetup (optional)
44         libaudit (optional)
45         libselinux (optional)
46         tcpwrappers (optional)
47         libnotify (optional)
48
49         When you build from git you need the following additional dependencies:
50
51         vala >= 0.10
52         docbook-xsl
53         xsltproc
54         automake
55         autoconf
56         libtool
57         gperf
58         make, gcc, and similar tools
59
60         During runtime you need the following dependencies:
61
62         util-linux > v2.18 (requires fsck -l, agetty -s)
63         sulogin (from sysvinit-tools, optional but recommended)
64         plymouth (optional)
65         dracut (optional)
66
67         When systemd-hostnamed is used it is strongly recommended to
68         install nss-myhostname to ensure that in a world of
69         dynamically changing hostnames the hostname stays resolveable
70         under all circumstances. In fact, systemd-hostnamed will warn
71         if nss-myhostname is not installed. Packagers are encouraged to
72         add a dependency on nss-myhostname to the package that
73         includes systemd-hostnamed.
74
75         Note that D-Bus can link against libsystemd-login.so, which
76         results in a cyclic build dependency. To accomodate for this
77         please build D-Bus without systemd first, then build systemd,
78         then rebuild D-Bus with systemd support.
79
80 WARNINGS:
81         systemd will warn you during boot if /etc/mtab is not a
82         symlink to /proc/mounts. Please ensure that /etc/mtab is a
83         proper symlink.
84
85         systemd will warn you during boot if /usr is on a different
86         file system than /. While in systemd itself very little will
87         break if /usr is on a separate partition many of its
88         dependencies very likely will break sooner or later in one
89         form or another. For example udev rules tend to refer to
90         binaries in /usr, binaries that link to libraries in /usr or
91         binaries that refer to data files in /usr. Since these
92         breakages are not always directly visible systemd will warn
93         about this, since this kind of file system setup is not really
94         supported anymore by the basic set of Linux OS components.
95
96         For more information on this issue consult
97         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
98
99 ENGINEERING AND CONSULTING SERVICES:
100         ProFUSION <http://profusion.mobi> offers professional
101         engineering and consulting services for systemd for embedded
102         and other use. Please contact Gustavo Barbieri
103         <barbieri@profusion.mobi> for more information.
104
105         Disclaimer: This notice is not a recommendation or official
106         endorsement. However, ProFUSION's upstream work has been very
107         beneficial for the systemd project.