doc/depmod.conf.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>jcm@jonmasters.org</email>
  16     </address>
  17     <author>
  18       <firstname>Jon</firstname>
  19       <surname>Masters</surname>
  20     </author>
  21     <date>2005-09-23</date>
  22   </refentryinfo>
  23   <refmeta>
  24     <refentrytitle>depmod.d</refentrytitle>
  25     <manvolnum>5</manvolnum>
  26     <refentrytitle>depmod.conf</refentrytitle>
  27     <manvolnum>5</manvolnum>
  28   </refmeta>
  29   <refnamediv>
  30     <refname>depmod.conf</refname><refname>depmod.d</refname> <refpurpose>Configuration file/directory for depmod</refpurpose>
  31   </refnamediv>
  32   <refsect1>
  33     <title>DESCRIPTION</title>
  34
  35     <para>The order in which modules are processed by the
  36       <command>depmod</command> command can be altered on a global or
  37       per-module basis. This is typically useful in cases where built-in
  38       kernel modules are complemented by custom built versions of the
  39       same and the user wishes to affect the priority of processing in
  40       order to override the module version supplied by the kernel.
  41     </para>
  42     <para>
  43       The format of <filename>depmod.conf</filename> and files under <filename>depmod.d</filename> is simple: one
  44       command per line, with blank lines and lines starting with #
  45       ignored (useful for adding comments).  A \ at the end of a line
  46       causes it to continue on the next line, which makes the file a
  47       bit neater.
  48     </para>
  49   </refsect1>
  50   <refsect1>
  51     <title>COMMANDS</title>
  52     <variablelist>
  53       <varlistentry>
  54         <term>search <replaceable>subdirectory...</replaceable>
  55         </term>
  56         <listitem>
  57           <para>
  58             This allows you to specify the order in which /lib/modules
  59             (or other configured module location) subdirectories will
  60             be processed by <command>depmod</command>. Directories are
  61             listed in order, with the highest priority given to the
  62             first listed directory and the lowest to the last. The
  63             special keyword <command>built-in</command> refers to
  64             the standard module directories installed by the kernel.
  65           </para>
  66           <para>
  67             By default, depmod will give a higher priority to
  68             a directory with the name <command>updates</command>
  69             using this built-in search string: "updates built-in"
  70             but more complex arrangements are possible and are
  71             used in several popular distributions.
  72           </para>
  73         </listitem>
  74       </varlistentry>
  75       <varlistentry>
  76         <term>override <replaceable>modulename</replaceable> <replaceable>kernelversion</replaceable> <replaceable>modulesubdirectory</replaceable>
  77         </term>
  78         <listitem>
  79           <para>
  80             This command allows you to override which version of a
  81             specific module will be used when more than one module
  82             sharing the same name is processed by the
  83             <command>depmod</command> command. It is possible to
  84             specify one kernel or all kernels using the * wildcard.
  85             <replaceable>modulesubdirectory</replaceable> is the
  86             name of the subdirectory under /lib/modules (or other
  87             module location) where the target module is installed.
  88           </para>
  89           <para>
  90             For example, it is possible to override the priority of
  91             an updated test module called <command>kmp</command> by
  92             specifying the following command: "override kmp * extra".
  93             This will ensure that any matching module name installed
  94             under the <command>extra</command> subdirectory within
  95             /lib/modules (or other module location) will take priority
  96             over any likenamed module already provided by the kernel.
  97           </para>
  98         </listitem>
  99       </varlistentry>
 100       <varlistentry>
 101         <term>include <replaceable>filename</replaceable>
 102         </term>
 103         <listitem>
 104           <para>
 105             Using this command, you can include other configuration
 106             files, or whole directories, which is occasionally useful.
 107           </para>
 108         </listitem>
 109       </varlistentry>
 110     </variablelist>
 111   </refsect1>
 112   <refsect1>
 113     <title>COPYRIGHT</title>
 114     <para>
 115       This manual page Copyright 2006, Jon Masters, Red Hat, Inc.
 116     </para>
 117   </refsect1>
 118 </refentry>
 119
 120 <!-- Keep this comment at the end of the file
 121 Local variables:
 122 mode: sgml
 123 sgml-omittag:t
 124 sgml-shorttag:t
 125 sgml-minimize-attributes:nil
 126 sgml-always-quote-attributes:t
 127 sgml-indent-step:2
 128 sgml-indent-data:t
 129 sgml-parent-document:nil
 130 sgml-default-dtd-file:nil
 131 sgml-exposed-tags:nil
 132 sgml-local-catalogs:nil
 133 sgml-local-ecat-files:nil
 134 End:
 135 -->