]>
Commit | Line | Data |
---|---|---|
cb48c9b2 | 1 | kmod - Linux kernel module handling |
91b44c77 | 2 | |
1dd4ff56 LDM |
3 | Information |
4 | =========== | |
5 | ||
0d833715 LDM |
6 | Build status: |
7 | [![Build Status](https://semaphoreci.com/api/v1/projects/29d989ba-0f70-4006-be21-550f6692b73b/449920/shields_badge.svg)](https://semaphoreci.com/lucasdemarchi/kmod) | |
8 | ||
1dd4ff56 LDM |
9 | Mailing list: |
10 | linux-modules@vger.kernel.org (no subscription needed) | |
11 | ||
12 | Signed packages: | |
13 | http://www.kernel.org/pub/linux/utils/kernel/kmod/ | |
14 | ||
15 | Git: | |
16 | git://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git | |
17 | http://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git | |
18 | https://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git | |
19 | ||
20 | Gitweb: | |
21 | http://git.kernel.org/?p=utils/kernel/kmod/kmod.git | |
22 | ||
23 | Irc: | |
24 | #kmod on irc.freenode.org | |
25 | ||
26 | License: | |
27 | LGPLv2.1+ for libkmod, testsuite and helper libraries | |
28 | GPLv2+ for tools/* | |
29 | ||
30 | ||
91b44c77 GSB |
31 | OVERVIEW |
32 | ======== | |
33 | ||
cb48c9b2 LDM |
34 | kmod is a set of tools to handle common tasks with Linux kernel modules like |
35 | insert, remove, list, check properties, resolve dependencies and aliases. | |
91b44c77 | 36 | |
cb48c9b2 LDM |
37 | These tools are designed on top of libkmod, a library that is shipped with |
38 | kmod. See libkmod/README for more details on this library and how to use it. | |
39 | The aim is to be compatible with tools, configurations and indexes from | |
40 | module-init-tools project. | |
dd420605 LDM |
41 | |
42 | Compilation and installation | |
43 | ============================ | |
44 | ||
45 | In order to compiler the source code you need following software packages: | |
46 | - GCC compiler | |
47 | - GNU C library | |
48 | ||
49 | Optional dependencies: | |
50 | - ZLIB library | |
51 | - LZMA library | |
52 | ||
53 | Typical configuration: | |
54 | ./configure CFLAGS="-g -O2" --prefix=/usr \ | |
55 | --sysconfdir=/etc --libdir=/usr/lib | |
56 | ||
57 | Configure automatically searches for all required components and packages. | |
58 | ||
59 | To compile and install run: | |
60 | make && make install | |
61 | ||
3bf8d4b0 LDM |
62 | Hacking |
63 | ======= | |
64 | ||
65 | Run 'bootstrap' script before configure. If you want to accept the recommended | |
4cce76eb LA |
66 | flags, you just need to run 'bootstrap-configure'. Note that the recommended |
67 | flags require cython be installed to compile successfully. | |
3bf8d4b0 | 68 | |
314719c5 LDM |
69 | Make sure to read the CODING-STYLE file and the other READMEs: libkmod/README |
70 | and testsuite/README. | |
3bf8d4b0 | 71 | |
cd923111 LDM |
72 | Compatibility with module-init-tools |
73 | ==================================== | |
74 | ||
75 | kmod replaces module-init-tools, which is end-of-life. Most of its tools are | |
76 | rewritten on top of libkmod so it can be used as a drop in replacements. | |
77 | Somethings however were changed. Reasons vary from "the feature was already | |
78 | long deprecated on module-init-tools" to "it would be too much trouble to | |
79 | support it". | |
80 | ||
81 | There are several features that are being added in kmod, but we don't | |
82 | keep track of them here. | |
83 | ||
84 | modprobe | |
85 | -------- | |
86 | ||
87 | * 'modprobe -l' was marked as deprecated and does not exist anymore | |
88 | ||
89 | * 'modprobe -t' is gone, together with 'modprobe -l' | |
90 | ||
91 | * modprobe doesn't parse configuration files with names not ending in | |
92 | '.alias' or '.conf'. modprobe used to warn about these files. | |
93 | ||
94 | * modprobe doesn't parse 'config' and 'include' commands in configuration | |
95 | files. | |
96 | ||
97 | * modprobe from m-i-t does not honour softdeps for install commands. E.g.: | |
98 | config: | |
99 | ||
100 | install bli "echo bli" | |
101 | install bla "echo bla" | |
102 | softdep bla pre: bli | |
103 | ||
104 | With m-i-t, the output of 'modprobe --show-depends bla' will be: | |
105 | install "echo bla" | |
106 | ||
107 | While with kmod: | |
108 | install "echo bli" | |
109 | install "echo bla" | |
110 | ||
111 | * kmod doesn't dump the configuration as is in the config files. Instead it | |
112 | dumps the configuration as it was parsed. Therefore, comments and file names | |
113 | are not dumped, but on the good side we know what the exact configuration | |
114 | kmod is using. We did this because if we only want to know the entire content | |
115 | of configuration files, it's enough to use find(1) in modprobe.d directories | |
116 | ||
117 | depmod | |
118 | ------ | |
119 | ||
120 | * there's no 'depmod -m' option: legacy modules.*map files are gone | |
121 | ||
122 | lsmod | |
123 | ----- | |
124 | ||
125 | * module-init-tools used /proc/modules to parse module info. kmod uses | |
126 | /sys/module/*, but there's a fallback to /proc/modules if the latter isn't | |
127 | available |