chiark / gitweb /
061 release
[elogind.git] / README
diff --git a/README b/README
index 123fce6a1b4c81e262a9a8a15b420b6bb0bbf880..a2ce9c7d367137853fcb242daa6a9ccde7dfb381 100644 (file)
--- a/README
+++ b/README
@@ -10,8 +10,7 @@ To use:
 
 - Your 2.6 kernel must have had CONFIG_HOTPLUG enabled when it was built.
 
 
 - Your 2.6 kernel must have had CONFIG_HOTPLUG enabled when it was built.
 
-- Make sure sysfs is mounted.  udev will figure out where sysfs is mounted, but
-  the traditional place for it is at /sys.  You can mount it by hand by running:
+- Make sure sysfs is mounted at /sys. You can mount it by running:
        mount -t sysfs none /sys
 
 - Make sure you have the latest version of the linux-hotplug scripts.  They are
        mount -t sysfs none /sys
 
 - Make sure you have the latest version of the linux-hotplug scripts.  They are
@@ -30,33 +29,42 @@ To use:
   Note:
       There are a number of different flags that you can use when building
       udev.  They are as follows:
   Note:
       There are a number of different flags that you can use when building
       udev.  They are as follows:
-       prefix - set this to the default root that you want udev to be
+       prefix
+               set this to the default root that you want udev to be
                installed into.  This works just like the 'configure --prefix'
                script does.  Default value is ''.  Only override this if you
                really know what you are doing.
                installed into.  This works just like the 'configure --prefix'
                script does.  Default value is ''.  Only override this if you
                really know what you are doing.
-       USE_KLIBC - if set to 'true', udev is built and linked against the included
-               version of klibc.  Default value is 'false'.
-       DEBUG - if set to 'true', debugging messages will be sent to the syslog
+       USE_KLIBC
+               if set to 'true', udev is built and linked against the
+               included version of klibc.  Default value is 'false'.
+       USE_LOG
+               if set to 'true', udev will emit messages to the syslog when
+               it creates or removes device nodes.  This is helpful to see
+               what udev is doing.  This is enabled by default.  Note, if you
+               are building udev against klibc it is recommended that you
+               disable this option (due to klibc's syslog implementation.)
+       USE_SELINUX
+               if set to 'true', udev will be built with SELinux support
+               enabled.  This is disabled by default.
+       DEBUG
+               if set to 'true', debugging messages will be sent to the syslog
                as udev is run.  Default value is 'false'.
                as udev is run.  Default value is 'false'.
-       USE_DBUS -  if set to 'true', DBUS messages will be sent everytime udev
-               creates or removes a device node.  This requires that DBUS
-               development headers and libraries be present on your system to
-               build properly.  Default value is 'false'.
+       KERNEL_DIR
+               If this is not set it will default to /lib/modules/`uname -r`/build
+               This is used if USE_KLIBC=true to find the kernel include
+               directory that klibc needs to build against.  This must be set
+               if you are not building udev while running a 2.6 kernel.
 
       So, if you want to build udev using klibc with debugging messages, you
       would do:
        make USE_KLIBC=true DEBUG=true
 
 
       So, if you want to build udev using klibc with debugging messages, you
       would do:
        make USE_KLIBC=true DEBUG=true
 
-      Note: If you want to use klibc, you will have to set up the "linux"
-            symlink properly.  See the file klibc/klibc/README and pay
-           attention to step "a)" there.
-
 - Install the project:
        make install
 
   This will put the udev binary in /sbin, create the /udev and /etc/udev
   directories, and place the udev configuration files in /etc/udev.  You
 - Install the project:
        make install
 
   This will put the udev binary in /sbin, create the /udev and /etc/udev
   directories, and place the udev configuration files in /etc/udev.  You
-  will probably want to edit the namedev.* files to create custom naming
+  will probably want to edit the *.rules files to create custom naming
   rules.  More info on how the config files are set up are contained in
   comments in the files, and is located in the documentation.
 
   rules.  More info on how the config files are set up are contained in
   comments in the files, and is located in the documentation.
 
@@ -83,5 +91,3 @@ know by sending a message to the linux-hotplug-devel mailing list at:
 greg k-h
 greg@kroah.com
 
 greg k-h
 greg@kroah.com
 
-
-