chiark / gitweb /
update TODO
[elogind.git] / README
1 udev - userspace device management
2
3 For more information see the files in the docs/ directory.
4
5 Important Note:
6   Integrating udev in the system is a whole lot of work, has complex dependencies
7   and differs a lot from distro to distro. All reasonable distros use udev these
8   days, the major ones make it mandatory and the system will not work without it.
9
10   The upstream udev project does not support or recomend to replace a distro's udev
11   installation with the upstream version. The installation of a unmodified upstream
12   version may render your system unusable! There is no "default" setup or a set
13   of "default" rules provided by the upstream udev version.
14
15 udev requires:
16   - 2.6 version of the Linux kernel
17
18   - the kernel must have sysfs, netlink, and hotplug enabled
19
20   - proc must be mounted on /proc
21
22   - sysfs must be mounted at /sys, no other location is supported
23
24   - udev creates and removes device nodes in /dev based on events
25     the kernel sends out on device discovery or removal
26
27   - during bootup /dev usually gets a tmpfs mounted which is populated scratch
28     by udev (created nodes don't survive a reboot, it always starts from scratch)
29
30   - udev replaces the hotplug event management invoked from /sbin/hotplug
31     by the udevd daemon, which receives the kernel events over netlink
32
33   - all kernel events are matched against a set of specified rules which
34     make it posible to hook into the event processing
35
36   - there is a copy of the rules files for all major distros in the etc/udev
37     directory (you may look there how others distros are doing it)
38
39 Setting which are used for building udev:
40   prefix
41         set this to the default root that you want to use
42         Only override this if you really know what you are doing
43   DESTDIR
44         prefix for install target for package building
45   USE_LOG
46         if set to 'true', udev will emit messages to the syslog when
47         it creates or removes device nodes.  This is helpful to see
48         what udev is doing.  This is enabled by default.
49   DEBUG
50         if set to 'true', verbose debugging messages will be compiled into
51         the udev binaries.  Default value is 'false'.
52   USE_SELINUX
53         if set to 'true', udev will be built with SELinux support
54         enabled.  This is disabled by default.
55   USE_KLIBC
56         if set to 'true', udev is built and linked against klibc.
57         Default value is 'false'. KLCC specifies the klibc compiler
58         wrapper, usually in /usr/bin/klcc
59   EXTRAS
60         if set, will build the "extra" helper programs as specified
61         as listed (see below for an example.)
62
63 if you want to build the udev helper program cdrom_id and scsi_id:
64   make EXTRAS="extras/cdrom_id extras/scsi_id"
65
66 Please direct any comment/question/concern to the linux-hotplug-devel mailing list at:
67   linux-hotplug-devel@lists.sourceforge.net
68