doc: properly fix documentation generation
[module-init-tools.git] / doc / modules.dep.sgml
bloba0b68ede0dd71576b32815d3d63da8d55721b5e2
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 ]>
7 <!-- Stolen from manual page for docbook-to-man, DocBook source file
8 (C) 1999 W. Borgert debacle@debian.org
10 $Id: docbook-to-man.sgml,v 1.8 2002/04/27 15:28:02 debacle Exp $ -->
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>modules.dep</refentrytitle>
25 <manvolnum>5</manvolnum>
26 </refmeta>
27 <refnamediv>
28 <refname>modules.dep.bin</refname><refname>modules.dep</refname> <refpurpose>Module dependency information</refpurpose>
29 </refnamediv>
30 <refsect1>
31 <title>DESCRIPTION</title>
33 <para>
34 The <filename>modules.dep.bin</filename> as generated by
35 module-init-tools <command>depmod</command>, lists the
36 dependencies for every module in the directories under
37 <filename>/lib/modules/</filename><replaceable>version</replaceable>,
38 where <filename>modules.dep.bin</filename> (or the human readable
39 version <filename>modules.dep</filename>) is also located. It is
40 used by utilities such as <command>modprobe</command>. The
41 binary version will be used by default, if it was generated by
42 a compatible version of <command>depmod</command>, with fallback
43 to the generic <filename>modules.dep</filename>.
44 </para>
45 <para>
46 These files are not intended for editing or use by any additional
47 utilities as their format is subject to change in the future. You
48 should use the
49 <citerefentry><refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum></citerefentry> command to obtain information about modules in a future
50 proof and compatible fashion rather than touching these files.
51 </para>
52 </refsect1>
53 <refsect1>
54 <title>COPYRIGHT</title>
55 <para>
56 This manual page originally Copyright 2002, Rusty Russell, IBM
57 Corporation. Maintained by Jon Masters and others.
58 </para>
59 </refsect1>
60 <refsect1>
61 <title>SEE ALSO</title>
63 <para>
64 <citerefentry>
65 <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum>
66 </citerefentry>,
67 <citerefentry>
68 <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
69 </citerefentry>
70 </para>
71 </refsect1>
72 </refentry>
74 <!-- Keep this comment at the end of the file
75 Local variables:
76 mode: sgml
77 sgml-omittag:t
78 sgml-shorttag:t
79 sgml-minimize-attributes:nil
80 sgml-always-quote-attributes:t
81 sgml-indent-step:2
82 sgml-indent-data:t
83 sgml-parent-document:nil
84 sgml-default-dtd-file:nil
85 sgml-exposed-tags:nil
86 sgml-local-catalogs:nil
87 sgml-local-ecat-files:nil
88 End:
89 -->