Go to file
Lucas De Marchi b5a2cd070d Use SPDX header for license
Drop the lengthy license from each file and just use SPDX like most
projects nowadays. This doesn't have any change to license, just how
they are recorded in each file.

This follows the kernel approach: header files use '/*' for comments
while .c files use '//'. For .m4, use "#".

Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://lore.kernel.org/r/20240723185921.1005569-2-lucas.de.marchi@gmail.com
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-26 13:41:56 -05:00
.github ci: Add Alpine 2024-07-17 12:37:51 -05:00
libkmod Use SPDX header for license 2024-07-26 13:41:56 -05:00
m4 Use SPDX header for license 2024-07-26 13:41:56 -05:00
man man: list options one per line 2024-07-09 00:18:21 -05:00
shared Use SPDX header for license 2024-07-26 13:41:56 -05:00
shell-completion/bash Use SPDX header for license 2024-07-26 13:41:56 -05:00
testsuite Use SPDX header for license 2024-07-26 13:41:56 -05:00
tools Use SPDX header for license 2024-07-26 13:41:56 -05:00
.gitignore gitignore: ignore gtk-doc.m4 2024-07-03 10:14:47 -05:00
.mailmap .mailmap: Forward to my personal email 2024-06-14 13:49:03 -05:00
autogen.sh Drop python bindings 2024-02-02 12:54:04 -06:00
CODING-STYLE CODING-STYLE: add include order 2015-01-14 12:35:04 -02:00
configure.ac libkmod: Move zstd-related functions to separate file 2024-07-26 13:41:47 -05:00
COPYING Clarify what licences apply where 2014-10-09 01:26:34 -03:00
Makefile.am libkmod: Move zstd-related functions to separate file 2024-07-26 13:41:47 -05:00
NEWS kmod 32 2024-03-05 21:27:42 -06:00
README.md README: update to a decade+ later 2024-07-17 12:28:36 -05:00
TODO libkmod-module: check for NULL before accessing pointers 2018-04-05 14:54:43 -07:00

kmod - Linux kernel module handling

Coverity Scan Status

Information

Mailing list: linux-modules@vger.kernel.org (no subscription needed) https://lore.kernel.org/linux-modules/

Signed packages: http://www.kernel.org/pub/linux/utils/kernel/kmod/

Git: git://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git http://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git https://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git

Gitweb: http://git.kernel.org/?p=utils/kernel/kmod/kmod.git https://github.com/kmod-project/kmod

Irc: #kmod on irc.freenode.org

License: LGPLv2.1+ for libkmod, testsuite and helper libraries GPLv2+ for tools/*

OVERVIEW

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 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.

Compilation and installation

In order to compile the source code you need the following software packages: - GCC/CLANG compiler - GNU C library / musl / uClibc

Optional dependencies: - ZLIB library - LZMA library - ZSTD library - OPENSSL library (signature handling in modinfo)

Typical configuration: ./configure CFLAGS="-g -O2" --prefix=/usr
--sysconfdir=/etc --libdir=/usr/lib

Configure automatically searches for all required components and packages.

To compile and install run: make && make install

Hacking

Run 'autogen.sh' script before configure. If you want to accept the recommended flags, you just need to run autogen.sh c.

Make sure to read the CODING-STYLE file and the other READMEs: libkmod/README and testsuite/README.

Compatibility with module-init-tools

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.