modprobeのヘルプ・マニュアル
日本語 英語
modprobe --help
man modprobe
MODPROBE(8) MODPROBE(8)
名前
modprobe - Linux カーネルにモジュールを追加したり削除したりするプログラ
ム
書式
modprobe [ -v ] [ -V ] [ -C config-file ] [ -n ] [ -i ] [ -q ] [ -o
modulename ] [ modulename ] [ module parameters ... ]
modprobe [ -r ] [ -v ] [ -n ] [ -i ] [ modulename ... ]
modprobe [ -l ] [ -t dirname ] [ wildcard ]
modprobe [ -c ]
説明
modprobe は Linux カーネルに賢くモジュールを追加したり削除したりする。
利便性のため、モジュール名において _ と - の違いはないことに注意。 mod-
probe は 、 全 て の モジュールと他のファイルをモジュールディレクトリ
/lib/modules/‘uname -r‘ から参照する。このほかに、もしあれば /etc/mod-
probe.conf 設定ファイルと /etc/modprobe.d ディレクトリを参照する (mod-
probe.conf(5) を参照) 。
このバージョンの modprobe は、自身ではモジュールに対して何もしないこ と
に 注意。シンボルの解決やパラメータの解釈といった処理はカーネルの中で行
なわれる。そのため、モジュールの不具合はカーネルのメッセージとして報 告
されることもある。 dmesg(8) を参照。
modprobe を実行するときは、 depmod (depmod(8) を参照) で生成された mod-
ules.dep が最新の状態になっていなければならない。このファイルには、それ
ぞ れのモジュールが (もしあれば) 他のどのモジュールを必要としているかが
列挙されていて、 modprobe はこれを使って依存するモジュールを自動的に 追
加したり削除したりする。 (modules.dep(5) を参照) 。
modulename の後ろに指定された引数は、カーネルに渡される (設定ファイルに
列挙されたオプションに追加される) 。
オプション
-v --verbose
プログラムが何をしているかに関するメッセージを表示する。通 常 、
modprobe は何かまずいことが起こった場合に限ってメッセージを表示
する。
このオプションは install および remove コマンドを通じて 、 MOD-
PROBE_OPTIONS 環境変数にある modprobe の他のコマンドに渡される。
-C --config
このオプションはデフォルトの設定ファイル (/etc/modprobe.conf や
/etc/modprobe.d/) を無視する。
こ の オプションは install および remove コマンドを通じて、 MOD-
PROBE_OPTIONS 環境変数にある modprobe の他のコマンドに渡される。
-c --showconfig
設定ファイルの内容を表示し、終了する。
-n --dry-run
このオプションは実際にモジュールを登録したり削除したりする (ある
いは install や remove コマンドを実行する) 以外の、全ての処理 を
行なう。 -v と組み合わせて使うと、不具合をデバッグするのに便利で
ある。
-i --ignore-install --ignore-remove
このオプションを使うと、 modprobe はコマンドラインで指定されたモ
ジ ュールに対する設定ファイル中の install および remove コマンド
を (もしあれば) 無視する (ただし、依存するモジュールは設定ファイ
ル中のコマンドに従う) 。 modprobe.conf(5) を参照。
-q --quiet
通 常 、 modprobe は 見 つ からない (かつエイリアスでもないか
install/remove コマンドでもない) モジュールを削除したり登録し た
り し よ うとすると、エラーを通知する。このフラグを使うと、 mod-
probe はでたらめな名前は単に無視する (カーネルはこの名前を使って
存在するかもしれないモジュールを日和見的にプローブする) 。
-r --remove
このオプションで modprobe はモジュールを削除する。このオプション
がない場合は登録する。依存するモジュールも使われていない場 合 、
modprobe はそれらも削除しようとする。登録とは異なり、複数のモジ
ュールをコマンドラインで指定することができる (モジュールを削除す
るときにモジュールパラメータを指定するのは意味がない) 。
通常は、モジュールを削除する理由などないが、不具合のあるモジュー
ルには必要である。使っているカーネルがモジュールの削除に対応して
いないかもしれない。
-V --version
プログラムのバージョンを表示し、終了する。古いカーネルで実行する
場合の注意については下を参照。
-f --force
モジュールからバージョンに関する情報を取り除こうとする (そうしな
い と ロ ー ド で き な いモジュールに対して) 。このオプションは
--force-vermagic と --force-modversion オプションの両方を使っ た
のと同じである。当然のことながら、これらのチェックはあなたを守る
ために存在するのであって、このオプションを使うのは危険である。
このオプションは登録されるすべてのモジュールに適用される。つまり
、コマンドラインで指定したモジュール (またはエイリアス) だけでな
く、依存するモジュールにも有効である。
--force-vermagic
どのモジュールにも、カーネルやコンパイラのバージョンといった、重
要な情報を持つ短い文字列がある。モジュールがロードに失敗し、カー
ネルが "version magic" が一致しないと文句を言う場合、このオプ シ
ョ ンを使って "version magic" を削除することができる。当然のこと
ながら、これらのチェックはあなたを守るために存在するのであって、
このオプションを使うのは危険である。
このオプションは登録されるすべてのモジュールに適用される。つまり
、コマンドラインで指定したモジュール (またはエイリアス) だけでな
く、依存するモジュールにも有効である。
--force-modversion
モジュールが CONFIG_MODVERSIONS をセットしてコンパイルされている
場合、モジュールが使っている (または提供する) ひとつひとつのイン
タフェースのバージョンを記したセクションが生成される。モジュール
がロードに失敗し、カーネルがインタフェースのバージョンの一致しな
いものがあると文句を言う場合、 "--force-modversion" を使ってバー
ジョン情報をばっさり削除することができる。当然のことながら、これ
らのチェックはあなたを守るために存在するのであって、このオプショ
ンを使うのは危険である。
このオプションは登録されるすべてのモジュールに適用される。つまり
、コマンドラインで指定したモジュール (またはエイリアス) だけでな
く、依存するモジュールにも有効である。
-l --list
指定されたワイルドカード (あるいはワイルドカードが指定されない場
合 "*") に一致するすべてのモジュールを列挙する。このオプションは
下位互換性のために用意されている。もっと柔軟性のある代替品として
、 find(1) や basename(1) を参照。
-a --all
指定されたワイルドカードに一致する全てのモジュールを登録する。こ
のオプションは下位互換性のために用意されている。もっと柔軟性のあ
る代替品として、 find(1) や basename(1) を参照。
-t --type
-l を指定された dirname に一致するディレクトリにあるモジュールに
限定する。このオプションは下位互換性のために用意されている。もっ
と柔軟性のある代替品として、 find(1) や basename(1) を参照。
-s --syslog
このオプションを使うと、すべてのエラーメッセージが syslog の仕組
みで (LOG_NOTICE というレベルの LOG_DAEMON として) 通知される よ
うになる。このオプションがない場合は標準エラーに出力される。この
オプションは標準エラーが使えない場合、自動的に有効になる。
このオプションは install および remove コマンドを通じて 、 MOD-
PROBE_OPTIONS 環境変数にある modprobe の他のコマンドに渡される。
--set-version
カーネルバージョンを設定する。このオプションがない場合、カーネル
バ ー ジ ョ ン (モジュールを検索する場所を表す) を決定するために
uname(2) が使われる。このオプションは下位互換性のチェックも無 効
にする (そのため modprobe.old(8) は一切実行されない) 。
--show-depends
モジュール (またはエイリアス) の依存関係を列挙する。モジュール自
身も含まれる。このオプションはモジュールのファイル名の集合 (空の
場合もある) を生成する。 1 行に 1 個のモジュールが表示され、先頭
に "insmod" が付く。 install コマンドが適用される場合、 先 頭 に
"install" が付く。 install コマンドは一切実行しない。 modinfo(8)
を使えばモジュール自身からモジュールの依存関係を取り出すことがで
き るが、エイリアスや install コマンドについては全く分からないこ
とに注意。
-o --name
このオプションはカーネルに登録されるモジュールの名前を変更しよう
とする。テスト用のモジュールには複数回登録することのできるものが
あり便利だが、カーネルは同じ名前のモジュールが 2 個あると拒否 す
る。通常、モジュールを複数回登録する必要はないはずである。なぜな
らモジュールに対応していない場合に役に立たないからである。
--first-time
通常、 modprobe はすでに存在するモジュールを登録しようとした場合
や存在しないモジュールを削除しようとした場合にも成功する (そして
何もしない) 。この振る舞いは modutils と下位互換性があり、単純な
スクリプトにとっては望ましい。しかし、もっと複雑なスクリプトでは
modprobe が実際に何かをしたかどうかを知りたくなることも多い。 こ
のオプションは上のような場合、 modprobe が失敗するようにする。
下位互換性
こ のバージョンの modprobe は、カーネル 2.5.48 およびそれ以降のためのも
のである。古い形式のモジュールに対応したカーネルを検出すると (そのた め
の ほとんどの処理はユーザ空間で行なわれる) 、その場で modprobe.old を実
行しようとする。そのため、ユーザは全く意識しなくてよい。
環境変数
MODPROBE_OPTIONS 環境変数も modprobe に引数を渡すのに使うことができる。
著作権
こ の マニュアルページの著作権表示は Copyright 2002, Rusty Russell, IBM
Corporation.
関連項目
modprobe.conf(5), lsmod(8), modprobe.old(8)
08 May 2005 MODPROBE(8)
MODPROBE(8) MODPROBE(8)
NAME
modprobe - program to add and remove modules from the Linux Kernel
SYNOPSIS
modprobe [ -v ] [ -V ] [ -C config-file ] [ -n ] [ -i ] [ -q ] [
-b ] [ -o modulename ] [ modulename ] [ module parameters... ]
modprobe [ -r ] [ -v ] [ -n ] [ -i ] [ modulename... ]
modprobe [ -l ] [ -t dirname ] [ wildcard ]
modprobe [ -c ]
modprobe [ --dump-modversions ]
DESCRIPTION
modprobe intelligently adds or removes a module from the Linux kernel:
note that for convenience, there is no difference between _ and - in
module names. modprobe looks in the module directory /lib/mod-
ules/‘uname -r‘ for all the modules and other files, except for the
optional /etc/modprobe.conf configuration file and /etc/modprobe.d
directory (see modprobe.conf(5)). modprobe will also use module options
specified on the kernel command line in the form of ..
Note that this version of modprobe does not do anything to the module
itself: the work of resolving symbols and understanding parameters is
done inside the kernel. So module failure is sometimes accompanied by a
kernel message: see dmesg(8).
modprobe expects an up-to-date modules.dep file, as generated by depmod
(see depmod(8)). This file lists what other modules each module needs
(if any), and modprobe uses this to add or remove these dependencies
automatically. See modules.dep(5)).
If any arguments are given after the modulename, they are passed to the
kernel (in addition to any options listed in the configuration file).
OPTIONS
-v --verbose
Print messages about what the program is doing. Usually modprobe
only prints messages if something goes wrong.
This option is passed through install or remove commands to
other modprobe commands in the MODPROBE_OPTIONS environment
variable.
-C --config
This option overrides the default configuration directory/file
(/etc/modprobe.d or /etc/modprobe.conf).
This option is passed through install or remove commands to
other modprobe commands in the MODPROBE_OPTIONS environment
variable.
-c --showconfig
Dump out the effective configuration from the config directory
and exit.
-n --dry-run
This option does everything but actually insert or delete the
modules (or run the install or remove commands). Combined with
-v, it is useful for debugging problems.
-i --ignore-install --ignore-remove
This option causes modprobe to ignore install and remove com-
mands in the configuration file (if any) for the module speci-
fied on the command line (any dependent modules are still sub-
ject to commands set for them in the configuration file). See
modprobe.conf(5).
-q --quiet
Normally modprobe will report an error if you try to remove or
insert a module it can’t find (and isn’t an alias or
install/remove command). With this flag, modprobe will simply
ignore any bogus names (the kernel uses this to opportunisti-
cally probe for modules which might exist).
-r --remove
This option causes modprobe to remove rather than insert a mod-
ule. If the modules it depends on are also unused, modprobe will
try to remove them too. Unlike insertion, more than one module
can be specified on the command line (it does not make sense to
specify module parameters when removing modules).
There is usually no reason to remove modules, but some buggy
modules require it. Your kernel may not support removal of mod-
ules.
-w --wait
This option is applicable only with the -r or --remove option.
It causes modprobe to block in the kernel (within the kernel
module handling code itself) waiting for the specified module’s
reference count to reach zero. Default operation is for modprobe
to operate like rmmod, which exits with EWOULDBLOCK if the mod-
ule’s reference count is non-zero.
-V --version
Show version of program and exit.
-f --force
Try to strip any versioning information from the module which
might otherwise stop it from loading: this is the same as using
both --force-vermagic and --force-modversion. Naturally, these
checks are there for your protection, so using this option is
dangerous.
This applies to any modules inserted: both the module (or alias)
on the command line and any modules it on which it depends.
--force-vermagic
Every module contains a small string containing important infor-
mation, such as the kernel and compiler versions. If a module
fails to load and the kernel complains that the "version magic"
doesn’t match, you can use this option to remove it. Naturally,
this check is there for your protection, so this using option is
dangerous.
This applies to any modules inserted: both the module (or alias)
on the command line and any modules on which it depends.
--force-modversion
When modules are compiled with CONFIG_MODVERSIONS set, a section
detailing the versions of every interfaced used by (or supplied
by) the module is created. If a module fails to load and the
kernel complains that the module disagrees about a version of
some interface, you can use "--force-modversion" to remove the
version information altogether. Naturally, this check is there
for your protection, so using this option is dangerous.
This applies any modules inserted: both the module (or alias) on
the command line and any modules on which it depends.
-l --list
List all modules matching the given wildcard (or "*" if no wild-
card is given). This option is provided for backwards compati-
bility: see find(1) and basename(1) for a more flexible alterna-
tive.
-a --all
Insert all module names on the command line.
-t --type
Restrict -l to modules in directories matching the dirname
given. This option is provided for backwards compatibility: see
find(1) and basename(1) for a more flexible alternative.
-s --syslog
This option causes any error messages to go through the syslog
mechanism (as LOG_DAEMON with level LOG_NOTICE) rather than to
standard error. This is also automatically enabled when stderr
is unavailable.
This option is passed through install or remove commands to
other modprobe commands in the MODPROBE_OPTIONS environment
variable.
-S --set-version
Set the kernel version, rather than using uname(2) to decide on
the kernel version (which dictates where to find the modules).
-D --show-depends
List the dependencies of a module (or alias), including the mod-
ule itself. This produces a (possibly empty) set of module file-
names, one per line, each starting with "insmod". Install com-
mands which apply are shown prefixed by "install". It does not
run any of the install commands. Note that modinfo(8) can be
used to extract dependencies of a module from the module itself,
but knows nothing of aliases or install commands.
-o --name
This option tries to rename the module which is being inserted
into the kernel. Some testing modules can usefully be inserted
multiple times, but the kernel refuses to have two modules of
the same name. Normally, modules should not require multiple
insertions, as that would make them useless if there were no
module support.
--first-time
Normally, modprobe will succeed (and do nothing) if told to
insert a module which is already present or to remove a module
which isn’t present. This is ideal for simple scripts; however,
more complicated scripts often want to know whether modprobe
really did something: this option makes modprobe fail for that
case.
--dump-modversions
Print out a list of module versioning information required by a
module. This option is commonly used by distributions in order
to package up a Linux kernel module using module versioning
deps.
-b --use-blacklist
This option causes modprobe to apply the blacklist commands in
the configuration files (if any) to module names as well. It is
usually used by udev(7).
-d --dirname
Directory where modules can be found, /lib/modules/RELEASE by
default.
ENVIRONMENT
The MODPROBE_OPTIONS environment variable can also be used to pass
arguments to modprobe.
COPYRIGHT
This manual page Copyright 2002, Rusty Russell, IBM Corporation.
SEE ALSO
modprobe.conf(5), lsmod(8), modinfo(8)
2002-12-27 MODPROBE(8)