README

   1
   2 udev - a userspace implementation of devfs
   3
   4 For more information on the design, and structure of this project, see the
   5 files in the docs/ directory.
   6
   7 To use:
   8
   9 - You must be running a 2.6 version of the Linux kernel.
  10
  11 - Your 2.6 kernel must have had CONFIG_HOTPLUG enabled when it was built.
  12
  13 - Make sure sysfs is mounted.  udev will figure out where sysfs is mounted, but
  14   the traditional place for it is at /sys.  You can mount it by hand by running:
  15         mount -t sysfs none /sys
  16
  17 - Make sure you have the latest version of the linux-hotplug scripts.  They are
  18   available at linux-hotplug.sf.net or from your local kernel.org mirror at:
  19         kernel.org/pub/linux/utils/kernel/hotplug/
  20   They are required in order for udev to work properly.
  21
  22   If for some reason you do not install the hotplug scripts, you must tell the
  23   kernel to point the hotplug binary at wherever you install udev at.  This can
  24   be done by:
  25         echo "/sbin/udev" > /proc/sys/kernel/hotplug
  26
  27 - Build the project:
  28         make
  29
  30   Note:
  31       There are a number of different flags that you can use when building
  32       udev.  They are as follows:
  33         prefix - set this to the default root that you want udev to be
  34                 installed into.  This works just like the 'configure --prefix'
  35                 script does.  Default value is ''.  Only override this if you
  36                 really know what you are doing.
  37         USE_KLIBC - if set to 'true', udev is built and linked against the included
  38                 version of klibc.  Default value is 'false'.
  39         DEBUG - if set to 'true', debugging messages will be sent to the syslog
  40                 as udev is run.  Default value is 'false'.
  41         USE_DBUS -  if set to 'true', DBUS messages will be sent everytime udev
  42                 creates or removes a device node.  This requires that DBUS
  43                 development headers and libraries be present on your system to
  44                 build properly.  Default value is 'false'.
  45
  46       So, if you want to build udev using klibc with debugging messages, you
  47       would do:
  48         make USE_KLIBC=true DEBUG=true
  49
  50       Note: If you want to use klibc, you will have to set up the "linux"
  51             symlink properly.  See the file klibc/klibc/README and pay
  52             attention to step "a)" there.
  53
  54 - Install the project:
  55         make install
  56
  57   This will put the udev binary in /sbin, create the /udev and /etc/udev
  58   directories, and place the udev configuration files in /etc/udev.  You
  59   will probably want to edit the namedev.* files to create custom naming
  60   rules.  More info on how the config files are set up are contained in
  61   comments in the files, and is located in the documentation.
  62
  63 - Add and remove devices from the system and marvel as nodes are created
  64   and removed in /udev/ based on the device types.
  65
  66 - If you later get sick of it, uninstall it:
  67         make uninstall
  68
  69
  70 Things are still quite rough, but it should work properly.  If nothing
  71 seems to happen, make sure your build worked properly by running the
  72 udev-test.pl script as root in the test/ subdirectory of the udev source
  73 tree.
  74
  75 Development and documentation help is very much appreciated, see the TODO
  76 file for a list of things left to be done.
  77
  78
  79 Any comment/questions/concerns please let me and the other udev developers
  80 know by sending a message to the linux-hotplug-devel mailing list at:
  81         linux-hotplug-devel@lists.sourceforge.net
  82
  83 greg k-h
  84 greg@kroah.com
  85
  86
  87