blob: 65499cc09287e22e90a81f6b37d7725f995266d4 [file] [log] [blame]
Lucas De Marchicb48c9b2011-12-12 16:41:38 -02001kmod - Linux kernel module handling
Gustavo Sverzut Barbieri91b44c72011-12-02 21:05:38 -02002
3OVERVIEW
4========
5
Lucas De Marchicb48c9b2011-12-12 16:41:38 -02006kmod is a set of tools to handle common tasks with Linux kernel modules like
7insert, remove, list, check properties, resolve dependencies and aliases.
Gustavo Sverzut Barbieri91b44c72011-12-02 21:05:38 -02008
Lucas De Marchicb48c9b2011-12-12 16:41:38 -02009These tools are designed on top of libkmod, a library that is shipped with
10kmod. See libkmod/README for more details on this library and how to use it.
11The aim is to be compatible with tools, configurations and indexes from
12module-init-tools project.
Lucas De Marchidd420602012-01-09 13:15:46 -020013
14Compilation and installation
15============================
16
17In order to compiler the source code you need following software packages:
18 - GCC compiler
19 - GNU C library
20
21Optional dependencies:
22 - ZLIB library
23 - LZMA library
24
25Typical configuration:
26 ./configure CFLAGS="-g -O2" --prefix=/usr \
27 --sysconfdir=/etc --libdir=/usr/lib
28
29Configure automatically searches for all required components and packages.
30
31To compile and install run:
32 make && make install
33
Lucas De Marchi3bf8d4b2012-01-12 18:31:10 -020034Hacking
35=======
36
37Run 'bootstrap' script before configure. If you want to accept the recommended
38flags, you just need to run 'bootstrap-configure'.
39
Lucas De Marchi314719c2012-03-21 22:26:03 -030040Make sure to read the CODING-STYLE file and the other READMEs: libkmod/README
41and testsuite/README.
Lucas De Marchi3bf8d4b2012-01-12 18:31:10 -020042
Lucas De Marchidd420602012-01-09 13:15:46 -020043Information
44===========
45
Lucas De Marchi1b3cd9d2012-01-23 12:29:38 -020046Signed packages:
Lucas De Marchibb05bc82012-02-24 01:58:20 -020047 http://www.kernel.org/pub/linux/utils/kernel/kmod/
Lucas De Marchi1b3cd9d2012-01-23 12:29:38 -020048
Lucas De Marchidd420602012-01-09 13:15:46 -020049Mailing list:
Lucas De Marchif38e68a2012-07-31 09:58:21 -030050 linux-modules@vger.kernel.org (no subscription needed)
Lucas De Marchidd420602012-01-09 13:15:46 -020051
Lucas De Marchibb05bc82012-02-24 01:58:20 -020052Git:
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
57Gitweb:
58 http://git.kernel.org/?p=utils/kernel/kmod/kmod.git
59
60Irc:
61 #kmod on irc.freenode.org