doc/depmod.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>2007-03-21</date>
  22   </refentryinfo>
  23   <refmeta>
  24     <refentrytitle>depmod</refentrytitle>
  25     <manvolnum>8</manvolnum>
  26   </refmeta>
  27   <refnamediv>
  28     <refname>depmod</refname> <refpurpose>program to generate <filename>modules.dep</filename> and map files.</refpurpose>
  29   </refnamediv>
  30   <refsynopsisdiv>
  31     <cmdsynopsis>
  32       <command>depmod</command>
  33       <arg><option>-b <replaceable>basedir</replaceable></option></arg>
  34       <arg><option>-e</option></arg>
  35       <arg><option>-F <replaceable>System.map</replaceable></option></arg>
  36       <arg><option>-n</option></arg>
  37       <arg><option>-v</option></arg>
  38       <arg><option><replaceable>version</replaceable></option></arg>
  39       <arg><option>-A</option></arg>
  40     </cmdsynopsis>
  41     <cmdsynopsis>
  42       <command>depmod</command>
  43       <arg><option>-e</option></arg>
  44       <arg><option>-F<replaceable>System.map</replaceable></option></arg>
  45       <arg><option>-n</option></arg>
  46       <arg><option>-v</option></arg>
  47       <arg><option><replaceable>version</replaceable></option></arg>
  48       <arg rep='repeat'><option><replaceable>filename</replaceable></option></arg>
  49     </cmdsynopsis>
  50   </refsynopsisdiv>
  51   <refsect1>
  52     <title>DESCRIPTION</title>
  53     <para>
  54       Linux kernel modules can provide services (called "symbols") for
  55       other modules to use (using EXPORT_SYMBOL in the code).  If a
  56       second module uses this symbol, that second module clearly
  57       depends on the first module.  These dependencies can get quite
  58       complex.
  59     </para>
  60     <para>
  61       <command>depmod</command> creates a list of module dependencies
  62       by reading each module under
  63       <filename>/lib/modules/</filename><replaceable>version</replaceable>
  64       and determining what symbols it exports and what symbols it
  65       needs.  By default, this list is written to
  66       <filename>modules.dep</filename> in the same directory.  If
  67       filenames are given on the command line, only those modules are
  68       examined (which is rarely useful unless all modules are
  69       listed).
  70     </para>
  71     <para>
  72       If a <replaceable>version</replaceable> is provided, then that
  73       kernel version's module directory is used rather than the
  74       current kernel version (as returned by <command>uname -r</command>).
  75     </para>
  76     <para>
  77       <command>depmod</command> will also generate various map files
  78       in this directory for use by the hotplug infrastructure.
  79     </para>
  80   </refsect1>
  81   <refsect1>
  82     <title>OPTIONS</title>
  83     <variablelist>
  84       <varlistentry>
  85           <term><option>-a</option> <option>--all</option>
  86           </term>
  87           <listitem>
  88             <para>
  89               Probe all modules. This option is enabled by default if no
  90               file names are given in the command-line.
  91             </para>
  92           </listitem>
  93       </varlistentry>
  94       <varlistentry>
  95           <term><option>-A</option> <option>--quick</option>
  96           </term>
  97           <listitem>
  98             <para>
  99               This option scans to see if any modules are newer than the
 100               <filename>modules.dep</filename> file before any work is done:
 101               if not, it silently exits rather than regenerating the files.
 102             </para>
 103           </listitem>
 104       </varlistentry>
 105       <varlistentry>
 106           <term><option>-b <replaceable>basedir</replaceable></option> <option>--basedir <replaceable>basedir</replaceable></option>
 107           </term>
 108           <listitem>
 109             <para>
 110               If your modules are not currently in the (normal)
 111               directory
 112               <filename>/lib/modules/</filename><replaceable>version</replaceable>,
 113               but in a staging area, you can specify a
 114               <replaceable>basedir</replaceable> which is prepended to
 115               the directory name.  This
 116               <replaceable>basedir</replaceable> is stripped from the
 117               resulting <filename>modules.dep</filename> file, so it
 118               is ready to be moved into the normal location.
 119             </para>
 120         </listitem>
 121       </varlistentry>
 122       <varlistentry>
 123         <term><option>-C</option> <option>--config <replaceable>file or directory</replaceable></option>
 124         </term>
 125         <listitem>
 126           <para>
 127             This option overrides the default configuration file at
 128             <filename>/etc/depmod.conf</filename> (or the
 129             <filename>/etc/depmod.d/</filename> directory if that is not found).
 130           </para>
 131         </listitem>
 132       </varlistentry>
 133       <varlistentry>
 134         <term><option>-e</option> <option>--errsyms</option>
 135         </term>
 136           <listitem>
 137             <para>
 138               When combined with the <option>-F</option> option, this
 139               reports any symbols which a module needs which are not
 140               supplied by other modules or the kernel.  Normally, any
 141               symbols not provided by modules are assumed to be
 142               provided by the kernel (which should be true in a
 143               perfect world).
 144             </para>
 145           </listitem>
 146       </varlistentry>
 147       <varlistentry>
 148         <term><option>-F</option> <option>--filesyms <replaceable>System.map</replaceable></option>
 149         </term>
 150         <listitem>
 151           <para>
 152             Supplied with the <filename>System.map</filename> produced
 153             when the kernel was built, this allows the
 154             <option>-e</option> option to report unresolved symbols.
 155           </para>
 156         </listitem>
 157       </varlistentry>
 158       <varlistentry>
 159         <term><option>-h</option> <option>--help</option>
 160         </term>
 161         <listitem>
 162           <para>
 163             Print the help message and exit.
 164           </para>
 165         </listitem>
 166       </varlistentry>
 167       <varlistentry>
 168         <term><option>-n</option> <option>--dry-run</option>
 169         </term>
 170         <listitem>
 171           <para>
 172             This sends the resulting modules.dep and the various
 173             map files to standard output rather than writing them into
 174             the module directory.
 175           </para>
 176         </listitem>
 177       </varlistentry>
 178       <varlistentry>
 179         <term><option>-v</option> <option>--verbose</option>
 180         </term>
 181         <listitem>
 182           <para>
 183             In verbose mode, <command>depmod</command> will print (to stdout)
 184             all the symbols each module depends on and the module's file name
 185             which provides that symbol.
 186           </para>
 187         </listitem>
 188       </varlistentry>
 189       <varlistentry>
 190         <term><option>-V</option> <option>--version</option>
 191         </term>
 192         <listitem>
 193           <para>
 194             Show version of program and exit. See below for caveats when
 195             run on older kernels.
 196           </para>
 197         </listitem>
 198       </varlistentry>
 199     </variablelist>
 200   </refsect1>
 201   <refsect1>
 202     <title>COPYRIGHT</title>
 203
 204     <para>
 205       This manual page Copyright 2002, Rusty Russell, IBM Corporation.
 206     </para>
 207   </refsect1>
 208   <refsect1>
 209     <title>SEE ALSO</title>
 210     <para>
 211       <citerefentry>
 212         <refentrytitle>depmod.conf</refentrytitle><manvolnum>5</manvolnum>
 213       </citerefentry>,
 214       <citerefentry>
 215         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
 216       </citerefentry>,
 217       <citerefentry>
 218         <refentrytitle>modules.dep</refentrytitle><manvolnum>5</manvolnum>
 219       </citerefentry>
 220     </para>
 221   </refsect1>
 222 </refentry>
 223
 224 <!-- Keep this comment at the end of the file
 225 Local variables:
 226 mode: sgml
 227 sgml-omittag:t
 228 sgml-shorttag:t
 229 sgml-minimize-attributes:nil
 230 sgml-always-quote-attributes:t
 231 sgml-indent-step:2
 232 sgml-indent-data:t
 233 sgml-parent-document:nil
 234 sgml-default-dtd-file:nil
 235 sgml-exposed-tags:nil
 236 sgml-local-catalogs:nil
 237 sgml-local-ecat-files:nil
 238 End:
 239 -->