3 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5 <refentry id=
"modinfo">
8 <productname>kmod
</productname>
12 <contrib>Developer
</contrib>
13 <firstname>Jon
</firstname>
14 <surname>Masters
</surname>
15 <email>jcm@jonmasters.org
</email>
18 <contrib>Developer
</contrib>
19 <firstname>Lucas
</firstname>
20 <surname>De Marchi
</surname>
21 <email>lucas.de.marchi@gmail.com
</email>
27 <refentrytitle>modinfo
</refentrytitle>
28 <manvolnum>8</manvolnum>
32 <refname>modinfo
</refname>
33 <refpurpose>Show information about a Linux Kernel module
</refpurpose>
38 <command>modinfo
</command>
39 <arg><option>-
0</option></arg>
40 <arg><option>-F
<replaceable>field
</replaceable></option></arg>
41 <arg><option>-k
<replaceable>kernel
</replaceable></option></arg>
42 <arg rep='repeat'
>modulename|filename
</arg>
45 <command>modinfo -V
</command>
48 <command>modinfo -h
</command>
52 <refsect1><title>DESCRIPTION
</title>
54 <command>modinfo
</command> extracts information from the Linux Kernel
55 modules given on the command line. If the module name is not a filename,
57 <filename>/lib/modules/
</filename><replaceable>version
</replaceable>
58 directory is searched, as is also done by
59 <citerefentry><refentrytitle>modprobe
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
60 when loading kernel modules.
63 <command>modinfo
</command> by default lists each attribute of the module
64 in form
<replaceable>fieldname
</replaceable> :
65 <replaceable>value
</replaceable>, for easy reading. The filename is
66 listed the same way (although it's not really an attribute).
69 This version of
<command>modinfo
</command> can understand modules of any
70 Linux Kernel architecture.
74 <refsect1><title>OPTIONS
</title>
81 <option>--version
</option>
85 Print the modinfo version.
94 <option>--field
</option>
98 Only print this field value, one per line. This is most useful for
99 scripts. Field names are case-insensitive. Common fields (which
100 may not be in every module) include
<literal>author
</literal>,
101 <literal>description
</literal>,
<literal>license
</literal>,
102 <literal>parm
</literal>,
<literal>depends
</literal>, and
103 <literal>alias
</literal>. There are often multiple
104 <literal>parm
</literal>,
<literal>alias
</literal> and
105 <literal>depends
</literal> fields. The special field
106 <literal>filename
</literal> lists the filename of the module.
112 <option>-b
<replaceable>basedir
</replaceable></option>
115 <option>--basedir
<replaceable>basedir
</replaceable></option>
119 Root directory for modules,
<filename>/
</filename> by default.
125 <option>-k
<replaceable>kernel
</replaceable></option>
129 Provide information about a kernel other than the running one. This
130 is particularly useful for distributions needing to extract
131 information from a newly installed (but not yet running) set of
132 kernel modules. For example, you wish to find which firmware files
133 are needed by various modules in a new kernel for which you must
134 make an initrd/initramfs image prior to booting.
143 <option>--null
</option>
147 Use the ASCII zero character to separate field values, instead of a
148 new line. This is useful for scripts, since a new line can
149 theoretically appear inside a field.
156 <option>--author
</option>
160 <option>--description
</option>
164 <option>--license
</option>
168 <option>--parameters
</option>
172 <option>--filename
</option>
176 These are shortcuts for the
<option>--field
</option> flag's
177 <literal>author
</literal>,
<literal>description
</literal>,
178 <literal>license
</literal>,
<literal>parm
</literal> and
179 <literal>filename
</literal> arguments, to ease the transition
180 from the old modutils
<command>modinfo
</command>.
187 <refsect1><title>COPYRIGHT
</title>
189 This manual page originally Copyright
2003, Rusty Russell, IBM
190 Corporation. Maintained by Jon Masters and others.
194 <refsect1><title>SEE ALSO
</title>
197 <refentrytitle>modprobe
</refentrytitle><manvolnum>8</manvolnum>