← Back to branch summary

~smoser/ubuntu/quantal/module-init-tools/lp-1115710

« back to all changes in this revision

Viewing changes to .pc/document_depmod_E/doc/depmod.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Andy Whitcroft
  • Date: 2011-06-16 13:10:43 UTC
  • mfrom: (0.1.14 sid)
  • Revision ID: james.westby@ubuntu.com-20110616131043-1vpt92u0vdzzq38f
Tags: 3.16-1ubuntu1
* Resync with debian 3.16-1.
 - Remaining changes:
    + update to debhelper version 7 for upstart job support
    + Ubuntu specific control scripts carrying upgrade quirks
    + Ubuntu specific modprobe.d/depmod.d contents
    + debian/patches/ubuntu-maps_by_default -- Reenable map files
    + switch source to 'unapply-patches' to simplify merging with
      debian upstream
* debian/patches/ubuntu-modinfo-wantparm-uninitialised dropped
  now upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/document_depmod_E/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>jcm@jonmasters.org</email>
16
 
    </address>
17
 
    <author>
18
 
      <firstname>Jon</firstname>
19
 
      <surname>Masters</surname>
20
 
    </author>
21
 
    <date>2010-03-01</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>-m</option></arg>
37
 
      <arg><option>-n</option></arg>
38
 
      <arg><option>-v</option></arg>
39
 
      <arg><option><replaceable>version</replaceable></option></arg>
40
 
      <arg><option>-A</option></arg>
41
 
    </cmdsynopsis>
42
 
    <cmdsynopsis>
43
 
      <command>depmod</command>
44
 
      <arg><option>-e</option></arg>
45
 
      <arg><option>-F<replaceable>System.map</replaceable></option></arg>
46
 
      <arg><option>-n</option></arg>
47
 
      <arg><option>-v</option></arg>
48
 
      <arg><option><replaceable>version</replaceable></option></arg>
49
 
      <arg rep='repeat'><option><replaceable>filename</replaceable></option></arg>
50
 
    </cmdsynopsis>
51
 
  </refsynopsisdiv>
52
 
  <refsect1>
53
 
    <title>DESCRIPTION</title>
54
 
    <para>
55
 
      Linux kernel modules can provide services (called "symbols") for
56
 
      other modules to use (using one of the EXPORT_SYMBOL variants in the
57
 
      code).  If a second module uses this symbol, that second module clearly
58
 
      depends on the first module.  These dependencies can get quite 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>, and a binary hashed version named
67
 
      <filename>modules.dep.bin</filename>, in the same directory.  If
68
 
      filenames are given on the command line, only those modules are
69
 
      examined (which is rarely useful unless all modules are listed).
70
 
      <command>depmod</command> also creates a list of symbols provided
71
 
      by modules in the file named <filename>modules.symbols</filename>
72
 
      and its binary hashed version, <filename>modules.symbols.bin</filename>.
73
 
    </para>
74
 
    <para>
75
 
      If a <replaceable>version</replaceable> is provided, then that
76
 
      kernel version's module directory is used rather than the
77
 
      current kernel version (as returned by <command>uname -r</command>).
78
 
    </para>
79
 
    <para>
80
 
      <command>depmod</command> will also generate various legacy map
81
 
      files in the output directory for use by the older hotplug
82
 
      infrastructure. These map files are largely deprecated.
83
 
    </para>
84
 
  </refsect1>
85
 
  <refsect1>
86
 
    <title>OPTIONS</title>
87
 
    <variablelist>
88
 
      <varlistentry>
89
 
          <term><option>-a</option> <option>--all</option>
90
 
          </term>
91
 
          <listitem>
92
 
            <para>
93
 
              Probe all modules. This option is enabled by default if no
94
 
              file names are given in the command-line.
95
 
            </para>
96
 
          </listitem>
97
 
      </varlistentry>
98
 
      <varlistentry>
99
 
          <term><option>-A</option> <option>--quick</option>
100
 
          </term>
101
 
          <listitem>
102
 
            <para>
103
 
              This option scans to see if any modules are newer than the
104
 
              <filename>modules.dep</filename> file before any work is done:
105
 
              if not, it silently exits rather than regenerating the files.
106
 
            </para>
107
 
          </listitem>
108
 
      </varlistentry>
109
 
      <varlistentry>
110
 
          <term><option>-b <replaceable>basedir</replaceable></option> <option>--basedir <replaceable>basedir</replaceable></option>
111
 
          </term>
112
 
          <listitem>
113
 
            <para>
114
 
              If your modules are not currently in the (normal)
115
 
              directory
116
 
              <filename>/lib/modules/</filename><replaceable>version</replaceable>,
117
 
              but in a staging area, you can specify a
118
 
              <replaceable>basedir</replaceable> which is prepended to
119
 
              the directory name.  This
120
 
              <replaceable>basedir</replaceable> is stripped from the
121
 
              resulting <filename>modules.dep</filename> file, so it
122
 
              is ready to be moved into the normal location. Use this option
123
 
              if you are a distribution vendor who needs to pre-generate the
124
 
              meta-data files rather than running depmod again later.
125
 
            </para>
126
 
        </listitem>
127
 
      </varlistentry>
128
 
      <varlistentry>
129
 
        <term><option>-C</option> <option>--config <replaceable>file or directory</replaceable></option>
130
 
        </term>
131
 
        <listitem>
132
 
          <para>
133
 
            This option overrides the default configuration file at
134
 
            <filename>/etc/depmod.conf</filename> (or the 
135
 
            <filename>/etc/depmod.d/</filename> directory if that is not found).
136
 
          </para>
137
 
        </listitem>
138
 
      </varlistentry>
139
 
      <varlistentry>
140
 
        <term><option>-e</option> <option>--errsyms</option>
141
 
        </term>
142
 
          <listitem>
143
 
            <para>
144
 
              When combined with the <option>-F</option> option, this
145
 
              reports any symbols which a module needs which are not
146
 
              supplied by other modules or the kernel.  Normally, any
147
 
              symbols not provided by modules are assumed to be
148
 
              provided by the kernel (which should be true in a
149
 
              perfect world), but this assumption can break espencially
150
 
              when additionally updated third party drivers are not
151
 
              correctly installed or were built incorrectly.
152
 
            </para>
153
 
          </listitem>
154
 
      </varlistentry>
155
 
      <varlistentry>
156
 
        <term><option>-F</option> <option>--filesyms <replaceable>System.map</replaceable></option>
157
 
        </term>
158
 
        <listitem>
159
 
          <para>
160
 
            Supplied with the <filename>System.map</filename> produced
161
 
            when the kernel was built, this allows the
162
 
            <option>-e</option> option to report unresolved symbols.
163
 
          </para>
164
 
        </listitem>
165
 
      </varlistentry>
166
 
      <varlistentry>
167
 
        <term><option>-h</option> <option>--help</option>
168
 
        </term>
169
 
        <listitem>
170
 
          <para>
171
 
            Print the help message and exit.
172
 
          </para>
173
 
        </listitem>
174
 
      </varlistentry>
175
 
      <varlistentry>
176
 
        <term><option>-m</option> <option>--map</option>
177
 
        </term>
178
 
        <listitem>
179
 
          <para>
180
 
            Enables generation of the obsolete map files.
181
 
          </para>
182
 
        </listitem>
183
 
      </varlistentry>
184
 
      <varlistentry>
185
 
        <term><option>-n</option> <option>--dry-run</option>
186
 
        </term>
187
 
        <listitem>
188
 
          <para>
189
 
            This sends the resulting modules.dep and the various
190
 
            map files to standard output rather than writing them into
191
 
            the module directory.
192
 
          </para>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
      <varlistentry>
196
 
        <term><option>-v</option> <option>--verbose</option>
197
 
        </term>
198
 
        <listitem>
199
 
          <para>
200
 
            In verbose mode, <command>depmod</command> will print (to stdout)
201
 
            all the symbols each module depends on and the module's file name
202
 
            which provides that symbol.
203
 
          </para>
204
 
        </listitem>
205
 
      </varlistentry>
206
 
      <varlistentry>
207
 
        <term><option>-V</option> <option>--version</option>
208
 
        </term>
209
 
        <listitem>
210
 
          <para>
211
 
            Show version of program and exit. See below for caveats when
212
 
            run on older kernels.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
    </variablelist>
217
 
  </refsect1>
218
 
  <refsect1>
219
 
    <title>COPYRIGHT</title>
220
 
 
221
 
    <para>
222
 
      This manual page originally Copyright 2002, Rusty Russell,
223
 
      IBM Corporation. Maintained by Jon Masters and others.
224
 
    </para>
225
 
  </refsect1>
226
 
  <refsect1>
227
 
    <title>SEE ALSO</title>
228
 
    <para>
229
 
      <citerefentry>
230
 
        <refentrytitle>depmod.conf</refentrytitle><manvolnum>5</manvolnum>
231
 
      </citerefentry>,
232
 
      <citerefentry>
233
 
        <refentrytitle>depmod.d</refentrytitle><manvolnum>5</manvolnum>
234
 
      </citerefentry>,
235
 
      <citerefentry>
236
 
        <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
237
 
      </citerefentry>,
238
 
      <citerefentry>
239
 
        <refentrytitle>modules.dep</refentrytitle><manvolnum>5</manvolnum>
240
 
      </citerefentry>
241
 
    </para>
242
 
  </refsect1>
243
 
</refentry>
244
 
 
245
 
<!-- Keep this comment at the end of the file
246
 
Local variables:
247
 
mode: sgml
248
 
sgml-omittag:t
249
 
sgml-shorttag:t
250
 
sgml-minimize-attributes:nil
251
 
sgml-always-quote-attributes:t
252
 
sgml-indent-step:2
253
 
sgml-indent-data:t
254
 
sgml-parent-document:nil
255
 
sgml-default-dtd-file:nil
256
 
sgml-exposed-tags:nil
257
 
sgml-local-catalogs:nil
258
 
sgml-local-ecat-files:nil
259
 
End:
260
 
-->