depmod.8

   1 .\\" auto-generated by docbook2man-spec $Revision: 1.2 $
   2 .TH "DEPMOD" "8" "2010-03-01" "" ""
   3 .SH NAME
   4 depmod \- program to generate modules.dep and map files.
   5 .SH SYNOPSIS
   6 .sp
   7 \fBdepmod\fR [ \fB-b \fIbasedir\fB\fR ]  [ \fB-e\fR ]  [ \fB-F \fISystem.map\fB\fR ]  [ \fB-n\fR ]  [ \fB-v\fR ]  [ \fB\fIversion\fB\fR ]  [ \fB-A\fR ]
   8 .sp
   9 \fBdepmod\fR [ \fB-e\fR ]  [ \fB-F\fISystem.map\fB\fR ]  [ \fB-n\fR ]  [ \fB-v\fR ]  [ \fB\fIversion\fB\fR ]  [ \fB\fIfilename\fB\fR\fI...\fR ]
  10 .SH "DESCRIPTION"
  11 .PP
  12 Linux kernel modules can provide services (called "symbols") for
  13 other modules to use (using one of the EXPORT_SYMBOL variants in the
  14 code). If a second module uses this symbol, that second module clearly
  15 depends on the first module. These dependencies can get quite complex.
  16 .PP
  17 \fBdepmod\fR creates a list of module dependencies
  18 by reading each module under
  19 \fI/lib/modules/\fR\fIversion\fR
  20 and determining what symbols it exports and what symbols it
  21 needs. By default, this list is written to
  22 \fImodules.dep\fR, and a binary hashed version named
  23 \fImodules.dep.bin\fR, in the same directory. If
  24 filenames are given on the command line, only those modules are
  25 examined (which is rarely useful unless all modules are listed).
  26 \fBdepmod\fR also creates a list of symbols provided
  27 by modules in the file named \fImodules.symbols\fR
  28 and its binary hashed version, \fImodules.symbols.bin\fR\&.
  29 .PP
  30 If a \fIversion\fR is provided, then that
  31 kernel version's module directory is used rather than the
  32 current kernel version (as returned by \fBuname -r\fR).
  33 .PP
  34 .PP
  35 \fBdepmod\fR will also generate various legacy map
  36 files in the output directory for use by the older hotplug
  37 infrastructure. These map files are largely deprecated.
  38 .SH "OPTIONS"
  39 .TP
  40 \fB-a --all\fR
  41 Probe all modules. This option is enabled by default if no
  42 file names are given in the command-line.
  43 .TP
  44 \fB-A --quick\fR
  45 This option scans to see if any modules are newer than the
  46 \fImodules.dep\fR file before any work is done:
  47 if not, it silently exits rather than regenerating the files.
  48 .TP
  49 \fB-b \fIbasedir\fB --basedir \fIbasedir\fB\fR
  50 If your modules are not currently in the (normal)
  51 directory
  52 \fI/lib/modules/\fR\fIversion\fR,
  53 but in a staging area, you can specify a
  54 \fIbasedir\fR which is prepended to
  55 the directory name. This
  56 \fIbasedir\fR is stripped from the
  57 resulting \fImodules.dep\fR file, so it
  58 is ready to be moved into the normal location. Use this option
  59 if you are a distribution vendor who needs to pre-generate the
  60 meta-data files rather than running depmod again later.
  61 .TP
  62 \fB-C --config \fIfile or directory\fB\fR
  63 This option overrides the default configuration file at
  64 \fI/etc/depmod.conf\fR (or the
  65 \fI/etc/depmod.d/\fR directory if that is not found).
  66 .TP
  67 \fB-e --errsyms\fR
  68 When combined with the \fB-F\fR option, this
  69 reports any symbols which a module needs which are not
  70 supplied by other modules or the kernel. Normally, any
  71 symbols not provided by modules are assumed to be
  72 provided by the kernel (which should be true in a
  73 perfect world), but this assumption can break espencially
  74 when additionally updated third party drivers are not
  75 correctly installed or were built incorrectly.
  76 .TP
  77 \fB-F --filesyms \fISystem.map\fB\fR
  78 Supplied with the \fISystem.map\fR produced
  79 when the kernel was built, this allows the
  80 \fB-e\fR option to report unresolved symbols.
  81 .TP
  82 \fB-h --help\fR
  83 Print the help message and exit.
  84 .TP
  85 \fB-n --dry-run\fR
  86 This sends the resulting modules.dep and the various
  87 map files to standard output rather than writing them into
  88 the module directory.
  89 .TP
  90 \fB-v --verbose\fR
  91 In verbose mode, \fBdepmod\fR will print (to stdout)
  92 all the symbols each module depends on and the module's file name
  93 which provides that symbol.
  94 .TP
  95 \fB-V --version\fR
  96 Show version of program and exit. See below for caveats when
  97 run on older kernels.
  98 .SH "COPYRIGHT"
  99 .PP
 100 This manual page originally Copyright 2002, Rusty Russell,
 101 IBM Corporation. Maintained by Jon Masters and others.
 102 .SH "SEE ALSO"
 103 .PP
 104 \fBdepmod.conf\fR(5),
 105 \fBdepmod.d\fR(5),
 106 \fBmodprobe\fR(8),
 107 \fBmodules.dep\fR(5)