manual/kmod/draft/man5/modprobe.d.5

   1 '\" t
   2 .\"     Title: modprobe.d
   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.d
   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\&.D 5 2021/01/29 kmod modprobe.d
  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.d \- modprobe 向けの設定ディレクトリ
  40 .SH 書式
  41 .PP
  42 /lib/modprobe\&.d/*\&.conf
  43 .PP
  44 /usr/local/lib/modprobe\&.d/*\&.conf
  45 .PP
  46 /run/modprobe\&.d/*\&.conf
  47 .PP
  48 /etc/modprobe\&.d/*\&.conf
  49 .SH 説明
  50 .PP
  51 \fBmodprobe\fP コマンドでは、 複数のモジュールに対する追加や削除ができます。 そもそもモジュールには依存関係があるため、
  52 そのようなモジュールに対しては、 どのようなオプションを適用するのかを示す必要があります。 /etc/modprobe\&.d
  53 ディレクトリに置くファイルは、 すべて \&.conf という拡張子を持つものであり、 必要となるオプションを指定します。 同時にこれらのファイルでは、
  54 便利なエイリアス、 つまりモジュールに対する別名を生成するものとしても利用されます。 また、 特別な要件 (たとえば複数モジュールの挿入を要するなど)
  55 がある場合に、 通常の \fBmodprobe\fP の動作を上書きすることができます。
  56 .PP
  57 なお、 モジュール名や (別モジュール名である) エイリアス名においては、 \- や _ を名称に含めることができます。 そして両者は、
  58 あらゆるモジュールコマンドを通じて区別なく用いられ、 アンダースコアへの変換は自動的に行われます。
  59 .PP
  60 modprobe\&.d 配下にあるファイルのフォーマットは単純です。 1 行に 1 つのコマンドを記述します。空行や \*(Aq#\*(Aq
  61 で始まる行は無視されます (コメント行として利用できます)。 行末に \*(Aq\e\*(Aq を記述すれば、 次の行への継続を表します。
  62 これを使えば、ファイルが多少すっきりします。
  63 .SH コマンド
  64 .PP
  65 alias \fIwildcard\fP \fImodulename\fP
  66 .RS 4
  67 これは、 モジュールに対する別名指定を可能にします。 たとえば、 "alias my\-mod really_long_modulename" とすると、
  68 "modprobe really_long_modulename" でなく "modprobe my\-mod" とすることができます。
  69 またシェルのようなワイルドカードの利用もできるため、 "alias my\-mod* really_long_modulename" とすると、
  70 "modprobe my\-mod\-something" でも同じことになります。 他のエイリアスに対するエイリアスを作ることはできません
  71 (これを行うとおかしくなります)。 エイリアスはオプションを含めることができるため、 他のオプションに加えて利用することができます。
  72 .sp
  73 なお、 モジュールにはそれ独自のエイリアスを含めることができます。 これは \fBmodinfo\fP を使って確認することができます。
  74 こういったエイリアスは、 最後の手段として用いられます (実際のモジュール, \fBinstall\fP, \fBremove\fP, \fBalias\fP
  75 の各コマンドが設定内にない場合など)。
  76 .RE
  77 .PP
  78 blacklist \fImodulename\fP
  79 .RS 4
  80 モジュールにはそれ独自のエイリアスを含めることができます。 通常そういったエイリアスは、 "pci:123\&.\&.\&." などのように、
  81 サポートしているデバイスを表すものです。 こういった「内部の」エイリアスは、 通常のキーワード "alias" を使って上書きすることができます。
  82 というのも、 2 つ以上のモジュールが同一デバイスをサポートしている場合があります。 あるいはモジュールがサポートしているといいつつ、
  83 対象デバイスが存在しないような不適切な状況があります。 キーワード \fBblacklist\fP は、 特定のモジュールにおける内部エイリアスを、
  84 無効なものとして指示するためにあります。
  85 .RE
  86 .PP
  87 install \fImodulename\fP \fIcommand\&.\&.\&.\fP
  88 .RS 4
  89 このコマンドは \fBmodprobe\fP に対して、 カーネルに対して普通にモジュールを登録するのではなく、 指定したコマンドの実行を指示するものです。
  90 コマンドにはシェルコマンドが指定できます。 これによって、 どのような複雑な処理であっても、 必要であれば実現することができます。 たとえば、
  91 "fred" というモジュールが、 すでにインストール済みの "barney" というモジュールを使って適切に動作するとします
  92 (ただし依存関係にはないことから、 \fBmodprobe\fP は自動的にはロードしないものとします)。 その場合には、 "install fred
  93 /sbin/modprobe barney; /sbin/modprobe \-\-ignore\-install fred" を実行します。
  94 こうすれば適切に実現されます。 なお、 ここにある \fB\-\-ignore\-install\fP は、 2 つめの \fBmodprobe\fP コマンドが、 同じ
  95 \fBinstall\fP コマンドを再度実行することがないようにしています。 以下の \fBremove\fP も参照してください。
  96 .sp
  97 モジュール追加によって依存関係を維持する対処として、 このコマンドが、 今後も長期的にその解決策となる保証はありません。 このコマンドは、
  98 将来のリリースのある時点において、 最終的には削除か非推奨として、 警告する形に置き換わる予定です。 このコマンドを利用すると、 mkinitrd
  99 などのような配布ユーティリティーが行っているモジュール依存関係の自動検出の処理が複雑になります (なぜなら、 \fBinstall\fP
 100 コマンドが行っている処理内容を、 ある程度解釈しておかなければならないためです)。 理想的には、 本コマンドを用いずに、
 101 モジュールが依存関係をすべて提供するようになるはずであり、 Linux カーネル内部において、 ソフトな依存関係を実装する作業が、 現在進行中です。
 102 .sp
 103 コマンド内に文字列 "$CMDLINE_OPTS" を用いると、 これは modprobe コマンドラインに指定されたオプションに置き換えられます。
 104 これが役に立つのは、 "modprobe fred opt=1" とした場合に、 モジュールに対しては、 "opt=1"
 105 という引数が受け渡されることが期待されるためです。 たとえ設定ファイル内に install コマンドがあったとしても実現できます。
 106 したがって先に示したコマンド例は "install fred /sbin/modprobe barney; /sbin/modprobe
 107 \-\-ignore\-install fred $CMDLINE_OPTS" となります。
 108 .RE
 109 .PP
 110 options \fImodulename\fP \fIoption\&.\&.\&.\fP
 111 .RS 4
 112 このコマンドは、 モジュール \fImodulename\fP (エイリアスを含む) がカーネルに登録される際に、 その都度追加するオプションを指定します。
 113 その場合は、 (\fBmodprobe \fP \fImodulename\fP を使って) 直接指定する場合と、
 114 そのモジュールに依存したモジュールが登録される場合があります。
 115 .sp
 116 オプションは、 すべてまとめて追加されます。 つまりオプションは、 モジュール自体への指定、 エイリアスへの指定、 コマンドラインからの指定すべてです。
 117 .RE
 118 .PP
 119 remove \fImodulename\fP \fIcommand\&.\&.\&.\fP
 120 .RS 4
 121 これは上で示した \fBinstall\fP コマンドに似ていますが、 違うところは、 "modprobe \-r" が実行されている際に呼び出される点です。
 122 .RE
 123 .PP
 124 softdep \fImodulename\fP pre: \fImodules\&.\&.\&.\fP post: \fImodules\&.\&.\&.\fP
 125 .RS 4
 126 \fBsoftdep\fP コマンドは、 ソフトな、 つまり任意のモジュール依存関係の指定を行います。 \fImodulename\fP は、
 127 そのような任意のモジュールがインストールされていなくても、 用いることができます。 ただし普通は、 何かの機能が失われることがあります。 たとえば、
 128 ストレージ HBA に対するドライバーは、 管理機能を利用するために、 別のモジュールがロードされている必要があります。
 129 .sp
 130 pre\-deps モジュールと post\-deps モジュールは、 \fImodulename\fP 引数として与えられたメインのモジュールの前後において、
 131 modprobe がインストール (または削除) しようとする別のモジュール名、 あるいはエイリアス名のリストです。
 132 .sp
 133 例: 設定として "softdep c pre: a b post: d e" が与えられたとします。 "modprobe c"
 134 を実行するということは、 softdep がなかった場合には、 "modprobe a b c d e" を実行することと同じになります。
 135 \-\-use\-blacklist などのフラグは、 指定されたモジュールすべてに適用されます。 一方で、 モジュールパラメーターは、 モジュール c
 136 にのみ適用されます。
 137 .sp
 138 注意: 同一の \fImodulename\fP を引数とする \fBinstall\fP コマンドまたは \fBremove\fP コマンドがある場合、
 139 \fBsoftdep\fP が優先されます。
 140 .RE
 141 .SH 互換性
 142 .PP
 143 kmod の将来版においては、 上で説明した \fBinstall\fP の利用を避けるような警告を含めるつもりでいます。 これは、
 144 カーネル内でのソフトな依存関係のサポートが完成した際に行います。 そういった依存関係は直接モジュール内で行われるようになるため、 そのサポートは、
 145 本ユーティリティーの既存の softdep サポート機能を補助するものとなります。
 146 .SH 著作権
 147 .PP
 148 この man ページの元々の著作権表記は Copyright 2004, Rusty Russell, IBM Corporation です。 現在は
 149 Jon Masters その他により保守されています。
 150 .SH 関連項目
 151 .PP
 152 \fBmodprobe\fP(8), \fBmodules.dep\fP(5)
 153 .SH 著者
 154 .PP
 155 \fBJon Masters\fP <\&jcm@jonmasters\&.org\&>
 156 .RS 4
 157 開発者
 158 .RE
 159 .PP
 160 \fBRobby Workman\fP <\&rworkman@slackware\&.com\&>
 161 .RS 4
 162 開発者
 163 .RE
 164 .PP
 165 \fBLucas De Marchi\fP <\&lucas\&.de\&.marchi@gmail\&.com\&>
 166 .RS 4
 167 開発者
 168 .RE