doc/modinfo.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2   <!ENTITY debian  "<productname>Debian GNU/Linux</productname>">
   3   <!ENTITY docbook "<productname>DocBook</productname>">
   4   <!ENTITY sgml    "<abbrev>SGML</abbrev>">
   5 ]>
   6
   7 <!-- Stolen from manual page for docbook-to-man, DocBook source file
   8      (C) 1999 W. Borgert debacle@debian.org
   9
  10      $Id: docbook-to-man.sgml,v 1.8 2002/04/27 15:28:02 debacle Exp $ -->
  11
  12 <refentry>
  13   <refentryinfo>
  14     <address>
  15       <email>rusty@rustcorp.com.au</email>
  16     </address>
  17     <author>
  18       <firstname>Rusty</firstname>
  19       <surname>Russell</surname>
  20     </author>
  21     <date>2003-05-9</date>
  22   </refentryinfo>
  23   <refmeta>
  24     <refentrytitle>modinfo</refentrytitle>
  25     <manvolnum>8</manvolnum>
  26   </refmeta>
  27   <refnamediv>
  28     <refname>modinfo</refname> <refpurpose>program to show information about a Linux Kernel module</refpurpose>
  29   </refnamediv>
  30   <refsynopsisdiv>
  31     <cmdsynopsis>
  32       <command>modinfo</command>
  33       <arg><option>-0</option></arg>
  34       <arg><option>-F <replaceable>field</replaceable></option></arg>
  35       <arg><option>-k <replaceable>kernel</replaceable></option></arg>
  36       <arg rep='repeat'>modulename|filename</arg>
  37     </cmdsynopsis>
  38     <cmdsynopsis>
  39       <command>modinfo -V</command>
  40     </cmdsynopsis>
  41     <cmdsynopsis>
  42       <command>modinfo -h</command>
  43     </cmdsynopsis>
  44   </refsynopsisdiv>
  45   <refsect1>
  46     <title>DESCRIPTION</title>
  47
  48     <para><command>modinfo</command> extracts information from the Linux
  49       Kernel modules given on the command line.  If the module name is
  50       not a filename, then the
  51       <filename>/lib/modules/</filename><replaceable>version</replaceable>
  52       directory is searched, as done by
  53       <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  54     </para>
  55
  56     <para><command>modinfo</command> by default lists each attribute
  57       of the module in form <replaceable>fieldname</replaceable> :
  58       <replaceable>value</replaceable>, for easy reading.  The
  59       filename is listed the same way (although it's not really an
  60       attribute).
  61     </para>
  62
  63     <para>This version of <command>modinfo</command> can understand
  64     modules of any Linux Kernel architecture.</para>
  65   </refsect1>
  66   <refsect1>
  67     <title>OPTIONS</title>
  68     <variablelist>
  69       <varlistentry>
  70         <term><option>-V</option> <option>--version</option>
  71         </term>
  72         <listitem>
  73           <para>
  74             Print the modinfo version.  Note BACKWARDS COMPATIBILITY
  75             below: you might be printing the version of
  76             <command>modinfo.old</command>.
  77           </para>
  78         </listitem>
  79       </varlistentry>
  80       <varlistentry>
  81         <term><option>-F</option> <option>--field</option>
  82         </term>
  83         <listitem>
  84           <para>
  85             Only print this field value, one per line.  This is most
  86             useful for scripts.  Field names are case-insenitive.
  87             Common fields (which may not be in every module) include
  88             <literal>author</literal>, <literal>description</literal>,
  89             <literal>license</literal>, <literal>param</literal>,
  90             <literal>depends</literal>, and <literal>alias</literal>.
  91             There are often multiple <literal>param</literal>,
  92             <literal>alias</literal> and <literal>depends</literal>
  93             fields.  The special field <literal>filename</literal>
  94             lists the filename of the module.
  95           </para>
  96         </listitem>
  97       </varlistentry>
  98       <varlistentry>
  99         <term><option>-k <replaceable>kernel</replaceable></option>
 100         </term>
 101           <para>
 102             Provide information about a kernel other than the running one. This
 103             is particularly useful for distributions needing to extract
 104             information from a newly installed (but not yet running) set of
 105             kernel modules. For example, you wish to find which firmware files
 106             are needed by various modules in a new kernel for which you must
 107             make an initrd image prior to booting.
 108           </para>
 109         </term>
 110       </varlistentry>
 111       <varlistentry>
 112         <term><option>-0</option> <option>--null</option>
 113         </term>
 114         <listitem>
 115           <para>
 116             Use the ASCII zero character to separate field values,
 117             instead of a new line.  This is useful for scripts, since
 118             a new line can theoretically appear inside a field.
 119           </para>
 120         </listitem>
 121       </varlistentry>
 122       <varlistentry>
 123         <term><option>-a</option> <option>-d</option> <option>-l</option> <option>-p</option> <option>-n</option>
 124         </term>
 125         <listitem>
 126           <para>
 127             These are shortcuts for <literal>author</literal>,
 128             <literal>description</literal>,
 129             <literal>license</literal>.  <literal>param</literal> and
 130             <literal>filename</literal> respectively, to ease the
 131             transition from the old modutils
 132             <command>modinfo</command>.
 133           </para>
 134         </listitem>
 135       </varlistentry>
 136     </variablelist>
 137   </refsect1>
 138   <refsect1>
 139     <title>BACKWARDS COMPATIBILITY</title>
 140
 141     <para>This version of <command>modinfo</command> is for kernel
 142         modules <literal>2.5.48</literal> and above.  If it detects a
 143         kernel with support for old-style modules, it will attempt to
 144         run <command>modprobe.old</command> in its place, so it is
 145         completely transparent to the user.</para>
 146
 147     <para>Note that the output of this version of
 148         <command>modinfo</command> is simpler and more regular than
 149         the older version: scripts attempting to use the default
 150         output may get confused with complex fields.
 151     </para>
 152
 153     <para>You can force the new <command>modinfo</command> to always
 154         be used, by setting the <literal>NEW_MODINFO</literal>
 155         environment variable.
 156     </para>
 157   </refsect1>
 158   <refsect1>
 159     <title>COPYRIGHT</title>
 160     <para>
 161       This manual page Copyright 2003, Rusty Russell, IBM Corporation.
 162     </para>
 163   </refsect1>
 164   <refsect1>
 165     <title>SEE ALSO</title>
 166
 167     <para><citerefentry>
 168         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
 169       </citerefentry>,
 170       <citerefentry>
 171         <refentrytitle>modinfo.old</refentrytitle><manvolnum>8</manvolnum>
 172       </citerefentry>
 173 </para>
 174   </refsect1>
 175 </refentry>
 176
 177 <!-- Keep this comment at the end of the file
 178 Local variables:
 179 mode: sgml
 180 sgml-omittag:t
 181 sgml-shorttag:t
 182 sgml-minimize-attributes:nil
 183 sgml-always-quote-attributes:t
 184 sgml-indent-step:2
 185 sgml-indent-data:t
 186 sgml-parent-document:nil
 187 sgml-default-dtd-file:nil
 188 sgml-exposed-tags:nil
 189 sgml-local-catalogs:nil
 190 sgml-local-ecat-files:nil
 191 End:
 192 -->