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
  34                 set this to the default root that you want udev to be
  35                 installed into.  This works just like the 'configure --prefix'
  36                 script does.  Default value is ''.  Only override this if you
  37                 really know what you are doing.
  38         USE_KLIBC
  39                 if set to 'true', udev is built and linked against the
  40                 included version of klibc.  Default value is 'false'.
  41         USE_LOG
  42                 if set to 'true', udev will emit messages to the syslog when
  43                 it creates or removes device nodes.  This is helpful to see
  44                 what udev is doing.  This is enabled by default.  Note, if you
  45                 are building udev against klibc it is recommended that you
  46                 disable this option (due to klibc's syslog implementation.)
  47         USE_SELINUX
  48                 if set to 'true', udev will be built with SELinux support
  49                 enabled.  This is disabled by default.
  50         DEBUG
  51                 if set to 'true', debugging messages will be sent to the syslog
  52                 as udev is run.  Default value is 'false'.
  53         KERNEL_DIR
  54                 If this is not set it will default to /lib/modules/`uname -r`/build
  55                 This is used if USE_KLIBC=true to find the kernel include
  56                 directory that klibc needs to build against.  This must be set
  57                 if you are not building udev while running a 2.6 kernel.
  58
  59       So, if you want to build udev using klibc with debugging messages, you
  60       would do:
  61         make USE_KLIBC=true DEBUG=true
  62
  63 - Install the project:
  64         make install
  65
  66   This will put the udev binary in /sbin, create the /udev and /etc/udev
  67   directories, and place the udev configuration files in /etc/udev.  You
  68   will probably want to edit the *.rules files to create custom naming
  69   rules.  More info on how the config files are set up are contained in
  70   comments in the files, and is located in the documentation.
  71
  72 - Add and remove devices from the system and marvel as nodes are created
  73   and removed in /udev/ based on the device types.
  74
  75 - If you later get sick of it, uninstall it:
  76         make uninstall
  77
  78
  79 Things are still quite rough, but it should work properly.  If nothing
  80 seems to happen, make sure your build worked properly by running the
  81 udev-test.pl script as root in the test/ subdirectory of the udev source
  82 tree.
  83
  84 Development and documentation help is very much appreciated, see the TODO
  85 file for a list of things left to be done.
  86
  87
  88 Any comment/questions/concerns please let me and the other udev developers
  89 know by sending a message to the linux-hotplug-devel mailing list at:
  90         linux-hotplug-devel@lists.sourceforge.net
  91
  92 greg k-h
  93 greg@kroah.com
  94