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