manual/module-init-tools/original/man8/modprobe.8

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "MODPROBE" "8" "08 May 2005" "" ""
   7
   8 .SH NAME
   9 modprobe \- program to add and remove modules from the Linux Kernel
  10 .SH SYNOPSIS
  11
  12 \fBmodprobe\fR [ \fB-v\fR ] [ \fB-V\fR ] [ \fB-C \fIconfig-file\fB\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB-q\fR ] [ \fB-o \fImodulename\fB\fR ] [ \fB\fImodulename\fB\fR ] [ \fB\fImodule parameters\fB\fR\fI ...\fR ]
  13
  14
  15 \fBmodprobe\fR [ \fB-r\fR ] [ \fB-v\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB\fImodulename\fB\fR\fI ...\fR ]
  16
  17
  18 \fBmodprobe\fR [ \fB-l\fR ] [ \fB-t \fIdirname\fB\fR ] [ \fB\fIwildcard\fB\fR ]
  19
  20
  21 \fBmodprobe\fR [ \fB-c\fR ]
  22
  23 .SH "DESCRIPTION"
  24 .PP
  25 \fBmodprobe\fR intelligently adds or removes a
  26 module from the Linux kernel: note that for convenience, there
  27 is no difference between _ and - in module names.
  28 \fBmodprobe\fR looks in the module directory
  29 \fI/lib/modules/`uname -r`\fR for all
  30 the modules and other files, except for the optional
  31 \fI/etc/modprobe.conf\fR configuration file and
  32 \fI/etc/modprobe.d\fR directory
  33 (see \fBmodprobe.conf\fR(5)).
  34 .PP
  35 Note that this version of \fBmodprobe\fR does not
  36 do anything to the module itself: the work of resolving symbols
  37 and understanding parameters is done inside the kernel.  So
  38 module failure is sometimes accompanied by a kernel message: see
  39 \fBdmesg\fR(8)\&.
  40 .PP
  41 \fBmodprobe\fR expects an up-to-date
  42 \fImodules.dep\fR file, as generated by
  43 \fBdepmod\fR (see \fBdepmod\fR(8)).  This file lists what other modules each
  44 module needs (if any), and \fBmodprobe\fR uses this
  45 to add or remove these dependencies automatically.  See
  46 \fBmodules.dep\fR(5)).
  47 .PP
  48 If any arguments are given after the
  49 \fImodulename\fR, they are passed to the
  50 kernel (in addition to any options listed in the configuration
  51 file).
  52 .SH "OPTIONS"
  53 .TP
  54 \fB-v --verbose \fR
  55 Print messages about what the program is doing.  Usually
  56 \fBmodprobe\fR only prints messages if
  57 something goes wrong.
  58
  59 This option is passed through \fBinstall\fR
  60 or \fBremove\fR commands to other
  61 \fBmodprobe\fR commands in the
  62 MODPROBE_OPTIONS environment variable.
  63 .TP
  64 \fB-C --config \fR
  65 This option overrides the default configuration file
  66 (\fI/etc/modprobe.conf\fR or
  67 \fI/etc/modprobe.d/\fR if that isn't found).
  68
  69 This option is passed through \fBinstall\fR
  70 or \fBremove\fR commands to other
  71 \fBmodprobe\fR commands in the
  72 MODPROBE_OPTIONS environment variable.
  73 .TP
  74 \fB-c --showconfig \fR
  75 Dump out the configuration file and exit.
  76 .TP
  77 \fB-n --dry-run \fR
  78 This option does everything but actually insert or
  79 delete the modules (or run the install or remove
  80 commands).  Combined with \fB-v\fR, it is
  81 useful for debugging problems.
  82 .TP
  83 \fB-i --ignore-install --ignore-remove \fR
  84 This option causes \fBmodprobe\fR to
  85 ignore \fBinstall\fR and
  86 \fBremove\fR commands in the
  87 configuration file (if any), for the module on the
  88 command line (any dependent modules are still subject
  89 to commands set for them in the configuration file).
  90 See \fBmodprobe.conf\fR(5)\&.
  91 .TP
  92 \fB-q --quiet \fR
  93 Normally \fBmodprobe\fR will report an error
  94 if you try to remove or insert a module it can't find (and
  95 isn't an alias or
  96 \fBinstall\fR/\fBremove\fR
  97 command).  With this flag, \fBmodprobe\fR
  98 will simply ignore any bogus names (the kernel uses this
  99 to opportunistically probe for modules which might exist).
 100 .TP
 101 \fB-r --remove \fR
 102 This option causes \fBmodprobe\fR to remove,
 103 rather than insert a module.  If the modules it depends on
 104 are also unused, \fBmodprobe\fR will try to
 105 remove them, too.  Unlike insertion, more than one module
 106 can be specified on the command line (it does not make
 107 sense to specify module parameters when removing modules).
 108
 109 There is usually no reason to remove modules, but some
 110 buggy modules require it.  Your kernel may not support
 111 removal of modules.
 112 .TP
 113 \fB-V --version \fR
 114 Show version of program, and exit.  See below for caveats when run on older kernels.
 115 .TP
 116 \fB-f --force \fR
 117 Try to strip any versioning information from the module,
 118 which might otherwise stop it from loading: this is the
 119 same as using both \fB--force-vermagic\fR and
 120 \fB--force-modversion\fR\&.  Naturally, these
 121 checks are there for your protection, so using this option
 122 is dangerous.
 123
 124 This applies to any modules inserted: both the module (or
 125 alias) on the command line, and any modules it depends on.
 126 .TP
 127 \fB--force-vermagic \fR
 128 Every module contains a small string containing important
 129 information, such as the kernel and compiler versions.  If
 130 a module fails to load and the kernel complains that the
 131 "version magic" doesn't match, you can use this option to
 132 remove it.  Naturally, this check is there for your
 133 protection, so this using option is dangerous.
 134
 135 This applies to any modules inserted: both the module (or
 136 alias) on the command line, and any modules it depends on.
 137 .TP
 138 \fB--force-modversion \fR
 139 When modules are compiled with CONFIG_MODVERSIONS set, a
 140 section is created detailing the versions of every
 141 interface used by (or supplied by) the module.  If a
 142 module fails to load and the kernel complains that the
 143 module disagrees about a version of some interface, you
 144 can use "--force-modversion" to remove the version
 145 information altogether.  Naturally, this check is there
 146 for your protection, so using this option is dangerous.
 147
 148 This applies any modules inserted: both the module (or
 149 alias) on the command line, and any modules it depends on.
 150 .TP
 151 \fB-l --list \fR
 152 List all modules matching the given wildcard (or "*"
 153 if no wildcard is given).  This option is provided for
 154 backwards compatibility: see
 155 \fBfind\fR(1) and
 156 \fBbasename\fR(1) for a more flexible alternative.
 157 .TP
 158 \fB-a --all \fR
 159 Insert all modules matching the given wildcard.  This
 160 option is provided for backwards compatibility: see
 161 \fBfind\fR(1) and
 162 \fBbasename\fR(1) for a more flexible alternative.
 163 .TP
 164 \fB-t --type \fR
 165 Restrict \fB-l\fR to modules
 166 in directories matching the
 167 \fIdirname\fR given.  This option
 168 is provided for backwards compatibility: see
 169 \fBfind\fR(1)
 170 and
 171 \fBbasename\fR(1) or a more flexible alternative.
 172 .TP
 173 \fB-s --syslog \fR
 174 This option causes any error messages to go through the
 175 syslog mechanism (as LOG_DAEMON with level LOG_NOTICE)
 176 rather than to standard error.  This is also automatically
 177 enabled when stderr is unavailable.
 178
 179 This option is passed through \fBinstall\fR
 180 or \fBremove\fR commands to other
 181 \fBmodprobe\fR commands in the
 182 MODPROBE_OPTIONS environment variable.
 183 .TP
 184 \fB--set-version \fR
 185 Set the kernel version, rather than using
 186 \fBuname\fR(2) to decide on the kernel version (which dictates where to
 187 find the modules).  This also disables backwards
 188 compatibility checks (so
 189 \fBmodprobe.old\fR(8) will never be run).
 190 .TP
 191 \fB--show-depends \fR
 192 List the dependencies of a module (or alias), including
 193 the module itself.  This produces a (possibly empty) set
 194 of module filenames, one per line, each starting with
 195 "insmod".  Install commands which apply are shown prefixed by
 196 "install".  It does not run any of the install commands.  Note that
 197 \fBmodinfo\fR(8)
 198 can be used to extract dependencies of a module from the
 199 module itself, but knows nothing of aliases or install commands.
 200 .TP
 201 \fB-o --name \fR
 202 This option tries to rename the module which is being
 203 inserted into the kernel.  Some testing modules can
 204 usefully be inserted multiple times, but the kernel
 205 refuses to have two modules of the same name.  Normally,
 206 modules should not require multiple insertions, as that
 207 would make them useless if there were no module support.
 208 .TP
 209 \fB--first-time \fR
 210 Normally, \fBmodprobe\fR will succeed (and do
 211 nothing) if told to insert a module which is already
 212 present, or remove a module which isn't present.  This is
 213 backwards compatible with the modutils, and ideal for
 214 simple scripts.  However, more complicated scripts often
 215 want to know whether \fBmodprobe\fR really
 216 did something: this option makes modprobe fail for that
 217 case.
 218 .SH "BACKWARDS COMPATIBILITY"
 219 .PP
 220 This version of \fBmodprobe\fR is for kernels
 221 2.5.48 and above.  If it detects a kernel
 222 with support for old-style modules (for which much of the work
 223 was done in userspace), it will attempt to run
 224 \fBmodprobe.old\fR in its place, so it is
 225 completely transparent to the user.
 226 .SH "ENVIRONMENT"
 227 .PP
 228 The MODPROBE_OPTIONS environment variable can also be used to
 229 pass arguments to \fBmodprobe\fR\&.
 230 .SH "COPYRIGHT"
 231 .PP
 232 This manual page Copyright 2002, Rusty Russell, IBM Corporation.
 233 .SH "SEE ALSO"
 234 .PP
 235 \fBmodprobe.conf\fR(5),
 236 \fBlsmod\fR(8),
 237 \fBmodprobe.old\fR(8)