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 .\" translated for 29, 2022-05-31 ribbon <ribbon@users.osdn.me>
  17 .\"
  18 .TH MODPROBE 8 2021/01/29 kmod modprobe
  19 .ie  \n(.g .ds Aq \(aq
  20 .el       .ds Aq '
  21 .\" -----------------------------------------------------------------
  22 .\" * Define some portability stuff
  23 .\" -----------------------------------------------------------------
  24 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  25 .\" http://bugs.debian.org/507673
  26 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  27 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  28 .\" -----------------------------------------------------------------
  29 .\" * set default formatting
  30 .\" -----------------------------------------------------------------
  31 .\" disable hyphenation
  32 .nh
  33 .\" disable justification (adjust text to left margin only)
  34 .ad l
  35 .\" -----------------------------------------------------------------
  36 .\" * MAIN CONTENT STARTS HERE *
  37 .\" -----------------------------------------------------------------
  38 .SH 名前
  39 modprobe \- Linux カーネルへのモジュールの追加や削除
  40 .SH 書式
  41 .HP \w'\fBmodprobe\fR\ 'u
  42 \fBmodprobe\fP [\fB\-v\fP] [\fB\-V\fP] [\fB\-C\ \fP\fIconfig\-file\fP] [\fB\-n\fP] [\fB\-i\fP] [\fB\-q\fP]
  43 [\fB\-b\fP] [\fImodulename\fP] [\fImodule\ parameters\fP...]
  44 .HP \w'\fBmodprobe\fR\ 'u
  45 \fBmodprobe\fP [\-r] [\fB\-v\fP] [\fB\-n\fP] [\fB\-i\fP] [\fImodulename\fP...]
  46 .HP \w'\fBmodprobe\fR\ 'u
  47 \fBmodprobe\fP [\-c]
  48 .HP \w'\fBmodprobe\fR\ 'u
  49 \fBmodprobe\fP [\-\-dump\-modversions] [\fIfilename\fP]
  50 .SH 説明
  51 .PP
  52 \fBmodprobe\fP は Linux カーネルに対するモジュールの登録や削除を適切に行います。 扱いやすさを考慮して、 モジュール名に使われる _ と
  53 \- は区別されません (アンダースコアの変換が自動的に行われます)。 \fBmodprobe\fP がモジュールや他のファイルを検索するディレクトリは、
  54 /lib/modules/`uname \-r` というモジュールディレクトリです。 この他に、 任意の設定ファイルは /etc/modprobe\&.d
  55 ディレクトリから検索します (\fBmodprobe.d\fP(5) 参照)。 また \fBmodprobe\fP は、 カーネルのコマンドラインからは
  56 <module>\&.<option> という形式で、 またブラックリストからは
  57 modprobe\&.blacklist=<module> という形式で、 オプション指定することができます。
  58 .PP
  59 (本ツールがサポートしていない) Linux カーネル 2.4 系列の場合とは異なり、 \fBmodprobe\fP の本バージョンでは、
  60 モジュールそのものには何も行いません。 つまりシンボルの解決やパラメーターの解釈は、 カーネル内部で行われます。
  61 したがってモジュールに関する処理失敗は、 カーネルメッセージに出力されることがあります。 \fBdmesg\fP(8) を参照してください。
  62 .PP
  63 \fBmodprobe\fP に対応づいて提供される \fBdepmod\fP ユーティリティーからは modules\&.dep\&.bin
  64 ファイルが生成されます (\fBdepmod\fP(8) 参照)。 そして \fBmodprobe\fP では、 そのファイルが最新であることを想定しています。
  65 このファイルでは、 各モジュールが他のモジュールを必要としている場合に、 それが何であるのかを一覧に示しています。 そして \fBmodprobe\fP
  66 はこれを利用して、 依存モジュールの追加や削除を自動的に行います。
  67 .PP
  68 \fImodulename\fP より後ろに指定された引数は、 すべてカーネルに受け渡されます (設定ファイルに指定されたオプションも、
  69 そこに加えられます)。
  70 .SH オプション
  71 .PP
  72 \fB\-a\fP, \fB\-\-all\fP
  73 .RS 4
  74 コマンドラインから指定されたモジュール名をすべて登録します。
  75 .RE
  76 .PP
  77 \fB\-b\fP, \fB\-\-use\-blacklist\fP
  78 .RS 4
  79 このオプション指定により、 設定ファイル内に \fBblacklist\fP コマンドがあれば、  それもモジュール名に対して適用するようになります。
  80 これは通常、 \fBudev\fP(7) が利用します。
  81 .RE
  82 .PP
  83 \fB\-C\fP, \fB\-\-config\fP
  84 .RS 4
  85 このオプションは、 デフォルトの設定ディレクトリ (/etc/depmod\&.d/) を上書きします。
  86 .sp
  87 このオプションは、 \fBinstall\fP コマンドや \fBremove\fP コマンドを通じて、 環境変数 MODPROBE_OPTIONS 内の別の
  88 \fBmodprobe\fP コマンドに受け渡されます。
  89 .RE
  90 .PP
  91 \fB\-c\fP, \fB\-\-showconfig\fP
  92 .RS 4
  93 設定ディレクトリから有効な設定を取得および表示して、 終了します。
  94 .RE
  95 .PP
  96 \fB\-\-dump\-modversions\fP
  97 .RS 4
  98 1 つのモジュールが必要としている、 モジュールのバージョン情報の一覧を表示します。 このオプションは、
  99 通常はディストリビューションが利用するものであり、 モジュールバージョンを示す dep ファイルを使って、 Linux
 100 カーネルモジュールをパッケージ化するために用いられます。
 101 .RE
 102 .PP
 103 \fB\-d\fP, \fB\-\-dirname\fP
 104 .RS 4
 105 モジュールのルートディレクトリ。 デフォルトは / です。
 106 .RE
 107 .PP
 108 \fB\-\-first\-time\fP
 109 .RS 4
 110 通常 \fBmodprobe\fP では、 すでに存在しているモジュールを登録しようとしたり、 存在しないモジュールを削除しようとした場合でも、
 111 正常終了します (そのときは何も行いません)。 これは単純なスクリプトにおいては最適なものですが、 より複雑なスクリプトの場合には、 実際に
 112 \fBmodprobe\fP が何を行ったのかを知る必要が出てきます。 このオプションは、 実際に何も行われなかった場合には、 modprobe
 113 の処理が失敗したものとします。
 114 .RE
 115 .PP
 116 \fB\-\-force\-vermagic\fP
 117 .RS 4
 118 どのモジュールであっても、 カーネルバージョンやコンパイラーバージョンといった重要な情報が、 短い文字列となってその名前に含められています。
 119 モジュールのロードが失敗して、 カーネルが「version magic」が一致しないというエラーを出力した場合には、
 120 このオプションを使えばエラー回避できます。 本来このチェック処理は、 ユーザー操作を保護するものであるため、 処理内容が分かっていない限り、
 121 このオプションの利用は危険です。
 122 .sp
 123 これは、 登録されているモジュールすべてに適用されます。 つまり対象となるモジュールは、 コマンドラインから指定されたモジュール (あるいはエイリアス)
 124 と、 それが依存するモジュールを含みます。
 125 .RE
 126 .PP
 127 \fB\-\-force\-modversion\fP
 128 .RS 4
 129 CONFIG_MODVERSIONS の設定を行ってモジュールがコンパイルされた場合には、 モジュールが使用する (あるいは提供する)
 130 インターフェースに関して、 そのバージョンをすべて説明するセクションが生成されます。 モジュールのロードが失敗して、 特定のインターフェースにおいて、
 131 モジュールのバージョンが不一致であることをカーネルがエラー出力した場合には、 "\-\-force\-modversion" を使えば、
 132 バージョン情報をすべて取り除いて処理することができます。本来このチェック処理は、 ユーザー操作を保護するものであるため、 処理内容が分かっていない限り、
 133 このオプションの利用は危険です。
 134 .sp
 135 これは、 登録されているモジュールすべてに適用されます。 つまり対象となるモジュールは、 コマンドラインから指定されたモジュール (あるいはエイリアス)
 136 と、 それが依存するモジュールを含みます。
 137 .RE
 138 .PP
 139 \fB\-f\fP, \fB\-\-force\fP
 140 .RS 4
 141 バージョン情報を含んでいることが原因で、 ロードができないモジュールに対して、 そのバージョン情報を取り除いてロードを行います。 これは
 142 \fB\-\-force\-vermagic\fP と \fB\-\-force\-modversion\fP をともに指定することと同じです。 本来このチェック処理は、
 143 ユーザー操作を保護するものであるため、 処理内容が分かっていない限り、 このオプションの利用は危険です。
 144 .sp
 145 これは、 登録されているモジュールすべてに適用されます。 つまり対象となるモジュールは、 コマンドラインから指定されたモジュール (あるいはエイリアス)
 146 と、 それが依存するモジュールを含みます。
 147 .RE
 148 .PP
 149 \fB\-i\fP, \fB\-\-ignore\-install\fP, \fB\-\-ignore\-remove\fP
 150 .RS 4
 151 このオプションを指定すると、 \fBmodprobe\fP の処理にあたって、 コマンドラインからモジュールが指定されても、
 152 設定ファイル内にそのモジュールが存在していれば、 \fBinstall\fP コマンドや \fBremove\fP コマンドは無視されます (その依存モジュールは、
 153 設定ファイル内に設定されたコマンドに従います)。 \fBinstall\fP コマンドと \fBremove\fP コマンドは、
 154 このオプションが用いられた場合に無視されますが、 \fB\-\-ignore\-install\fP または \fB\-\-ignore\-remove\fP
 155 の一方だけが指定された (両方の指定がない) 場合であっても、 両方が無視されます。  \fBmodprobe.d\fP(5) を参照してください。
 156 .RE
 157 .PP
 158 \fB\-n\fP, \fB\-\-dry\-run\fP, \fB\-\-show\fP
 159 .RS 4
 160 このオプションは、 モジュールの登録や削除 (つまり install コマンドや remove コマンドの実行) は行わず、
 161 これを除いたすべてのコマンドを実行します。 \fB\-v\fP と合わせて用いれば、 デバッグ目的で利用することができます。 これまでの開発経緯において、
 162 \fB\-\-dry\-run\fP と \fB\-\-show\fP は、 まったく同じ意味となっているため、 どちらを用いても構いません。
 163 .RE
 164 .PP
 165 \fB\-q\fP, \fB\-\-quiet\fP
 166 .RS 4
 167 このフラグを指定した場合、 削除または登録しようとしているモジュールが見つからない場合 (エイリアスでもなく、 \fBinstall\fP/\fBremove\fP
 168 コマンドでもない場合)、 \fBmodprobe\fP はエラーメッセージを表示しません。 ただしその場合でも、 ゼロではない終了ステータスを返します。
 169 request_module を利用すれば存在確認が取れるモジュールに対しては、 カーネルはこの機能を使うことで、 モジュール検査を行います。
 170 .RE
 171 .PP
 172 \fB\-R\fP, \fB\-\-resolve\-alias\fP
 173 .RS 4
 174 エイリアスに一致するモジュール名をすべて表示します。 これは、 モジュールエイリアスに問題がある際のデバッグに利用できます。
 175 .RE
 176 .PP
 177 \fB\-r\fP, \fB\-\-remove\fP
 178 .RS 4
 179 この \fBmodprobe\fP オプションは、 モジュールを登録するのではなく、 削除を行います。
 180 対象モジュールが依存しているモジュールも未使用であった場合、 \fBmodprobe\fP はそのモジュールも削除します。 モジュール登録の場合とは違って、
 181 コマンドラインからは複数のモジュールを指定することができます (モジュールを削除するので、 モジュールにパラメーターを受け渡しても意味がありません)。
 182 .sp
 183 通常、 モジュールを削除することはありません。 ただしバグを含んだモジュールであれば必要になることがあります。
 184 利用しているディストリビューションのカーネルが、 モジュール削除機能のサポートを含めずにビルドされている場合があります。
 185 .RE
 186 .PP
 187 \fB\-S\fP, \fB\-\-set\-version\fP
 188 .RS 4
 189 \fBuname\fP(2) を用いずに、 カーネルバージョンを設定します (これによって、 モジュールを検索するディレクトリを決定します)。
 190 .RE
 191 .PP
 192 \fB\-\-show\-depends\fP
 193 .RS 4
 194 対象のモジュールそのものも含めて、 依存するモジュール (またはエイリアス) を一覧表示します。 これによって (空リストの場合も含めて)
 195 モジュールファイル名のリストを、 1 つにつき 1 行ずつ表示して、 各行の先頭に "insmod" を出力します。 通常これは、
 196 initrd/initramfs イメージを生成する際に含めるモジュールの決定のために、 ディストリビューションが利用します。 \fBInstall\fP
 197 コマンドが適用されると、 先頭に "install" が出力されます。 これは install コマンドは実行しません。 \fBmodinfo\fP(8)
 198 を利用すれば、 モジュール自体から依存モジュールの情報を取得することができますが、 エイリアスや install コマンドについては、
 199 何も得ることはできません。
 200 .RE
 201 .PP
 202 \fB\-s\fP, \fB\-\-syslog\fP
 203 .RS 4
 204 このオプションを指定すると、 あらゆるエラーメッセージは、 標準エラー出力に向けてではなく、 syslog 機能に向けて (ログレベル
 205 LOG_NOTICE の LOG_DAEMON として) 出力されます。 この処理はまた、 stderr が利用できない場合には、
 206 自動的に有効になります。
 207 .sp
 208 このオプションは、 \fBinstall\fP コマンドや \fBremove\fP コマンドを通じて、 環境変数 MODPROBE_OPTIONS 内の別の
 209 \fBmodprobe\fP コマンドに受け渡されます。
 210 .RE
 211 .PP
 212 \fB\-V\fP, \fB\-\-version\fP
 213 .RS 4
 214 プログラムバージョンを表示して終了します。
 215 .RE
 216 .PP
 217 \fB\-v\fP, \fB\-\-verbose\fP
 218 .RS 4
 219 プログラムの処理内容に関するメッセージを出力します。 普通 \fBmodprobe\fP は、 何かが誤っている場合にのみメッセージを出力します。
 220 .sp
 221 このオプションは、 \fBinstall\fP コマンドや \fBremove\fP コマンドを通じて、 環境変数 MODPROBE_OPTIONS 内の別の
 222 \fBmodprobe\fP コマンドに受け渡されます。
 223 .RE
 224 .SH 環境変数
 225 .PP
 226 環境変数 MODPROBE_OPTIONS は、 \fBmodprobe\fP への引数受け渡しにも利用されます。
 227 .SH 著作権
 228 .PP
 229 この man ページの元々の著作権表記は Copyright 2002, Rusty Russell, IBM Corporation です。 現在は
 230 Jon Masters その他により保守されています。
 231 .SH 関連項目
 232 .PP
 233 \fBmodprobe.d\fP(5), \fBinsmod\fP(8), \fBrmmod\fP(8), \fBlsmod\fP(8), \fBmodinfo\fP(8)
 234 \fBdepmod\fP(8)
 235 .SH 著者
 236 .PP
 237 \fBJon Masters\fP <\&jcm@jonmasters\&.org\&>
 238 .RS 4
 239 開発者
 240 .RE
 241 .PP
 242 \fBRobby Workman\fP <\&rworkman@slackware\&.com\&>
 243 .RS 4
 244 開発者
 245 .RE
 246 .PP
 247 \fBLucas De Marchi\fP <\&lucas\&.de\&.marchi@gmail\&.com\&>
 248 .RS 4
 249 開発者
 250 .RE