| .\\" auto-generated by docbook2man-spec $Revision: 1.2 $ |
| .TH "MODINFO" "8" "2010-03-01" "" "" |
| .SH NAME |
| modinfo \- program to show information about a Linux Kernel module |
| .SH SYNOPSIS |
| .sp |
| \fBmodinfo\fR [ \fB-0\fR ] [ \fB-F \fIfield\fB\fR ] [ \fB-k \fIkernel\fB\fR ] [ \fBmodulename|filename\fR\fI...\fR ] |
| .sp |
| \fBmodinfo -V\fR |
| .sp |
| \fBmodinfo -h\fR |
| .SH "DESCRIPTION" |
| .PP |
| \fBmodinfo\fR extracts information from the Linux |
| Kernel modules given on the command line. If the module name is |
| not a filename, then the |
| \fI/lib/modules/\fR\fIversion\fR |
| directory is searched, as is also done by |
| \fBmodprobe\fR(8) when loading kernel modules. |
| .PP |
| \fBmodinfo\fR by default lists each attribute |
| of the module in form \fIfieldname\fR : |
| \fIvalue\fR, for easy reading. The |
| filename is listed the same way (although it's not really an |
| attribute). |
| .PP |
| This version of \fBmodinfo\fR can understand |
| modules of any Linux Kernel architecture. |
| .SH "OPTIONS" |
| .TP |
| \fB-V --version\fR |
| Print the modinfo version. |
| .TP |
| \fB-F --field\fR |
| Only print this field value, one per line. This is most |
| useful for scripts. Field names are case-insenitive. |
| Common fields (which may not be in every module) include |
| author, description, |
| license, parm, |
| depends, and alias\&. |
| There are often multiple parm, |
| alias and depends |
| fields. The special field filename |
| lists the filename of the module. |
| .TP |
| \fB-k \fIkernel\fB\fR |
| Provide information about a kernel other than the running one. This |
| is particularly useful for distributions needing to extract |
| information from a newly installed (but not yet running) set of |
| kernel modules. For example, you wish to find which firmware files |
| are needed by various modules in a new kernel for which you must |
| make an initrd/initramfs image prior to booting. |
| .TP |
| \fB-0 --null\fR |
| Use the ASCII zero character to separate field values, |
| instead of a new line. This is useful for scripts, since |
| a new line can theoretically appear inside a field. |
| .TP |
| \fB-a -d -l -p -n\fR |
| These are shortcuts for author, |
| description, |
| license\&. parm and |
| filename respectively, to ease the |
| transition from the old modutils |
| \fBmodinfo\fR\&. |
| .SH "COPYRIGHT" |
| .PP |
| This manual page originally Copyright 2003, Rusty Russell, IBM |
| Corporation. Maintained by Jon Masters and others. |
| .SH "SEE ALSO" |
| .PP |
| \fBmodprobe\fR(8) |
