chiark / gitweb /
rules: implement TAGS== match
[elogind.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 17cd7b683f70d8ca36ba58d60d53aae742df27b0..5d3087e4383de3b470d1edea7b5b59743a6c1ef9 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,44 +1,73 @@
-  ./configure
-    --prefix=
-        "/usr" - prefix for man pages, include files
-    --exec-prefix=
-        "" - the root filesystem, prefix for libs and binaries
-    --sysconfdir=
-        "/etc"
-    --with-libdir-name=
-        "lib" - directory name for libraries, not a path name
-        multilib 64bit systems may use "lib64" instead of "lib"
-    --enable-debug
-        compile-in verbose debug messages
-    --disable-logging
-        disable all logging and compile-out all log strings
+Usual options for udev installed in the root filesystem are:
+  ./configure \
+    --prefix=/usr \
+    --sysconfdir=/etc \
+    --sbindir=/sbin \
+    --libdir=/usr/lib64 \
+    --with-rootlibdir=/lib64 \
+    --libexecdir=/lib/udev \
     --with-selinux
     --with-selinux
-        link against SELInux libraries to set the expected context
-        for created files
 
 
-The installation directories are controlled by $prefix, $exec_prefix
-$sysconfdir and $libdir-name. Documentation, development files are
-installed below $prefix, binaries are installed below $exec_prefix,
-libraries below $exec_prefix/$libdir-name.
+All options:
+  --prefix=
+      Usually /usr, prefix for man pages, include files.
+  --sysconfdir=
+      Usually /etc.
+  --sbindir=
+      Usually /sbin, the place for udevd and udevadm.
+  --libexecdir=
+      Usually /lib/udev, the udev private directory.
+  --enable-debug
+      Compile-in verbose debug messages. Usually not needed,
+      it increases the size of the binaries.
+  --disable-logging
+      Disable all logging and compile-out all log strings. This
+      is not recommended, as it makes it almost impossible to debug
+      udev on the running system.
+  --with-selinux
+      Link against SELinux libraries to set the expected context
+      for created files.
+  --disable-rule_generator
+      Disable persistent network, cdrom naming support.
+  --disable-hwdb
+      Disable hardware database support
+  --disable-udev_acl
+      Disable local user acl permissions support.
+  --disable-gudev
+      Disable Gobject libudev support.
+  --disable-introspection
+      Disable Gobject introspection support.
+  --disable-keymap
+      Disable keymap fixup support.
+  --enable-floppy
+      Enable legacy floppy support.
+  --enable-edd
+      Enable disk edd support.
+  --enable-action_modeswitch
+      Enable action modeswitch support.
 
 
-The default configuration for a RPM spec file may look like:
-  --prefix=%{_prefix}
-  --exec-prefix=""
-  --sysconfdir=%{_sysconfdir}
-  --with-libdir-name=%{_lib}
+The options used in a RPM spec file usually look like:
+  %configure \
+    --prefix=%{_prefix} \
+    --sysconfdir=%{_sysconfdir} \
+    --sbindir=/sbin \
+    --libdir=%{_libdir} \
+    --with-rootlibdir=/%{_lib} \
+    --libexecdir=/lib/udev \
+    --with-selinux
 
 
-The well defined location for scripts and binaries which are called
-from rules is /lib/udev/ on all systems and architectures, anything
-else is broken. Other packages who use udev, may use the /lib/udev/
-directory to install their rule helper and udev rule files.
+The defined location for scripts and binaries which are called
+from rules is /lib/udev/ on all systems and architectures. Any
+other location will break other packages, who rightfully expect
+the /lib/udev/ directory, to install their rule helper and udev
+rule files.
 
 
-It is recommended to use the /lib/udev/devices/ directory to place
+It is possible to use the /lib/udev/devices/ directory to place
 device nodes, directories and symlinks, which are copied to /dev/
 at every bootup. That way, nodes for devices which can not be
 detected automatically, or are activated on-demand by opening the
 pre-existing device node, will be available.
 
 device nodes, directories and symlinks, which are copied to /dev/
 at every bootup. That way, nodes for devices which can not be
 detected automatically, or are activated on-demand by opening the
 pre-existing device node, will be available.
 
-Default udev rules and persistent device naming rules are required
+Default udev rules and persistent device naming rules may be required
 by other software that depends on the data udev collects from the
 by other software that depends on the data udev collects from the
-devices, and should therefore be installed by default with every udev
-installation.
+devices.