manual/kmod/draft/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) ユーティリティによって生成されます (\fBdepmod\fP(8) 参照)。
  98 modules\&.dep\&.bin は、各モジュールが、ほかのどんなモジュールを必要としているかを
  99 (そういったものがあれば) リストしており、\fBmodprobe\fP は、このファイルを使用して、
 100 そうした依存するモジュールを自動的に追加したり、取り外したりします
 101 .PP
 102 \fImodulename\fP の後ろに引数を付けると、そうした引数はカーネルに渡されます
 103 (設定ファイルで指定しているモジュールオプション (モジュールパラメータとも言います)
 104 があれば、そこに追加されるわけです)。
 105 .SH オプション
 106 .PP
 107 \fB\-a\fP, \fB\-\-all\fP
 108 .RS 4
 109 コマンドラインで指定されたモジュール名をすべて組み込みます。
 110 .RE
 111 .PP
 112 \fB\-b\fP, \fB\-\-use\-blacklist\fP
 113 .RS 4
 114 このオプションを指定すると、\fBmodprobe\fP は、設定ファイルに \fBblacklist\fP
 115 コマンドがあれば、それもモジュール名に対して適用します。
 116 このオプションは通常、\fBudev\fP(7) によって使用されます。
 117 .RE
 118 .PP
 119 \fB\-C\fP, \fB\-\-config\fP
 120 .RS 4
 121 このオプションは、設定ディレクトリをデフォルトの /etc/modprobe\&.d
 122 から変更します。
 123 .sp
 124 このオプションは、環境変数 MODPROBE_OPTIONS に入れられて、\fBinstall\fP や
 125 \fBremove\fP コマンド経由で、ほかの \fBmodprobe\fP コマンドにも渡されます。
 126 .RE
 127 .PP
 128 \fB\-c\fP, \fB\-\-showconfig\fP
 129 .RS 4
 130 設定ディレクトリを読み込み、有効な設定を標準出力に書き出して、終了します。
 131 .RE
 132 .PP
 133 \fB\-\-dump\-modversions\fP
 134 .RS 4
 135 あるモジュールが要求している、そのモジュールのバージョン管理情報のリストを表示します。
 136 このオプションは通常、モジュールのバージョン管理の依存情報を利用して Linux
 137 のカーネルモジュールをパッケージにまとめるために、
 138 ディストリビューションによって使用されます。
 139 .RE
 140 .PP
 141 \fB\-d\fP, \fB\-\-dirname\fP
 142 .RS 4
 143 モジュール群にとってのルートディレクトリ。デフォルトでは / です。
 144 .RE
 145 .PP
 146 \fB\-\-first\-time\fP
 147 .RS 4
 148 通常、\fBmodprobe\fP は、すでに存在するモジュールの組み込みや、
 149 存在しないモジュールの取り外しを命じられても、処理に成功したものとして
 150 (何もせずに) 終了します。これは単純なスクリプトではまったく問題がありません。
 151 でも、より複雑なスクリプトでは、\fBmodprobe\fP
 152 が実際に何らかの処理を行ったかどうかを知りたいことがよくあります。
 153 このオプションを使うと、\fBmodprobe\fP は、実際には何もしなかった場合、
 154 実行に失敗したことになります。
 155 .RE
 156 .PP
 157 \fB\-\-force\-vermagic\fP
 158 .RS 4
 159 どのモジュールの中にも、
 160 カーネルやコンパイラのバージョンといった重要な情報を含む短い文字列が存在します。
 161 モジュールのロードに失敗して、
 162 カーネルが「バージョンマジックが一致しない」と苦情を言って来る場合、
 163 このオプションを使えば、そのバージョンマジックを除去することができます。
 164 言うまでもありませんが、こうしたチェックは、
 165 ユーザを守るためにあるのですから、自分のやっていることがよくわかっていないかぎり、
 166 このオプションを使うのは危険です。
 167 .sp
 168 このオプションは、組み込まれるどんなモジュールにも適用されます。
 169 すなわち、コマンドラインで指定されたモジュール (やエイリアス) だけでなく、
 170 それが依存するモジュールがあれば、それにも適用されます。
 171 .RE
 172 .PP
 173 \fB\-\-force\-modversion\fP
 174 .RS 4
 175 CONFIG_MODVERSIONS を有効にして、モジュールをコンパイルすると、
 176 そのモジュールが利用する (あるいは、提供する)
 177 すべてのインターフェースのバージョンを記録したセクションが、モジュール内に作られます。
 178 モジュールのロードに失敗して、カーネルが「モジュールのインターフェースに、
 179 バージョンがカーネル側と一致しないものがある」と苦情を言って来る場合、
 180 "\-\-force\-modversion" を使えば、そうしたバージョン情報をそっくり除去することができます。
 181 言うまでもありませんが、こうしたチェックは、ユーザを守るためにあるのですから、
 182 自分のやっていることがよくわかっていないかぎり、このオプションを使うのは危険です。
 183 .sp
 184 このオプションは、組み込まれるどんなモジュールにも適用されます。
 185 すなわち、コマンドラインで指定されたモジュール (やエイリアス) だけでなく、
 186 それが依存するモジュールがあれば、それにも適用されます。
 187 .RE
 188 .PP
 189 \fB\-f\fP, \fB\-\-force\fP
 190 .RS 4
 191 バージョン管理に関する情報がモジュールにあると、ロードが中断しかねない場合に、
 192 モジュールからそうした情報をすべて取り除こうとします。
 193 これは \fB\-\-force\-vermagic\fP と \fB\-\-force\-modversion\fP
 194 の両方を使用するのと同じことです。
 195 言うまでもありませんが、こうしたチェックはユーザを守るためにあるのですから、
 196 自分のやっていることがよくわかっていないかぎり、このオプションを使うのは危険です。
 197 .sp
 198 このオプションは、組み込まれるどんなモジュールにも適用されます。
 199 すなわち、コマンドラインで指定されたモジュール (やエイリアス) だけでなく、
 200 それが依存するモジュールがあれば、それにも適用されます
 201 .RE
 202 .PP
 203 \fB\-i\fP, \fB\-\-ignore\-install\fP, \fB\-\-ignore\-remove\fP
 204 .RS 4
 205 このオプションを使うと、\fBmodprobe\fP
 206 は、コマンドラインで指定されたモジュールに対して設定ファイル中に
 207 install や remove コマンドが存在しても、それを無視します
 208 (依存するモジュールについては、このオプションを指定した場合でも、
 209 設定ファイル中でそのモジュールに対して設定されているコマンドの対象になります)。
 210 現状では、このオプションを使用した場合、\fBinstall\fP と \fBremove\fP
 211 の両方のコマンドが無視されることになります。
 212 \fB\-\-ignore\-install\fP や \fB\-\-ignore\-remove\fP の片方のみを使って
 213 (そして、両方を使うことなく) より具体的に指定しても、動作は変わりません。
 214 \fBmodprobe.d(5)\fP を参照してください。
 215 .RE
 216 .PP
 217 \fB\-n\fP, \fB\-\-dry\-run\fP, \fB\-\-show\fP
 218 .RS 4
 219 このオプションを指定すると、実際にモジュールを組み込んだり、取り外したり
 220 (それに、install や remove コマンドを実行したり) する以外のあらゆることを行います。
 221 \fB\-v\fP オプションと組み合わせると、問題が起きたときのデバッグに便利です。
 222 歴史的な理由から  \fB\-\-dry\-run\fP と \fB\-\-show\fP は事実上同じ意味なので、
 223 どちらを使っても構いません。
 224 .RE
 225 .PP
 226 \fB\-q\fP, \fB\-\-quiet\fP
 227 .RS 4
 228 このフラグを使用すると、\fBmodprobe\fP は、モジュールを取り外したり、
 229 組み込んだりしようとして、それが見つからなかった場合に
 230 (しかも、それがエイリアスの名前でも、\fBinstall\fP や \fBremove\fP
 231 コマンドの対象でもなかった場合に)、エラーメッセージを出さなくなります。それでも、
 232 ゼロ以外のステータスで終了することに変わりはありません。なお、カーネルは、
 233 存在するかどうかが不確かなモジュールの探索を request_module
 234 関数を使って便宜主義的に行うために、このフラグを使用します。
 235 .RE
 236 .PP
 237 \fB\-R\fP, \fB\-\-resolve\-alias\fP
 238 .RS 4
 239 あるエイリアスに対応するモジュール名をすべて表示します。
 240 モジュールのエイリアスに問題がある場合、デバッグの役に立つかもしれません。
 241 .RE
 242 .PP
 243 \fB\-r\fP, \fB\-\-remove\fP
 244 .RS 4
 245 このオプションを指定すると、\fBmodprobe\fP は、モジュールを組み込む代わりに、
 246 それを取り外します。そのモジュールが依存しているモジュールも使用されていない場合は、
 247 それもまた取り外そうとします。組み込みを行う場合とは違って、
 248 複数のモジュールをコマンドラインで指定することができます
 249 (モジュールを取り外す場合には、モジュールパラメータを指定しても意味がありません)。
 250 .sp
 251 通常は、モジュールを取り外す理由などありませんが、
 252 モジュールにバグのある場合には、それが必要になることもあります。
 253 もっとも、ご使用のディストリビューションのカーネルは、
 254 モジュール取り外しのサポートを有効にしてビルドされていないかもしれません。
 255 .RE
 256 .PP
 257 \fB\-S\fP, \fB\-\-set\-version\fP
 258 .RS 4
 259 カーネルのバージョンを設定します。すなわち、カーネルのバージョン
 260 (それによって、モジュールを探しに行く場所が決まります)
 261 を判断するのに、\fBuname\fP(2) を使用しません。
 262 .RE
 263 .PP
 264 \fB\-\-show\-depends\fP
 265 .RS 4
 266 あるモジュール (または、エイリアス) の依存関係を、そのモジュール自体も含めて、
 267 一覧表示します。モジュールファイル名の集合 (空集合のこともあります) が、1 行に
 268 1 ファイルずつ、各行の先頭に "insmod" を付けて、出力されます。
 269 このオプションの代表的な使い道は、ディストリビューションが initrd/initramfs
 270 イメージを作成するとき、どのモジュールを収録するかを決めるのに使うことです。
 271 \fBInstall\fP コマンドが適用されている場合は、"install"
 272 という文字列を行頭に置くことで、それを示しますが、そうした install
 273 コマンドが実行されるわけではありません。なお、\fBmodinfo\fP(8) を使えば、
 274 モジュールの依存関係をそのモジュール自体から取り出すことができますが、
 275 \fBmodinfo\fP は、設定ファイルの alias や install といったコマンドについては、
 276 何も知らないことに注意してください。
 277 .RE
 278 .PP
 279 \fB\-s\fP, \fB\-\-syslog\fP
 280 .RS 4
 281 このオプションを指定すると、エラーメッセージがある場合に、
 282 それを標準エラーに送るのではなく、syslog の仕組みを通して出力します
 283 (LOG_NOTICE レベルの LOG_DAEMON として扱われます)。
 284 このオプションは、標準エラーが使えない場合にも、自動的に有効になります。
 285 .sp
 286 このオプションは、環境変数 MODPROBE_OPTIONS に入れられて、\fBinstall\fP や
 287 \fBremove\fP コマンド経由で、ほかの \fBmodprobe\fP コマンドにも渡されます。
 288 .RE
 289 .PP
 290 \fB\-V\fP, \fB\-\-version\fP
 291 .RS 4
 292 プログラムのバージョンを表示して終了します。
 293 .RE
 294 .PP
 295 \fB\-v\fP, \fB\-\-verbose\fP
 296 .RS 4
 297 プログラムが何をやっているかについてメッセージを表示します。通常
 298 modprobe がメッセージを出すのは、何かがうまく行かなかったときだけです。
 299 .sp
 300 このオプションは、環境変数 MODPROBE_OPTIONS に入れられて、\fBinstall\fP や
 301 \fBremove\fP コマンド経由で、ほかの \fBmodprobe\fP コマンドにも渡されます。
 302 .RE
 303 .SH 環境変数
 304 .PP
 305 環境変数 MODPROBE_OPTIONS は、\fBmodprobe\fP
 306 コマンドに引数を渡すためにユーザが使用することもできます。
 307 .SH 著作権
 308 .PP
 309 このマニュアルページの最初の版は、"Copyright 2002, Rusty Russell,
 310 IBM Corporation" でした。現在では、Jon Masters ほか数名によって保守されています。
 311 .SH 関連項目
 312 .PP
 313 \fBmodprobe.d\fP(5), \fBinsmod\fP(8), \fBrmmod\fP(8), \fBlsmod\fP(8), \fBmodinfo\fP(8)
 314 \fBdepmod\fP(8)
 315 .SH 著者
 316 .PP
 317 \fBJon Masters\fP <\&jcm@jonmasters\&.org\&>
 318 .RS 4
 319 開発者
 320 .RE
 321 .PP
 322 \fBRobby Workman\fP <\&rworkman@slackware\&.com\&>
 323 .RS 4
 324 開発者
 325 .RE
 326 .PP
 327 \fBLucas De Marchi\fP <\&lucas\&.de\&.marchi@gmail\&.com\&>
 328 .RS 4
 329 開発者
 330 .RE