[Summary view] [Print] [Text view]

   1  .\" This manpage has been automatically generated by docbook2man 
   2  .\" from a DocBook document.  This tool can be found at:
   3  .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
   4  .\" Please send any bug reports, improvements, comments, patches, 
   5  .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6  .TH "MODINFO" "8" "13 October 2008" "" ""
   7  
   8  .SH NAME
   9  modinfo \- program to show information about a Linux Kernel module
  10  .SH SYNOPSIS
  11  
  12  \fBmodinfo\fR [ \fB-0\fR ] [ \fB-F \fIfield\fB\fR ] [ \fB-k \fIkernel\fB\fR ] [ \fBmodulename|filename\fR\fI ...\fR ]
  13  
  14  
  15  \fBmodinfo -V\fR
  16  
  17  
  18  \fBmodinfo -h\fR
  19  
  20  .SH "DESCRIPTION"
  21  .PP
  22  \fBmodinfo\fR extracts information from the Linux
  23  Kernel modules given on the command line.  If the module name is
  24  not a filename, then the
  25  \fI/lib/modules/\fR\fIversion\fR
  26  directory is searched, as done by
  27  \fBmodprobe\fR(8)\&.
  28  .PP
  29  \fBmodinfo\fR by default lists each attribute
  30  of the module in form \fIfieldname\fR :
  31  \fIvalue\fR, for easy reading.  The
  32  filename is listed the same way (although it's not really an
  33  attribute).
  34  .PP
  35  This version of \fBmodinfo\fR can understand
  36  modules of any Linux Kernel architecture.
  37  .SH "OPTIONS"
  38  .TP
  39  \fB-V --version \fR
  40  Print the modinfo version.  Note BACKWARDS COMPATIBILITY
  41  below: you might be printing the version of
  42  \fBmodinfo.old\fR\&.
  43  .TP
  44  \fB-F --field \fR
  45  Only print this field value, one per line.  This is most
  46  useful for scripts.  Field names are case-insenitive.
  47  Common fields (which may not be in every module) include
  48  author, description,
  49  license, param,
  50  depends, and alias\&.
  51  There are often multiple param,
  52  alias and depends
  53  fields.  The special field filename
  54  lists the filename of the module.
  55  .TP
  56  \fB-k \fIkernel\fB \fR
  57  Provide information about a kernel other than the running one. This
  58  is particularly useful for distributions needing to extract
  59  information from a newly installed (but not yet running) set of
  60  kernel modules. For example, you wish to find which firmware files
  61  are needed by various modules in a new kernel for which you must
  62  make an initrd image prior to booting.
  63  .TP
  64  \fB-0 --null \fR
  65  Use the ASCII zero character to separate field values,
  66  instead of a new line.  This is useful for scripts, since
  67  a new line can theoretically appear inside a field.
  68  .TP
  69  \fB-a -d -l -p -n \fR
  70  These are shortcuts for author,
  71  description,
  72  license\&.  param and
  73  filename respectively, to ease the
  74  transition from the old modutils
  75  \fBmodinfo\fR\&.
  76  .SH "BACKWARDS COMPATIBILITY"
  77  .PP
  78  This version of \fBmodinfo\fR is for kernel
  79  modules 2.5.48 and above.  If it detects a
  80  kernel with support for old-style modules, it will attempt to
  81  run \fBmodprobe.old\fR in its place, so it is
  82  completely transparent to the user.
  83  .PP
  84  Note that the output of this version of
  85  \fBmodinfo\fR is simpler and more regular than
  86  the older version: scripts attempting to use the default
  87  output may get confused with complex fields.
  88  .PP
  89  You can force the new \fBmodinfo\fR to always
  90  be used, by setting the NEW_MODINFO
  91  environment variable.
  92  .SH "COPYRIGHT"
  93  .PP
  94  This manual page Copyright 2003, Rusty Russell, IBM Corporation.
  95  .SH "SEE ALSO"
  96  .PP
  97  \fBmodprobe\fR(8),
  98  \fBmodinfo.old\fR(8)