README

   1 kmod - Linux kernel module handling
   2
   3 OVERVIEW
   4 ========
   5
   6 kmod is a set of tools to handle common tasks with Linux kernel modules like
   7 insert, remove, list, check properties, resolve dependencies and aliases.
   8
   9 These tools are designed on top of libkmod, a library that is shipped with
  10 kmod. See libkmod/README for more details on this library and how to use it.
  11 The aim is to be compatible with tools, configurations and indexes from
  12 module-init-tools project.
  13
  14 Compilation and installation
  15 ============================
  16
  17 In order to compiler the source code you need following software packages:
  18         - GCC compiler
  19         - GNU C library
  20
  21 Optional dependencies:
  22         - ZLIB library
  23         - LZMA library
  24
  25 Typical configuration:
  26         ./configure CFLAGS="-g -O2" --prefix=/usr \
  27                         --sysconfdir=/etc --libdir=/usr/lib
  28
  29 Configure automatically searches for all required components and packages.
  30
  31 To compile and install run:
  32         make && make install
  33
  34 Hacking
  35 =======
  36
  37 Run 'bootstrap' script before configure. If you want to accept the recommended
  38 flags, you just need to run 'bootstrap-configure'.
  39
  40 Make sure to read the CODING-STYLE file and the other READMEs: libkmod/README
  41 and testsuite/README.
  42
  43 Information
  44 ===========
  45
  46 Signed packages:
  47         http://www.kernel.org/pub/linux/utils/kernel/kmod/
  48
  49 Mailing list:
  50         linux-modules@vger.kernel.org
  51
  52 Git:
  53         git://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git
  54         http://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git
  55         https://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git
  56
  57 Gitweb:
  58         http://git.kernel.org/?p=utils/kernel/kmod/kmod.git
  59
  60 Irc:
  61         #kmod on irc.freenode.org