| commit | 786f6754b148911092782d0d5b92fa115ad47d32 | [log] [tgz] |
|---|---|---|
| author | Emil Velikov <emil.l.velikov@gmail.com> | Wed Jan 28 21:05:51 2026 +0000 |
| committer | Lucas De Marchi <demarchi@kernel.org> | Mon Feb 02 22:59:06 2026 -0600 |
| tree | 084df5e98bbe6b302879bb327aaef15c0f152107 | |
| parent | 8d87a3ca37d1e6c2a6c8517bd11bf1e31769156d [diff] |
libkmod/README.md: convert to markdown Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> Reviewed-by: Lucas De Marchi <demarchi@kernel.org> Link: https://github.com/kmod-project/kmod/pull/pull/417 Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
kmod is a set of tools to handle common tasks with Linux kernel modules like insert, remove, list, check properties, resolve dependencies and aliases.
These tools are designed on top of libkmod, a library that is shipped with kmod. See libkmod/README.md for more details on this library and how to use it. The aim is to be compatible with tools, configurations and indexes from module-init-tools project.
Mailing list (no subscription needed): linux-modules@vger.kernel.org
Mailing list archives: https://lore.kernel.org/linux-modules/
Signed packages: http://www.kernel.org/pub/linux/utils/kernel/kmod/
Git:
License:
LGPL-2.1-or-later for libkmod, testsuite and helper librariesGPL-2.0-or-later for tools/Irc: #kmod on irc.oftc.net
In order to compile the source code you need:
Optional dependencies, required with the default build configuration:
Typical configuration and installation
meson setup builddir/ meson compile -C builddir/ sudo meson install -C builddir/
For end-user and distributions builds, it's recommended to use:
meson setup --buildtype release builddir/
When working on kmod, use the included build-dev.ini file, as:
meson setup --native-file build-dev.ini builddir/
The testsuite can be executed with:
meson test -C builddir
It builds test kernel modules, so kernel headers need to be pre-installed. By default it tries to use the kernel header for the currently running kernel. KDIR=any environment variable can be used to tell it to use any installed kernel header or KDIR=/path/to/specific/headers when a specific one is needed. Example:
KDIR=any meson test -C builddir
Make sure to read our contributing guide and the other READMEs: libkmod and testsuite.
kmod replaced module-init-tools, which was EOL'ed in 2011. All the tools were rewritten on top of libkmod and they can be used as drop in replacements. Along the years there were a few behavior changes and new features implemented, following feedback from Linux kernel community and distros.