Debian Codegraph @

upstream/debian-unstable/man8/modinfo.8

raw
1 .\" Generated by scdoc 1.11.4
2 .\" Complete documentation for this program is not available as a GNU info page
3 .ie \n(.g .ds Aq \(aq
4 .el .ds Aq '
5 .nh
6 .ad l
7 .\" Begin generated content:
8 .TH "MODINFO" "8" "2026-04-26" "kmod" "modinfo"
9 .PP
10 .SH NAME
11 .PP
12 modinfo - Show information about a Linux Kernel module
13 .PP
14 .SH SYNOPSIS
15 .PP
16 \fBmodinfo\fR [\fB-0\fR] [\fB-F\fR \fIfield\fR] [\fB-k\fR \fIkernel\fR] [modulename|filename.\&.\&.\&]
17 .PP
18 \fBmodinfo\fR \fB-V\fR
19 .PP
20 \fBmodinfo\fR \fB-h\fR
21 .PP
22 .SH DESCRIPTION
23 .PP
24 \fBmodinfo\fR extracts information from the Linux Kernel modules given on the
25 command line.\& If the module name is not a filename, then the /lib/modules/
26 \fIversion\fR directory is searched, as is also done by \fBmodprobe\fR(8) when loading
27 kernel modules.\&
28 .PP
29 \fBmodinfo\fR by default lists each attribute of the module in form \fIfieldname\fR :
30 \fIvalue\fR, for easy reading.\& The filename is listed the same way (although it'\&s
31 not really an attribute).\&
32 .PP
33 This version of \fBmodinfo\fR can understand modules of any Linux Kernel
34 architecture.\&
35 .PP
36 .SH OPTIONS
37 .PP
38 \fB-V\fR, \fB--version\fR
39 .RS 4
40 Print the \fBmodinfo\fR version.\&
41 .PP
42 .RE
43 \fB-F\fR \fIfield\fR, \fB--field\fR=\fIfield\fR
44 .RS 4
45 Only print this \fIfield\fR value, one per line.\& This is most useful for
46 scripts.\& Field names are case-insensitive.\& Common fields (which may not
47 be in every module) include author, description, license, parm, depends,
48 and alias.\& There are often multiple parm, alias and depends fields.\& The
49 special \fIfield\fR filename lists the filename of the module.\&
50 .PP
51 .RE
52 \fB-b\fR \fIbasedir\fR, \fB--basedir\fR=\fIbasedir\fR
53 .RS 4
54 Root directory for modules, / by default.\&
55 .PP
56 .RE
57 \fB-k\fR \fIkernel\fR
58 .RS 4
59 Provide information about a kernel other than the running one.\& This is
60 particularly useful for distributions needing to extract information
61 from a newly installed (but not yet running) set of kernel modules.\& For
62 example, you wish to find which firmware files are needed by various
63 modules in a new kernel for which you must make an initrd/initramfs
64 image prior to booting.\&
65 .PP
66 .RE
67 \fB-0\fR, \fB--null\fR
68 .RS 4
69 Use the ASCII zero character to separate \fIfield\fR values, instead of a new
70 line.\& This is useful for scripts, since a new line can theoretically
71 appear inside a \fIfield\fR.\&
72 .PP
73 .RE
74 \fB-a\fR \fB--author\fR, \fB-d\fR \fB--description\fR, \fB-l\fR \fB--license\fR, \fB-p\fR \fB--parameters\fR, \fB-n\fR \fB--filename\fR
75 .RS 4
76 These are shortcuts for the \fB--field\fR flag'\&s author, description,
77 license, parm and filename arguments, to ease the transition from the
78 old modutils \fBmodinfo\fR.\&
79 .PP
80 .RE
81 \fB-h\fR, \fB--help\fR
82 .RS 4
83 Print the help message and exit.\&
84 .PP
85 .RE
86 .SH COPYRIGHT
87 .PP
88 This manual page originally Copyright 2003, Rusty Russell, IBM Corporation.\&
89 .PP
90 .SH SEE ALSO
91 .PP
92 \fBmodprobe\fR(8)
93 .PP
94 .SH BUGS
95 .PP
96 Please direct any bug reports to kmod'\&s issue tracker at
97 https://github.\&com/kmod-project/kmod/issues/ alongside with version used, steps
98 to reproduce the problem and the expected outcome.\&
99 .PP
100 .SH AUTHORS
101 .PP
102 Numerous contributions have come from the linux-modules mailing list
103 <linux-modules@vger.\&kernel.\&org> and Github.\& If you have a clone of kmod.\&git
104 itself, the output of \fBgit-shortlog\fR(1) and \fBgit-blame\fR(1) can show you the
105 authors for specific parts of the project.\&
106 .PP
107 \fBLucas De Marchi\fR <lucas.\&de.\&marchi@gmail.\&com> is the current maintainer of the
108 project.\&