3.3. IPA のヘルプとは

コマンド構文、使用例、および利用可能なサブコマンドについては、組み込みの Identity Management (IdM) ドキュメントを参照してください。IPA コマンドラインインターフェイス (CLI) は、読み込んだ IdM プラグインモジュールから、利用可能なヘルプトピックを生成します。

ipa help ユーティリティーは、クエリーに対して特定の構造に従います。

$ ipa help [TOPIC | COMMAND | topics | commands]

[] - 括弧は、すべてのパラメーターが任意であることを示しており、ipa help のみを入力すれば、コマンドが実行できます。
| - パイプ文字は または の意味になります。したがって、基本的な ipa help コマンドを使用して、TOPIC、COMMAND、topics または commands を指定できます。
- topics — コマンド ipa help topics を実行して、IPA ヘルプでカバーされている user、cert、server などのトピックのリストを表示できます。
- TOPIC — 大文字の TOPIC は変数になります。したがって、特定のトピック (ipa help user など) を指定できます。
- commands — コマンド ipa help commands を入力して、user-add、ca-enable、server-show などの IPA ヘルプでカバーされているコマンドのリストを表示できます。
- COMMAND — 大文字の COMMAND は変数になります。したがって、ipa help user-add などの特定のコマンドを指定できます。

オプションを指定せずに ipa help コマンドを入力すると、システムは基本的なヘルプの使用方法と最も一般的なコマンド例に関する情報を表示します。