OSDN Git Service

add release kmod
[linuxjm/jm.git] / manual / kmod / release / man8 / modprobe.8
diff --git a/manual/kmod/release/man8/modprobe.8 b/manual/kmod/release/man8/modprobe.8
new file mode 100644 (file)
index 0000000..cb1ffd1
--- /dev/null
@@ -0,0 +1,250 @@
+'\" t
+.\"     Title: modprobe
+.\"    Author: Jon Masters <jcm@jonmasters.org>
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 01/29/2021
+.\"    Manual: modprobe
+.\"    Source: kmod
+.\"  Language: English
+.\"
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.\"
+.\" translated for 29, 2022-05-31 ribbon <ribbon@users.osdn.me>
+.\"
+.TH MODPROBE 8 2021/01/29 kmod modprobe
+.ie  \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH 名前
+modprobe \- Linux カーネルへのモジュールの追加や削除
+.SH 書式
+.HP \w'\fBmodprobe\fR\ 'u
+\fBmodprobe\fP [\fB\-v\fP] [\fB\-V\fP] [\fB\-C\ \fP\fIconfig\-file\fP] [\fB\-n\fP] [\fB\-i\fP] [\fB\-q\fP]
+[\fB\-b\fP] [\fImodulename\fP] [\fImodule\ parameters\fP...]
+.HP \w'\fBmodprobe\fR\ 'u
+\fBmodprobe\fP [\-r] [\fB\-v\fP] [\fB\-n\fP] [\fB\-i\fP] [\fImodulename\fP...]
+.HP \w'\fBmodprobe\fR\ 'u
+\fBmodprobe\fP [\-c]
+.HP \w'\fBmodprobe\fR\ 'u
+\fBmodprobe\fP [\-\-dump\-modversions] [\fIfilename\fP]
+.SH 説明
+.PP
+\fBmodprobe\fP は Linux カーネルに対するモジュールの登録や削除を適切に行います。 扱いやすさを考慮して、 モジュール名に使われる _ と
+\- は区別されません (アンダースコアの変換が自動的に行われます)。 \fBmodprobe\fP がモジュールや他のファイルを検索するディレクトリは、
+/lib/modules/`uname \-r` というモジュールディレクトリです。 この他に、 任意の設定ファイルは /etc/modprobe\&.d
+ディレクトリから検索します (\fBmodprobe.d\fP(5) 参照)。 また \fBmodprobe\fP は、 カーネルのコマンドラインからは
+<module>\&.<option> という形式で、 またブラックリストからは
+modprobe\&.blacklist=<module> という形式で、 オプション指定することができます。
+.PP
+(本ツールがサポートしていない) Linux カーネル 2.4 系列の場合とは異なり、 \fBmodprobe\fP の本バージョンでは、
+モジュールそのものには何も行いません。 つまりシンボルの解決やパラメーターの解釈は、 カーネル内部で行われます。
+したがってモジュールに関する処理失敗は、 カーネルメッセージに出力されることがあります。 \fBdmesg\fP(8) を参照してください。
+.PP
+\fBmodprobe\fP に対応づいて提供される \fBdepmod\fP ユーティリティーからは modules\&.dep\&.bin
+ファイルが生成されます (\fBdepmod\fP(8) 参照)。 そして \fBmodprobe\fP では、 そのファイルが最新であることを想定しています。
+このファイルでは、 各モジュールが他のモジュールを必要としている場合に、 それが何であるのかを一覧に示しています。 そして \fBmodprobe\fP
+はこれを利用して、 依存モジュールの追加や削除を自動的に行います。
+.PP
+\fImodulename\fP より後ろに指定された引数は、 すべてカーネルに受け渡されます (設定ファイルに指定されたオプションも、
+そこに加えられます)。
+.SH オプション
+.PP
+\fB\-a\fP, \fB\-\-all\fP
+.RS 4
+コマンドラインから指定されたモジュール名をすべて登録します。
+.RE
+.PP
+\fB\-b\fP, \fB\-\-use\-blacklist\fP
+.RS 4
+このオプション指定により、 設定ファイル内に \fBblacklist\fP コマンドがあれば、  それもモジュール名に対して適用するようになります。
+これは通常、 \fBudev\fP(7) が利用します。
+.RE
+.PP
+\fB\-C\fP, \fB\-\-config\fP
+.RS 4
+このオプションは、 デフォルトの設定ディレクトリ (/etc/depmod\&.d/) を上書きします。
+.sp
+このオプションは、 \fBinstall\fP コマンドや \fBremove\fP コマンドを通じて、 環境変数 MODPROBE_OPTIONS 内の別の
+\fBmodprobe\fP コマンドに受け渡されます。
+.RE
+.PP
+\fB\-c\fP, \fB\-\-showconfig\fP
+.RS 4
+設定ディレクトリから有効な設定を取得および表示して、 終了します。
+.RE
+.PP
+\fB\-\-dump\-modversions\fP
+.RS 4
+1 つのモジュールが必要としている、 モジュールのバージョン情報の一覧を表示します。 このオプションは、
+通常はディストリビューションが利用するものであり、 モジュールバージョンを示す dep ファイルを使って、 Linux
+カーネルモジュールをパッケージ化するために用いられます。
+.RE
+.PP
+\fB\-d\fP, \fB\-\-dirname\fP
+.RS 4
+モジュールのルートディレクトリ。 デフォルトは / です。
+.RE
+.PP
+\fB\-\-first\-time\fP
+.RS 4
+通常 \fBmodprobe\fP では、 すでに存在しているモジュールを登録しようとしたり、 存在しないモジュールを削除しようとした場合でも、
+正常終了します (そのときは何も行いません)。 これは単純なスクリプトにおいては最適なものですが、 より複雑なスクリプトの場合には、 実際に
+\fBmodprobe\fP が何を行ったのかを知る必要が出てきます。 このオプションは、 実際に何も行われなかった場合には、 modprobe
+の処理が失敗したものとします。
+.RE
+.PP
+\fB\-\-force\-vermagic\fP
+.RS 4
+どのモジュールであっても、 カーネルバージョンやコンパイラーバージョンといった重要な情報が、 短い文字列となってその名前に含められています。
+モジュールのロードが失敗して、 カーネルが「version magic」が一致しないというエラーを出力した場合には、
+このオプションを使えばエラー回避できます。 本来このチェック処理は、 ユーザー操作を保護するものであるため、 処理内容が分かっていない限り、
+このオプションの利用は危険です。
+.sp
+これは、 登録されているモジュールすべてに適用されます。 つまり対象となるモジュールは、 コマンドラインから指定されたモジュール (あるいはエイリアス)
+と、 それが依存するモジュールを含みます。
+.RE
+.PP
+\fB\-\-force\-modversion\fP
+.RS 4
+CONFIG_MODVERSIONS の設定を行ってモジュールがコンパイルされた場合には、 モジュールが使用する (あるいは提供する)
+インターフェースに関して、 そのバージョンをすべて説明するセクションが生成されます。 モジュールのロードが失敗して、 特定のインターフェースにおいて、
+モジュールのバージョンが不一致であることをカーネルがエラー出力した場合には、 "\-\-force\-modversion" を使えば、
+バージョン情報をすべて取り除いて処理することができます。本来このチェック処理は、 ユーザー操作を保護するものであるため、 処理内容が分かっていない限り、
+このオプションの利用は危険です。
+.sp
+これは、 登録されているモジュールすべてに適用されます。 つまり対象となるモジュールは、 コマンドラインから指定されたモジュール (あるいはエイリアス)
+と、 それが依存するモジュールを含みます。
+.RE
+.PP
+\fB\-f\fP, \fB\-\-force\fP
+.RS 4
+バージョン情報を含んでいることが原因で、 ロードができないモジュールに対して、 そのバージョン情報を取り除いてロードを行います。 これは
+\fB\-\-force\-vermagic\fP と \fB\-\-force\-modversion\fP をともに指定することと同じです。 本来このチェック処理は、
+ユーザー操作を保護するものであるため、 処理内容が分かっていない限り、 このオプションの利用は危険です。
+.sp
+これは、 登録されているモジュールすべてに適用されます。 つまり対象となるモジュールは、 コマンドラインから指定されたモジュール (あるいはエイリアス)
+と、 それが依存するモジュールを含みます。
+.RE
+.PP
+\fB\-i\fP, \fB\-\-ignore\-install\fP, \fB\-\-ignore\-remove\fP
+.RS 4
+このオプションを指定すると、 \fBmodprobe\fP の処理にあたって、 コマンドラインからモジュールが指定されても、
+設定ファイル内にそのモジュールが存在していれば、 \fBinstall\fP コマンドや \fBremove\fP コマンドは無視されます (その依存モジュールは、
+設定ファイル内に設定されたコマンドに従います)。 \fBinstall\fP コマンドと \fBremove\fP コマンドは、
+このオプションが用いられた場合に無視されますが、 \fB\-\-ignore\-install\fP または \fB\-\-ignore\-remove\fP
+の一方だけが指定された (両方の指定がない) 場合であっても、 両方が無視されます。  \fBmodprobe.d\fP(5) を参照してください。
+.RE
+.PP
+\fB\-n\fP, \fB\-\-dry\-run\fP, \fB\-\-show\fP
+.RS 4
+このオプションは、 モジュールの登録や削除 (つまり install コマンドや remove コマンドの実行) は行わず、
+これを除いたすべてのコマンドを実行します。 \fB\-v\fP と合わせて用いれば、 デバッグ目的で利用することができます。 これまでの開発経緯において、
+\fB\-\-dry\-run\fP と \fB\-\-show\fP は、 まったく同じ意味となっているため、 どちらを用いても構いません。
+.RE
+.PP
+\fB\-q\fP, \fB\-\-quiet\fP
+.RS 4
+このフラグを指定した場合、 削除または登録しようとしているモジュールが見つからない場合 (エイリアスでもなく、 \fBinstall\fP/\fBremove\fP
+コマンドでもない場合)、 \fBmodprobe\fP はエラーメッセージを表示しません。 ただしその場合でも、 ゼロではない終了ステータスを返します。
+request_module を利用すれば存在確認が取れるモジュールに対しては、 カーネルはこの機能を使うことで、 モジュール検査を行います。
+.RE
+.PP
+\fB\-R\fP, \fB\-\-resolve\-alias\fP
+.RS 4
+エイリアスに一致するモジュール名をすべて表示します。 これは、 モジュールエイリアスに問題がある際のデバッグに利用できます。
+.RE
+.PP
+\fB\-r\fP, \fB\-\-remove\fP
+.RS 4
+この \fBmodprobe\fP オプションは、 モジュールを登録するのではなく、 削除を行います。
+対象モジュールが依存しているモジュールも未使用であった場合、 \fBmodprobe\fP はそのモジュールも削除します。 モジュール登録の場合とは違って、
+コマンドラインからは複数のモジュールを指定することができます (モジュールを削除するので、 モジュールにパラメーターを受け渡しても意味がありません)。
+.sp
+通常、 モジュールを削除することはありません。 ただしバグを含んだモジュールであれば必要になることがあります。
+利用しているディストリビューションのカーネルが、 モジュール削除機能のサポートを含めずにビルドされている場合があります。
+.RE
+.PP
+\fB\-S\fP, \fB\-\-set\-version\fP
+.RS 4
+\fBuname\fP(2) を用いずに、 カーネルバージョンを設定します (これによって、 モジュールを検索するディレクトリを決定します)。
+.RE
+.PP
+\fB\-\-show\-depends\fP
+.RS 4
+対象のモジュールそのものも含めて、 依存するモジュール (またはエイリアス) を一覧表示します。 これによって (空リストの場合も含めて)
+モジュールファイル名のリストを、 1 つにつき 1 行ずつ表示して、 各行の先頭に "insmod" を出力します。 通常これは、
+initrd/initramfs イメージを生成する際に含めるモジュールの決定のために、 ディストリビューションが利用します。 \fBInstall\fP
+コマンドが適用されると、 先頭に "install" が出力されます。 これは install コマンドは実行しません。 \fBmodinfo\fP(8)
+を利用すれば、 モジュール自体から依存モジュールの情報を取得することができますが、 エイリアスや install コマンドについては、
+何も得ることはできません。
+.RE
+.PP
+\fB\-s\fP, \fB\-\-syslog\fP
+.RS 4
+このオプションを指定すると、 あらゆるエラーメッセージは、 標準エラー出力に向けてではなく、 syslog 機能に向けて (ログレベル
+LOG_NOTICE の LOG_DAEMON として) 出力されます。 この処理はまた、 stderr が利用できない場合には、
+自動的に有効になります。
+.sp
+このオプションは、 \fBinstall\fP コマンドや \fBremove\fP コマンドを通じて、 環境変数 MODPROBE_OPTIONS 内の別の
+\fBmodprobe\fP コマンドに受け渡されます。
+.RE
+.PP
+\fB\-V\fP, \fB\-\-version\fP
+.RS 4
+プログラムバージョンを表示して終了します。
+.RE
+.PP
+\fB\-v\fP, \fB\-\-verbose\fP
+.RS 4
+プログラムの処理内容に関するメッセージを出力します。 普通 \fBmodprobe\fP は、 何かが誤っている場合にのみメッセージを出力します。
+.sp
+このオプションは、 \fBinstall\fP コマンドや \fBremove\fP コマンドを通じて、 環境変数 MODPROBE_OPTIONS 内の別の
+\fBmodprobe\fP コマンドに受け渡されます。
+.RE
+.SH 環境変数
+.PP
+環境変数 MODPROBE_OPTIONS は、 \fBmodprobe\fP への引数受け渡しにも利用されます。
+.SH 著作権
+.PP
+この man ページの元々の著作権表記は Copyright 2002, Rusty Russell, IBM Corporation です。 現在は
+Jon Masters その他により保守されています。
+.SH 関連項目
+.PP
+\fBmodprobe.d\fP(5), \fBinsmod\fP(8), \fBrmmod\fP(8), \fBlsmod\fP(8), \fBmodinfo\fP(8)
+\fBdepmod\fP(8)
+.SH 著者
+.PP
+\fBJon Masters\fP <\&jcm@jonmasters\&.org\&>
+.RS 4
+開発者
+.RE
+.PP
+\fBRobby Workman\fP <\&rworkman@slackware\&.com\&>
+.RS 4
+開発者
+.RE
+.PP
+\fBLucas De Marchi\fP <\&lucas\&.de\&.marchi@gmail\&.com\&>
+.RS 4
+開発者
+.RE