xref: /aosp_15_r20/external/kmod/man/modules.dep.5.xml (revision cc4ad7da8cefe208cb129ac2aa9a357c7c72deb2)

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="modules.dep">
  <refentryinfo>
    <title>modules.dep</title>
    <productname>kmod</productname>

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Jon</firstname>
        <surname>Masters</surname>
        <email>[email protected]</email>
      </author>
      <author>
        <contrib>Developer</contrib>
        <firstname>Lucas</firstname>
        <surname>De Marchi</surname>
        <email>[email protected]</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>modules.dep</refentrytitle>
    <manvolnum>5</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>modules.dep</refname>
    <refname>modules.dep.bin</refname>
    <refpurpose>Module dependency information</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>@MODULE_DIRECTORY@/modules.dep</filename></para>
    <para><filename>@MODULE_DIRECTORY@/modules.dep.bin</filename></para>
  </refsynopsisdiv>

  <refsect1><title>DESCRIPTION</title>
    <para>
      <filename>modules.dep.bin</filename> is a binary file generated by
      <command>depmod</command> listing the dependencies for
      every module in the directories under
      <filename>@MODULE_DIRECTORY@/</filename><replaceable>version</replaceable>.
      It is used by kmod tools such as <command>modprobe</command> and
      libkmod.
    </para>
    <para>
      Its text counterpart is located in the same directory with the name
      <filename>modules.dep</filename>. The text version is maintained only
      for easy of reading by humans and is in no way used by any kmod tool.
    </para>
    <para>
      These files are not intended for editing or use by any additional
      utilities as their format is subject to change in the future. You should
      use the
      <citerefentry><refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum></citerefentry>
      command to obtain information about modules in a future proof and
      compatible fashion rather than touching these files.
    </para>
  </refsect1>
  <refsect1><title>COPYRIGHT</title>
    <para>
      This manual page originally Copyright 2002, Rusty Russell, IBM
      Corporation. Maintained by Jon Masters and others.
    </para>
  </refsect1>
  <refsect1><title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>
</refentry>