manual/kmod/release/man8/modprobe.8

   1 '\" t
   2 .\"     Title: modprobe
   3 .\"    Author: Jon Masters <jcm@jonmasters.org>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 01/29/2021
   6 .\"    Manual: modprobe
   7 .\"    Source: kmod
   8 .\"  Language: English
   9 .\"
  10 .\"*******************************************************************
  11 .\"
  12 .\" This file was generated with po4a. Translate the source file.
  13 .\"
  14 .\"*******************************************************************
  15 .\"
  16 .\" Japanese Version Copyright (C) 2005 Suzuki Takashi,
  17 .\"         and 2022 ribbon,
  18 .\"         and 2022 Chonan Yoichi,
  19 .\"         all rights reserved.
  20 .\" Translated (module-init-tools) Sun Jul 10 00:42:36 JST 2005
  21 .\"         by Suzuki Takashi <JM@linux.or.jp>.
  22 .\" New Translation (kmod version 29) Tue May 31 2022
  23 .\"         by ribbon <ribbon@users.osdn.me>
  24 .\" Modified Tue Oct 25 09:28:07 JST 2022
  25 .\"         by Chonan Yoichi <cyoichi@maple.ocn.ne.jp>
  26 .\"
  27 .\" This program is free software: you can redistribute it and/or modify
  28 .\" it under the terms of the GNU General Public License as published by
  29 .\" the Free Software Foundation, either version 2 of the License, or
  30 .\" (at your option) any later version.
  31 .\"
  32 .\" This program is distributed in the hope that it will be useful,
  33 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  34 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  35 .\" GNU General Public License for more details.
  36 .\"
  37 .\" You should have received a copy of the GNU General Public License
  38 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
  39 .\"
  40 .TH MODPROBE 8 2021/01/29 kmod modprobe
  41 .ie  \n(.g .ds Aq \(aq
  42 .el       .ds Aq '
  43 .\" -----------------------------------------------------------------
  44 .\" * Define some portability stuff
  45 .\" -----------------------------------------------------------------
  46 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47 .\" http://bugs.debian.org/507673
  48 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  49 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50 .\" -----------------------------------------------------------------
  51 .\" * set default formatting
  52 .\" -----------------------------------------------------------------
  53 .\" disable hyphenation
  54 .nh
  55 .\" disable justification (adjust text to left margin only)
  56 .ad l
  57 .\" -----------------------------------------------------------------
  58 .\" * MAIN CONTENT STARTS HERE *
  59 .\" -----------------------------------------------------------------
  60 .SH 名前
  61 modprobe \- Linux カーネルに対してモジュールの着脱を行う
  62 .SH 書式
  63 .HP \w'\fBmodprobe\fR\ 'u
  64 \fBmodprobe\fP [\fB\-v\fP] [\fB\-V\fP] [\fB\-C\ \fP\fIconfig\-file\fP] [\fB\-n\fP] [\fB\-i\fP] [\fB\-q\fP]
  65 [\fB\-b\fP] [\fImodulename\fP] [\fImodule\ parameters\fP...]
  66 .HP \w'\fBmodprobe\fR\ 'u
  67 \fBmodprobe\fP [\-r] [\fB\-v\fP] [\fB\-n\fP] [\fB\-i\fP] [\fImodulename\fP...]
  68 .HP \w'\fBmodprobe\fR\ 'u
  69 \fBmodprobe\fP [\-c]
  70 .HP \w'\fBmodprobe\fR\ 'u
  71 \fBmodprobe\fP [\-\-dump\-modversions] [\fIfilename\fP]
  72 .SH 説明
  73 .PP
  74 \fBmodprobe\fP は、Linux
  75 カーネルに対して頭のよいやり方でモジュールの追加や取り外しを行います。
  76 なお、ユーザの便宜を考慮して、モジュール名に含まれる _ と \- とを区別しません
  77 (アンダースコアの変換が自動的に行われます)。
  78 \fBmodprobe\fP は、モジュールディレクトリ /lib/modules/`uname \-r`
  79 を見て、すべてのモジュールやそのほかのファイルをそれ以下に捜します。
  80 ただし、作成が任意の設定ファイルについては、/etc/modprobe\&.d
  81 ディレクトリを調べます (\fBmodprobe.d\fP(5) 参照)。
  82 \fBmodprobe\fP はまた、カーネルコマンドラインで指定された、
  83 モジュールオプションやブラックリストも使用します。前者の書式は
  84 <module>\&.<option>
  85 であり、後者の書式は modprobe\&.blacklist=<module> です。
  86 .PP
  87 なお、2\&.4 系列の Linux カーネル (このツールはサポートしていません)
  88 の場合とは違って、当バージョンの \fBmodprobe\fP
  89 は、モジュールそのものに対しては何の操作も行いません。
  90 シンボルの解決やパラメータの解釈といった作業は、
  91 カーネルの内部で行われます。そこで、モジュールの処理に失敗すると、
  92 カーネルメッセージが出ることがあります。\fBdmesg\fP(8) を参照してください。
  93 .PP
  94 \fBmodprobe\fP は、modules\&.dep\&.bin
  95 ファイルが最新であることを当てにしています。このファイルは、\fBmodprobe\fP
  96 と一緒に配布され、現在の \fBmodprobe\fP に対応している
  97 \fBdepmod\fP(8) ユーティリティによって生成されます
  98 (\fBdepmod\fP(8) 参照)。modules\&.dep\&.bin
  99 は、各モジュールが、ほかのどんなモジュールを必要としているかを
 100 (そういったものがあれば) リストしており、\fBmodprobe\fP は、このファイルを使用して、
 101 そうした依存するモジュールを自動的に追加したり、取り外したりします。
 102 .PP
 103 \fImodulename\fP の後ろに引数を付けると、そうした引数はカーネルに渡されます
 104 (設定ファイルで指定しているモジュールオプション (モジュールパラメータとも言います)
 105 があれば、そこに追加されるわけです)。
 106 .SH オプション
 107 .PP
 108 \fB\-a\fP, \fB\-\-all\fP
 109 .RS 4
 110 コマンドラインで指定されたモジュール名をすべて組み込みます。
 111 .RE
 112 .PP
 113 \fB\-b\fP, \fB\-\-use\-blacklist\fP
 114 .RS 4
 115 このオプションを指定すると、\fBmodprobe\fP は、設定ファイルに \fBblacklist\fP
 116 コマンドがあれば、それもモジュール名に対して適用します。
 117 このオプションは通常、\fBudev\fP(7) によって使用されます。
 118 .RE
 119 .PP
 120 \fB\-C\fP, \fB\-\-config\fP
 121 .RS 4
 122 このオプションは、設定ディレクトリをデフォルトの /etc/modprobe\&.d
 123 から変更します。
 124 .sp
 125 このオプションは、環境変数 MODPROBE_OPTIONS に入れられて、\fBinstall\fP や
 126 \fBremove\fP コマンド経由で、ほかの \fBmodprobe\fP コマンドにも渡されます。
 127 .RE
 128 .PP
 129 \fB\-c\fP, \fB\-\-showconfig\fP
 130 .RS 4
 131 設定ディレクトリを読み込み、有効な設定を標準出力に書き出して、終了します。
 132 .RE
 133 .PP
 134 \fB\-\-dump\-modversions\fP
 135 .RS 4
 136 あるモジュールが要求している、そのモジュールのバージョン管理情報のリストを表示します。
 137 このオプションは通常、モジュールのバージョン管理の依存情報を利用して Linux
 138 のカーネルモジュールをパッケージにまとめるために、
 139 ディストリビューションによって使用されます。
 140 .RE
 141 .PP
 142 \fB\-d\fP, \fB\-\-dirname\fP
 143 .RS 4
 144 モジュール群にとってのルートディレクトリ。デフォルトでは / です。
 145 .RE
 146 .PP
 147 \fB\-\-first\-time\fP
 148 .RS 4
 149 通常、\fBmodprobe\fP は、すでに存在するモジュールの組み込みや、
 150 存在しないモジュールの取り外しを命じられても、処理に成功したものとして
 151 (何もせずに) 終了します。これは単純なスクリプトではまったく問題がありません。
 152 でも、より複雑なスクリプトでは、\fBmodprobe\fP
 153 が実際に何らかの処理を行ったかどうかを知りたいことがよくあります。
 154 このオプションを使うと、\fBmodprobe\fP は、実際には何もしなかった場合、
 155 実行に失敗したことになります。
 156 .RE
 157 .PP
 158 \fB\-\-force\-vermagic\fP
 159 .RS 4
 160 どのモジュールの中にも、
 161 カーネルやコンパイラのバージョンといった重要な情報を含む短い文字列が存在します。
 162 モジュールのロードに失敗して、
 163 カーネルが「バージョンマジックが一致しない」と苦情を言って来る場合、
 164 このオプションを使えば、そのバージョンマジックを除去することができます。
 165 言うまでもありませんが、こうしたチェックは、
 166 ユーザを守るためにあるのですから、自分のやっていることがよくわかっていないかぎり、
 167 このオプションを使うのは危険です。
 168 .sp
 169 このオプションは、組み込まれるどんなモジュールにも適用されます。
 170 すなわち、コマンドラインで指定されたモジュール (やエイリアス) だけでなく、
 171 それが依存するモジュールがあれば、それにも適用されます。
 172 .RE
 173 .PP
 174 \fB\-\-force\-modversion\fP
 175 .RS 4
 176 CONFIG_MODVERSIONS を有効にして、モジュールをコンパイルすると、
 177 そのモジュールが利用する (あるいは、提供する)
 178 すべてのインターフェースのバージョンを記録したセクションが、モジュール内に作られます。
 179 モジュールのロードに失敗して、カーネルが「モジュールのインターフェースに、
 180 バージョンがカーネル側と一致しないものがある」と苦情を言って来る場合、
 181 "\-\-force\-modversion" を使えば、そうしたバージョン情報をそっくり除去することができます。
 182 言うまでもありませんが、こうしたチェックは、ユーザを守るためにあるのですから、
 183 自分のやっていることがよくわかっていないかぎり、このオプションを使うのは危険です。
 184 .sp
 185 このオプションは、組み込まれるどんなモジュールにも適用されます。
 186 すなわち、コマンドラインで指定されたモジュール (やエイリアス) だけでなく、
 187 それが依存するモジュールがあれば、それにも適用されます。
 188 .RE
 189 .PP
 190 \fB\-f\fP, \fB\-\-force\fP
 191 .RS 4
 192 バージョン管理に関する情報がモジュールにあると、ロードが中断しかねない場合に、
 193 モジュールからそうした情報をすべて取り除こうとします。
 194 これは \fB\-\-force\-vermagic\fP と \fB\-\-force\-modversion\fP
 195 の両方を使用するのと同じことです。
 196 言うまでもありませんが、こうしたチェックはユーザを守るためにあるのですから、
 197 自分のやっていることがよくわかっていないかぎり、このオプションを使うのは危険です。
 198 .sp
 199 このオプションは、組み込まれるどんなモジュールにも適用されます。
 200 すなわち、コマンドラインで指定されたモジュール (やエイリアス) だけでなく、
 201 それが依存するモジュールがあれば、それにも適用されます
 202 .RE
 203 .PP
 204 \fB\-i\fP, \fB\-\-ignore\-install\fP, \fB\-\-ignore\-remove\fP
 205 .RS 4
 206 このオプションを使うと、\fBmodprobe\fP
 207 は、コマンドラインで指定されたモジュールに対して設定ファイル中に
 208 install や remove コマンドが存在しても、それを無視します
 209 (依存するモジュールについては、このオプションを指定した場合でも、
 210 設定ファイル中でそのモジュールに対して設定されているコマンドの対象になります)。
 211 現状では、このオプションを使用した場合、\fBinstall\fP と \fBremove\fP
 212 の両方のコマンドが無視されることになります。
 213 \fB\-\-ignore\-install\fP や \fB\-\-ignore\-remove\fP の片方のみを使って
 214 (そして、両方を使うことなく) より具体的に指定しても、動作は変わりません。
 215 \fBmodprobe.d(5)\fP を参照してください。
 216 .RE
 217 .PP
 218 \fB\-n\fP, \fB\-\-dry\-run\fP, \fB\-\-show\fP
 219 .RS 4
 220 このオプションを指定すると、実際にモジュールを組み込んだり、取り外したり
 221 (それに、install や remove コマンドを実行したり) する以外のあらゆることを行います。
 222 \fB\-v\fP オプションと組み合わせると、問題が起きたときのデバッグに便利です。
 223 歴史的な理由から  \fB\-\-dry\-run\fP と \fB\-\-show\fP は事実上同じ意味なので、
 224 どちらを使っても構いません。
 225 .RE
 226 .PP
 227 \fB\-q\fP, \fB\-\-quiet\fP
 228 .RS 4
 229 このフラグを使用すると、\fBmodprobe\fP は、モジュールを取り外したり、
 230 組み込んだりしようとして、それが見つからなかった場合に
 231 (しかも、それがエイリアスの名前でも、\fBinstall\fP や \fBremove\fP
 232 コマンドの対象でもなかった場合に)、エラーメッセージを出さなくなります。それでも、
 233 ゼロ以外のステータスで終了することに変わりはありません。なお、カーネルは、
 234 存在するかどうかが不確かなモジュールの探索を request_module
 235 関数を使って便宜主義的に行うために、このフラグを使用します。
 236 .RE
 237 .PP
 238 \fB\-R\fP, \fB\-\-resolve\-alias\fP
 239 .RS 4
 240 あるエイリアスに対応するモジュール名をすべて表示します。
 241 モジュールのエイリアスに問題がある場合、デバッグの役に立つかもしれません。
 242 .RE
 243 .PP
 244 \fB\-r\fP, \fB\-\-remove\fP
 245 .RS 4
 246 このオプションを指定すると、\fBmodprobe\fP は、モジュールを組み込む代わりに、
 247 それを取り外します。そのモジュールが依存しているモジュールも使用されていない場合は、
 248 それもまた取り外そうとします。組み込みを行う場合とは違って、
 249 複数のモジュールをコマンドラインで指定することができます
 250 (モジュールを取り外す場合には、モジュールパラメータを指定しても意味がありません)。
 251 .sp
 252 通常は、モジュールを取り外す理由などありませんが、
 253 モジュールにバグのある場合には、それが必要になることもあります。
 254 もっとも、ご使用のディストリビューションのカーネルは、
 255 モジュール取り外しのサポートを有効にしてビルドされていないかもしれません。
 256 .RE
 257 .PP
 258 \fB\-S\fP, \fB\-\-set\-version\fP
 259 .RS 4
 260 カーネルのバージョンを設定します。すなわち、カーネルのバージョン
 261 (それによって、モジュールを探しに行く場所が決まります)
 262 を判断するのに、\fBuname\fP(2) を使用しません。
 263 .RE
 264 .PP
 265 \fB\-\-show\-depends\fP
 266 .RS 4
 267 あるモジュール (または、エイリアス) の依存関係を、そのモジュール自体も含めて、
 268 一覧表示します。モジュールファイル名の集合 (空集合のこともあります) が、1 行に
 269 1 ファイルずつ、各行の先頭に "insmod" を付けて、出力されます。
 270 このオプションの代表的な使い道は、ディストリビューションが initrd/initramfs
 271 イメージを作成するとき、どのモジュールを収録するかを決めるのに使うことです。
 272 \fBInstall\fP コマンドが適用されている場合は、"install"
 273 という文字列を行頭に置くことで、それを示しますが、そうした install
 274 コマンドが実行されるわけではありません。なお、\fBmodinfo\fP(8) を使えば、
 275 モジュールの依存関係をそのモジュール自体から取り出すことができますが、
 276 \fBmodinfo\fP は、設定ファイルの alias や install といったコマンドについては、
 277 何も知らないことに注意してください。
 278 .RE
 279 .PP
 280 \fB\-s\fP, \fB\-\-syslog\fP
 281 .RS 4
 282 このオプションを指定すると、エラーメッセージがある場合に、
 283 それを標準エラーに送るのではなく、syslog の仕組みを通して出力します
 284 (LOG_NOTICE レベルの LOG_DAEMON として扱われます)。
 285 このオプションは、標準エラーが使えない場合にも、自動的に有効になります。
 286 .sp
 287 このオプションは、環境変数 MODPROBE_OPTIONS に入れられて、\fBinstall\fP や
 288 \fBremove\fP コマンド経由で、ほかの \fBmodprobe\fP コマンドにも渡されます。
 289 .RE
 290 .PP
 291 \fB\-V\fP, \fB\-\-version\fP
 292 .RS 4
 293 プログラムのバージョンを表示して終了します。
 294 .RE
 295 .PP
 296 \fB\-v\fP, \fB\-\-verbose\fP
 297 .RS 4
 298 プログラムが何をやっているかについてメッセージを表示します。通常
 299 modprobe がメッセージを出すのは、何かがうまく行かなかったときだけです。
 300 .sp
 301 このオプションは、環境変数 MODPROBE_OPTIONS に入れられて、\fBinstall\fP や
 302 \fBremove\fP コマンド経由で、ほかの \fBmodprobe\fP コマンドにも渡されます。
 303 .RE
 304 .SH 環境変数
 305 .PP
 306 環境変数 MODPROBE_OPTIONS は、\fBmodprobe\fP
 307 コマンドに引数を渡すためにユーザが使用することもできます。
 308 .SH 著作権
 309 .PP
 310 このマニュアルページの最初の版は、"Copyright 2002, Rusty Russell, IBM Corporation"
 311 でした。現在では、Jon Masters ほか数名によって保守されています。
 312 .SH 関連項目
 313 .PP
 314 \fBmodprobe.d\fP(5), \fBinsmod\fP(8), \fBrmmod\fP(8), \fBlsmod\fP(8), \fBmodinfo\fP(8)
 315 \fBdepmod\fP(8)
 316 .SH 著者
 317 .PP
 318 \fBJon Masters\fP <\&jcm@jonmasters\&.org\&>
 319 .RS 4
 320 開発者
 321 .RE
 322 .PP
 323 \fBRobby Workman\fP <\&rworkman@slackware\&.com\&>
 324 .RS 4
 325 開発者
 326 .RE
 327 .PP
 328 \fBLucas De Marchi\fP <\&lucas\&.de\&.marchi@gmail\&.com\&>
 329 .RS 4
 330 開発者
 331 .RE