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 "uname -r").
  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
 128             (/etc/depmod.conf or /etc/depmod.d/ if that is not found).
 129           </para>
 130         </listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term><option>-e</option> <option>--errsyms</option>
 134         </term>
 135           <listitem>
 136             <para>
 137               When combined with the <option>-F</option> option, this
 138               reports any symbols which a module needs which are not
 139               supplied by other modules or the kernel.  Normally, any
 140               symbols not provided by modules are assumed to be
 141               provided by the kernel (which should be true in a
 142               perfect world).
 143             </para>
 144           </listitem>
 145       </varlistentry>
 146       <varlistentry>
 147         <term><option>-F</option> <option>--filesyms <replaceable>System.map</replaceable></option>
 148         </term>
 149         <listitem>
 150           <para>
 151             Supplied with the <filename>System.map</filename> produced
 152             when the kernel was built, this allows the
 153             <option>-e</option> option to report unresolved symbols.
 154           </para>
 155         </listitem>
 156       </varlistentry>
 157       <varlistentry>
 158         <term><option>-h</option> <option>--help</option>
 159         </term>
 160         <listitem>
 161           <para>
 162             Print the help message, and exit.
 163           </para>
 164         </listitem>
 165       </varlistentry>
 166       <varlistentry>
 167         <term><option>-n</option> <option>--dry-run</option>
 168         </term>
 169         <listitem>
 170           <para>
 171             This sends the resulting modules.dep, then the various
 172             map files, to standard output, rather than writing them into
 173             the module directory.
 174           </para>
 175         </listitem>
 176       </varlistentry>
 177       <varlistentry>
 178         <term><option>-v</option> <option>--verbose</option>
 179         </term>
 180         <listitem>
 181           <para>
 182             In verbose mode <command>depmod</command> will print (to stdout)
 183             all the symbols each module depends on and the module's file name
 184             which provides that symbol.
 185           </para>
 186         </listitem>
 187       </varlistentry>
 188       <varlistentry>
 189         <term><option>-V</option> <option>--version</option>
 190         </term>
 191         <listitem>
 192           <para>
 193             Show version of program, and exit. See below for caveats when
 194             run on older kernels.
 195           </para>
 196         </listitem>
 197       </varlistentry>
 198     </variablelist>
 199   </refsect1>
 200   <refsect1>
 201     <title>BACKWARDS COMPATIBILITY</title>
 202
 203     <para>
 204       This version of <command>depmod</command> is for kernels
 205       <literal>2.5.48</literal> and above.  There is no support
 206       for old-style modules.
 207     </para>
 208   </refsect1>
 209   <refsect1>
 210     <title>COPYRIGHT</title>
 211
 212     <para>
 213       This manual page Copyright 2002, Rusty Russell, IBM Corporation.
 214     </para>
 215   </refsect1>
 216   <refsect1>
 217     <title>SEE ALSO</title>
 218     <para>
 219       <citerefentry>
 220         <refentrytitle>depmod.conf</refentrytitle><manvolnum>5</manvolnum>
 221       </citerefentry>,
 222       <citerefentry>
 223         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
 224       </citerefentry>,
 225       <citerefentry>
 226         <refentrytitle>modules.dep</refentrytitle><manvolnum>5</manvolnum>
 227       </citerefentry>
 228     </para>
 229   </refsect1>
 230 </refentry>
 231
 232 <!-- Keep this comment at the end of the file
 233 Local variables:
 234 mode: sgml
 235 sgml-omittag:t
 236 sgml-shorttag:t
 237 sgml-minimize-attributes:nil
 238 sgml-always-quote-attributes:t
 239 sgml-indent-step:2
 240 sgml-indent-data:t
 241 sgml-parent-document:nil
 242 sgml-default-dtd-file:nil
 243 sgml-exposed-tags:nil
 244 sgml-local-catalogs:nil
 245 sgml-local-ecat-files:nil
 246 End:
 247 -->