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