man/depmod.d.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <refentry id="depmod.d">
   5   <refentryinfo>
   6     <title>depmod.d</title>
   7     <productname>kmod</productname>
   8
   9     <authorgroup>
  10       <author>
  11         <contrib>Developer</contrib>
  12         <firstname>Jon</firstname>
  13         <surname>Masters</surname>
  14         <email>jcm@jonmasters.org</email>
  15       </author>
  16       <author>
  17         <contrib>Developer</contrib>
  18         <firstname>Robby</firstname>
  19         <surname>Workman</surname>
  20         <email>rworkman@slackware.com</email>
  21       </author>
  22       <author>
  23         <contrib>Developer</contrib>
  24         <firstname>Lucas</firstname>
  25         <surname>De Marchi</surname>
  26         <email>lucas.de.marchi@gmail.com</email>
  27       </author>
  28     </authorgroup>
  29   </refentryinfo>
  30
  31   <refmeta>
  32     <refentrytitle>depmod.d</refentrytitle>
  33     <manvolnum>5</manvolnum>
  34   </refmeta>
  35
  36   <refnamediv>
  37     <refname>depmod.d</refname>
  38     <refpurpose>Configuration directory for depmod</refpurpose>
  39   </refnamediv>
  40
  41   <refsynopsisdiv>
  42     <para><filename>/usr/lib/depmod.d/*.conf</filename></para>
  43     <para><filename>/usr/local/lib/depmod.d/*.conf</filename></para>
  44     <para><filename>/run/depmod.d/*.conf</filename></para>
  45     <para><filename>/etc/depmod.d/*.conf</filename></para>
  46   </refsynopsisdiv>
  47
  48   <refsect1><title>DESCRIPTION</title>
  49     <para>The order in which modules are processed by the
  50       <command>depmod</command> command can be altered on a global or
  51       per-module basis. This is typically useful in cases where built-in
  52       kernel modules are complemented by custom built versions of the
  53       same and the user wishes to affect the priority of processing in
  54       order to override the module version supplied by the kernel.
  55     </para>
  56     <para>
  57       The format of files under <filename>depmod.d</filename> is simple: one
  58       command per line, with blank lines and lines starting with '#'
  59       ignored (useful for adding comments).  A '\' at the end of a line
  60       causes it to continue on the next line, which makes the files a
  61       bit neater.
  62     </para>
  63   </refsect1>
  64   <refsect1>
  65     <title>COMMANDS</title>
  66     <variablelist>
  67       <varlistentry>
  68         <term>search <replaceable>subdirectory...</replaceable>
  69         </term>
  70         <listitem>
  71           <para>
  72             This allows you to specify the order in which /lib/modules
  73             (or other configured module location) subdirectories will
  74             be processed by <command>depmod</command>. Directories are
  75             listed in order, with the highest priority given to the
  76             first listed directory and the lowest priority given to the last
  77             directory listed. The special keyword <command>built-in</command>
  78             refers to the standard module directories installed by the kernel.
  79             Another special keyword <command>external</command> refers to the
  80             list of external directories, defined by the
  81             <command>external</command> command.
  82           </para>
  83           <para>
  84             By default, depmod will give a higher priority to
  85             a directory with the name <command>updates</command>
  86             using this built-in search string: "updates built-in"
  87             but more complex arrangements are possible and are
  88             used in several popular distributions.
  89           </para>
  90         </listitem>
  91       </varlistentry>
  92       <varlistentry>
  93         <term>override <replaceable>modulename</replaceable> <replaceable>kernelversion</replaceable> <replaceable>modulesubdirectory</replaceable>
  94         </term>
  95         <listitem>
  96           <para>
  97             This command allows you to override which version of a
  98             specific module will be used when more than one module
  99             sharing the same name is processed by the
 100             <command>depmod</command> command. It is possible to
 101             specify one kernel or all kernels using the * wildcard.
 102             <replaceable>modulesubdirectory</replaceable> is the
 103             name of the subdirectory under /lib/modules (or other
 104             module location) where the target module is installed.
 105           </para>
 106           <para>
 107             For example, it is possible to override the priority of
 108             an updated test module called <command>kmod</command> by
 109             specifying the following command: "override kmod * extra".
 110             This will ensure that any matching module name installed
 111             under the <command>extra</command> subdirectory within
 112             /lib/modules (or other module location) will take priority
 113             over any likenamed module already provided by the kernel.
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117       <varlistentry>
 118         <term>external <replaceable>kernelversion</replaceable>
 119         <replaceable>absolutemodulesdirectory...</replaceable>
 120         </term>
 121         <listitem>
 122           <para>
 123             This specifies a list of directories, which will be checked
 124             according to the priorities in the <command>search</command>
 125             command. The order matters also, the first directory has the higher
 126             priority.
 127           </para>
 128           <para>
 129             The <replaceable>kernelversion</replaceable> is a POSIX regular
 130             expression or * wildcard, like in the <command>override</command>.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134     </variablelist>
 135   </refsect1>
 136
 137   <refsect1><title>COPYRIGHT</title>
 138     <para>
 139       This manual page Copyright 2006-2010, Jon Masters, Red Hat, Inc.
 140     </para>
 141   </refsect1>
 142   <refsect1><title>SEE ALSO</title>
 143     <para>
 144       <citerefentry>
 145         <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum>
 146       </citerefentry>
 147     </para>
 148   </refsect1>
 149 </refentry>