chiark / gitweb /
a2f00021e8b58e57fd0c1239244c6bf9ab9e49bd
[elogind.git] / README
1 udev - userspace device management
2
3 Integrating udev in the system has complex dependencies and differs from distro
4 to distro. All major distros depend on udev these days and the system may not
5 work without a properly installed version. The upstream udev project does not
6 recommend to replace a distro's udev installation with the upstream version.
7
8 Tools and rules shipped by udev are not public API and may change at any time.
9 Never call any private tool in /lib/udev from any external application, it might
10 just go away in the next release. Access to udev information is only offered
11 by udevadm and libudev. Everything in /lib/udev and /dev/.udev/ is 100% private
12 to udev.
13
14 Requirements:
15   - Version 2.6.25 of the Linux kernel with sysfs, procfs, signalfd, inotify,
16     unix domain sockets, networking and hotplug enabled:
17       CONFIG_HOTPLUG=y
18       CONFIG_UEVENT_HELPER_PATH=""
19       CONFIG_NET=y
20       CONFIG_UNIX=y
21       CONFIG_SYSFS=y
22       CONFIG_SYSFS_DEPRECATED*=n
23       CONFIG_PROC_FS=y
24       CONFIG_TMPFS=y
25       CONFIG_TMPFS_POSIX_ACL=y
26       CONFIG_INOTIFY=y
27       CONFIG_SIGNALFD=y
28
29   - For reliable operation, the kernel must not use the CONFIG_SYSFS_DEPRECATED*
30     option.
31
32   - Unix domain sockets (CONFIG_UNIX) as a loadable kernel module is not
33     supported.
34
35   - The proc filesystem must be mounted on /proc/, the sysfs filesystem must
36     be mounted at /sys/. No other locations are supported by udev.
37
38   - The system must have the following group names resolvable at udev startup:
39       disk, cdrom, floppy, tape, audio, video, lp, tty, dialout, kmem.
40     Especially in LDAP setups, it is required, that getgrnam() is able to resolve
41     these group names with only the rootfs mounted, and while no network is
42     available.
43
44   - To build all udev extras, libacl, libglib2, libusb, usbutils, pciutils,
45     gperf are needed. These dependencies can be disabled with the
46     --disable-extras option.
47
48 Operation:
49   Udev creates and removes device nodes in /dev/, based on events the kernel
50   sends out on device discovery or removal.
51
52   - Early in the boot process, the /dev/ directory should get a 'tmpfs'
53     filesystem mounted, which is maintained by udev. Created nodes or changed
54     permissions will not survive a reboot, which is intentional.
55
56   - The content of /lib/udev/devices/ directory which contains the nodes,
57     symlinks and directories, which are always expected to be in /dev, should
58     be copied over to the tmpfs mounted /dev, to provide the required nodes
59     to initialize udev and continue booting.
60
61   - The old hotplug helper /sbin/hotplug should be disabled in the kernel
62     configuration, it is not needed, and may render the system unusable
63     because of a fork-bombing behavior.
64
65   - All kernel events are matched against a set of specified rules in
66     /lib/udev/rules.d/ which make it possible to hook into the event
67     processing to load required kernel modules and setup devices. For all
68     devices the kernel exports a major/minor number, udev will create a
69     device node with the default kernel name, or the one specified by a
70     matching udev rule.
71
72 Please direct any comment/question/concern to the linux-hotplug mailing list at:
73   linux-hotplug@vger.kernel.org
74