• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>/etc/depmod.d/*.conf</filename></para>
44    <para><filename>/run/depmod.d/*.conf</filename></para>
45  </refsynopsisdiv>
46
47  <refsect1><title>DESCRIPTION</title>
48    <para>The order in which modules are processed by the
49      <command>depmod</command> command can be altered on a global or
50      per-module basis. This is typically useful in cases where built-in
51      kernel modules are complemented by custom built versions of the
52      same and the user wishes to affect the priority of processing in
53      order to override the module version supplied by the kernel.
54    </para>
55    <para>
56      The format of files under <filename>depmod.d</filename> is simple: one
57      command per line, with blank lines and lines starting with '#'
58      ignored (useful for adding comments).  A '\' at the end of a line
59      causes it to continue on the next line, which makes the files a
60      bit neater.
61    </para>
62  </refsect1>
63  <refsect1>
64    <title>COMMANDS</title>
65    <variablelist>
66      <varlistentry>
67        <term>search <replaceable>subdirectory...</replaceable>
68        </term>
69        <listitem>
70          <para>
71            This allows you to specify the order in which /lib/modules
72            (or other configured module location) subdirectories will
73            be processed by <command>depmod</command>. Directories are
74            listed in order, with the highest priority given to the
75            first listed directory and the lowest priority given to the last
76            directory listed. The special keyword <command>built-in</command>
77            refers to the standard module directories installed by the kernel.
78            Another special keyword <command>external</command> refers to the
79            list of external directories, defined by the
80            <command>external</command> command.
81          </para>
82          <para>
83            By default, depmod will give a higher priority to
84            a directory with the name <command>updates</command>
85            using this built-in search string: "updates built-in"
86            but more complex arrangements are possible and are
87            used in several popular distributions.
88          </para>
89        </listitem>
90      </varlistentry>
91      <varlistentry>
92        <term>override <replaceable>modulename</replaceable> <replaceable>kernelversion</replaceable> <replaceable>modulesubdirectory</replaceable>
93        </term>
94        <listitem>
95          <para>
96            This command allows you to override which version of a
97            specific module will be used when more than one module
98            sharing the same name is processed by the
99            <command>depmod</command> command. It is possible to
100            specify one kernel or all kernels using the * wildcard.
101            <replaceable>modulesubdirectory</replaceable> is the
102            name of the subdirectory under /lib/modules (or other
103            module location) where the target module is installed.
104          </para>
105          <para>
106            For example, it is possible to override the priority of
107            an updated test module called <command>kmod</command> by
108            specifying the following command: "override kmod * extra".
109            This will ensure that any matching module name installed
110            under the <command>extra</command> subdirectory within
111            /lib/modules (or other module location) will take priority
112            over any likenamed module already provided by the kernel.
113          </para>
114        </listitem>
115      </varlistentry>
116      <varlistentry>
117        <term>external <replaceable>kernelversion</replaceable>
118        <replaceable>absolutemodulesdirectory...</replaceable>
119        </term>
120        <listitem>
121          <para>
122            This specifies a list of directories, which will be checked
123            according to the priorities in the <command>search</command>
124            command. The order matters also, the first directory has the higher
125            priority.
126          </para>
127          <para>
128            The <replaceable>kernelversion</replaceable> is a POSIX regular
129            expression or * wildcard, like in the <command>override</command>.
130          </para>
131        </listitem>
132      </varlistentry>
133    </variablelist>
134  </refsect1>
135
136  <refsect1><title>COPYRIGHT</title>
137    <para>
138      This manual page Copyright 2006-2010, Jon Masters, Red Hat, Inc.
139    </para>
140  </refsect1>
141  <refsect1><title>SEE ALSO</title>
142    <para>
143      <citerefentry>
144        <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum>
145      </citerefentry>
146    </para>
147  </refsect1>
148</refentry>
149