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 - Make sure sysfs is mounted.  udev will figure out where sysfs is mounted, but
  12   the traditional place for it is at /sys.  You can mount it by hand by running:
  13         mount -t sysfs none /sys
  14
  15 - Make sure you have the latest version of the linux-hotplug scripts.  They are
  16   available at linux-hotplug.sf.net or from your local kernel.org mirror at:
  17         kernel.org/pub/linux/utils/kernel/hotplug/
  18   They are required in order for udev to work properly.
  19
  20   If for some reason you do not install the hotplug scripts, you must tell the
  21   kernel to point the hotplug binary at wherever you install udev at.  This can
  22   be done by:
  23         echo "/sbin/udev" > /proc/sys/kernel/hotplug
  24
  25 - Build the project:
  26         make
  27
  28   Note:
  29       There are a number of different flags that you can use when building
  30       udev.  They are as follows:
  31         prefix - set this to the default root that you want udev to be
  32                 installed into.  This works just like the 'configure --prefix'
  33                 script does.  Default value is ''.  Only override this if you
  34                 really know what you are doing.
  35         USE_KLIBC - if set to 'true', udev is built and linked against the included
  36                 version of klibc.  Default value is 'false'.
  37         DEBUG - if set to 'true', debugging messages will be sent to the syslog
  38                 as udev is run.  Default value is 'false'.
  39         USE_DBUS -  if set to 'true', DBUS messages will be sent everytime udev
  40                 creates or removes a device node.  This requires that DBUS
  41                 development headers and libraries be present on your system to
  42                 build properly.  Default value is 'false'.
  43
  44       So, if you want to build udev using klibc with debugging messages, you
  45       would do:
  46         make USE_KLIBC=true DEBUG=true
  47
  48
  49 - Install the project:
  50         make install
  51
  52   This will put the udev binary in /sbin, create the /udev and /etc/udev
  53   directories, and place the udev configuration files in /etc/udev.  You
  54   will probably want to edit the namedev.* files to create custom naming
  55   rules.  More info on how the config files are set up are contained in
  56   comments in the files, and is located in the documentation.
  57
  58 - Add and remove devices from the system and marvel as nodes are created
  59   and removed in /udev/ based on the device types.
  60
  61 - If you later get sick of it, uninstall it:
  62         make uninstall
  63
  64
  65 Things are still quite rough, and it's a bit beyond proof of concept
  66 code.  Help is very much appreciated, see the TODO file for a list of
  67 things left to be done.
  68
  69 If you want to build using klibc, use the Makefile.klibc file:
  70         - read the klibc/klibc/README file for how to set up the linux
  71           symlink properly.
  72         - make clean
  73         - make -f Makefile.klibc
  74 and marvel at the tiny binary you just created :)
  75
  76 Any comment/questions/concerns please let me know.
  77
  78 greg k-h
  79 greg@kroah.com
  80
  81
  82