summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README205
1 files changed, 104 insertions, 101 deletions
diff --git a/README b/README
index 38459c6b22..6b0eb51ecd 100644
--- a/README
+++ b/README
@@ -1,101 +1,104 @@
-udev - Linux userspace device management
-
-Integrating udev in the system has complex dependencies and may differ from
-distribution to distribution. A system may not be able to boot up or work
-reliably without a properly installed udev version. The upstream udev project
-does not recommend replacing a distro's udev installation with the upstream
-version.
-
-The upstream udev project's set of default rules may require a most recent
-kernel release to work properly.
-
-Tools and rules shipped by udev are not public API and may change at any time.
-Never call any private tool in /usr/lib/udev from any external application; it
-might just go away in the next release. Access to udev information is only offered
-by udevadm and libudev. Tools and rules in /usr/lib/udev and the entire contents
-of the /run/udev directory are private to udev and do change whenever needed.
-
-Requirements:
- - Version 2.6.34 of the Linux kernel with sysfs, procfs, signalfd, inotify,
- unix domain sockets, networking and hotplug enabled
-
- - Some architectures might need a later kernel, that supports accept4(),
- or need to backport the accept4() syscall wiring in the kernel.
-
- - These options are required:
- CONFIG_DEVTMPFS=y
- CONFIG_HOTPLUG=y
- CONFIG_INOTIFY_USER=y
- CONFIG_NET=y
- CONFIG_PROC_FS=y
- CONFIG_SIGNALFD=y
- CONFIG_SYSFS=y
- CONFIG_SYSFS_DEPRECATED*=n
- CONFIG_UEVENT_HELPER_PATH=""
-
- - These options might be needed:
- CONFIG_BLK_DEV_BSG=y (SCSI devices)
- CONFIG_TMPFS_POSIX_ACL=y (user ACLs for device nodes)
-
- - The /dev directory needs the 'devtmpfs' filesystem mounted.
- Udev only manages the permissions and ownership of the
- kernel-provided device nodes, and possibly creates additional symlinks.
-
- - Udev requires /run to be writable, which is usually done by mounting a
- 'tmpfs' filesystem.
-
- - This version of udev does not work properly with the CONFIG_SYSFS_DEPRECATED*
- option enabled.
-
- - The deprecated hotplug helper /sbin/hotplug should be disabled in the
- kernel configuration, it is not needed today, and may render the system
- unusable because the kernel may create too many processes in parallel
- so that the system runs out-of-memory.
-
- - The proc filesystem must be mounted on /proc, and the sysfs filesystem must
- be mounted at /sys. No other locations are supported by a standard
- udev installation.
-
- - The default rule sset requires the following group names resolvable at udev startup:
- disk, cdrom, floppy, tape, audio, video, lp, tty, dialout, and kmem.
- Especially in LDAP setups, it is required that getgrnam() be able to resolve
- these group names with only the rootfs mounted and while no network is
- available.
-
- - Some udev extras have external dependencies like:
- libglib2, usbutils, pciutils, and gperf.
- All these extras can be disabled with configure options.
-
-Setup:
- - The udev daemon should be started to handle device events sent by the kernel.
- During bootup, the events for already existing devices can be replayed, so
- that they are configured by udev. The systemd service files contain the
- needed commands to start the udev daemon and the coldplug sequence.
-
- - Restarting the daemon never applies any rules to existing devices.
-
- - New/changed rule files are picked up automatically; there is usually no
- daemon restart or signal needed.
-
-Operation:
- - Based on events the kernel sends out on device creation/removal, udev
- creates/removes device nodes and symlinks in the /dev directory.
-
- - All kernel events are matched against a set of specified rules, which
- possibly hook into the event processing and load required kernel
- modules to set up devices. For all devices, the kernel exports a major/minor
- number; if needed, udev creates a device node with the default kernel
- device name. If specified, udev applies permissions/ownership to the device
- node, creates additional symlinks pointing to the node, and executes
- programs to handle the device.
-
- - The events udev handles, and the information udev merges into its device
- database, can be accessed with libudev:
- http://www.kernel.org/pub/linux/utils/kernel/hotplug/libudev/
- http://www.kernel.org/pub/linux/utils/kernel/hotplug/gudev/
-
-For more details about udev and udev rules, see the udev man pages:
- http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev/
-
-Please direct any comment/question to the linux-hotplug mailing list at:
- linux-hotplug@vger.kernel.org
+systemd System and Service Manager
+
+DETAILS:
+ http://0pointer.de/blog/projects/systemd.html
+
+WEB SITE:
+ http://www.freedesktop.org/wiki/Software/systemd
+
+GIT:
+ git://anongit.freedesktop.org/systemd/systemd
+ ssh://git.freedesktop.org/git/systemd/systemd
+
+GITWEB:
+ http://cgit.freedesktop.org/systemd/systemd
+
+MAILING LIST:
+ http://lists.freedesktop.org/mailman/listinfo/systemd-devel
+ http://lists.freedesktop.org/mailman/listinfo/systemd-commits
+
+IRC:
+ #systemd on irc.freenode.org
+
+BUG REPORTS:
+ https://bugs.freedesktop.org/enter_bug.cgi?product=systemd
+
+AUTHOR:
+ Lennart Poettering with major support from Kay Sievers
+
+LICENSE:
+ GPLv2+ for all code, except sd-daemon.[ch] and
+ sd-readahead.[ch] which are MIT
+
+REQUIREMENTS:
+ Linux kernel >= 2.6.39
+ with devtmpfs
+ with cgroups (but it's OK to disable all controllers)
+ optional but strongly recommended: autofs4, ipv6
+ libudev >= 172
+ dbus >= 1.4.0
+ libcap
+ PAM >= 1.1.2 (optional)
+ libcryptsetup (optional)
+ libaudit (optional)
+ libselinux (optional)
+ tcpwrappers (optional)
+
+ When you build from git you need the following additional dependencies:
+
+ docbook-xsl
+ xsltproc
+ automake
+ autoconf
+ libtool
+ gperf
+ make, gcc, and similar tools
+
+ During runtime you need the following dependencies:
+
+ util-linux > v2.18 (requires fsck -l, agetty -s)
+ sulogin (from sysvinit-tools, optional but recommended)
+ plymouth (optional)
+ dracut (optional)
+
+ When systemd-hostnamed is used it is strongly recommended to
+ install nss-myhostname to ensure that in a world of
+ dynamically changing hostnames the hostname stays resolveable
+ under all circumstances. In fact, systemd-hostnamed will warn
+ if nss-myhostname is not installed. Packagers are encouraged to
+ add a dependency on nss-myhostname to the package that
+ includes systemd-hostnamed.
+
+ Note that D-Bus can link against libsystemd-login.so, which
+ results in a cyclic build dependency. To accomodate for this
+ please build D-Bus without systemd first, then build systemd,
+ then rebuild D-Bus with systemd support.
+
+WARNINGS:
+ systemd will warn you during boot if /etc/mtab is not a
+ symlink to /proc/mounts. Please ensure that /etc/mtab is a
+ proper symlink.
+
+ systemd will warn you during boot if /usr is on a different
+ file system than /. While in systemd itself very little will
+ break if /usr is on a separate partition many of its
+ dependencies very likely will break sooner or later in one
+ form or another. For example udev rules tend to refer to
+ binaries in /usr, binaries that link to libraries in /usr or
+ binaries that refer to data files in /usr. Since these
+ breakages are not always directly visible systemd will warn
+ about this, since this kind of file system setup is not really
+ supported anymore by the basic set of Linux OS components.
+
+ For more information on this issue consult
+ http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
+
+ENGINEERING AND CONSULTING SERVICES:
+ ProFUSION <http://profusion.mobi> offers professional
+ engineering and consulting services for systemd for embedded
+ and other use. Please contact Gustavo Barbieri
+ <barbieri@profusion.mobi> for more information.
+
+ Disclaimer: This notice is not a recommendation or official
+ endorsement. However, ProFUSION's upstream work has been very
+ beneficial for the systemd project.