管理解説書

kas help

目的

指定された kas コマンドの構文を表示するか、あるいはすべての kas コマンドの説明を表示します。

構文

kas help [-topic <help string>+]  [-help]
   
kas h [-t <help string>+]  [-h]

構文

kas help は、-topic 引き数で指定されたコマンド操作コードについて、完全なオンライン・ヘルプ項目 (簡単な説明と構文情報) を表示します。 -topic 引き数が省略されると、各 kas コマンドのオンライン・ヘルプ項目の最初の行 (名前と簡単な説明) を表示します。

名前または説明部分に特定のキーワードを含む kas コマンドを表示する場合には、 kas apropos コマンドを使用してください。

オプション

-topic

各コマンドの完全なオンライン・ヘルプ項目が表示されます。操作コードだけを指定する場合には、コマンド名から kas を除いた部分を指定してください。(たとえば、 kas setpassword ではなく、 setpassword と指定します。) この引き数を省略すると、各 kas コマンドの簡単な説明が表示されます。

-help

このコマンドのオンライン・ヘルプを出力します。これ以外の有効なオプションはすべて無視されます。

出力

各 kas コマンドのオンライン・ヘルプ項目は、次のように 2、3 行から構成されます。

• 最初の行には、コマンド名および機能の説明が表示されます。
• 次の行には、コマンドの別名 (ある場合) が表示されます。
• 最後の行は、Usage という文字列で始まり、コマンドのオプションが一定の順序で表示されます。オンライン・ヘルプの項目では、この文書の解説ページと同じ記号 (大括弧など) が使用されています。

例

以下のコマンドは、kas setpassword コマンドのオンライン・ヘルプ項目を表示します。

   % kas help setpassword
   kas setpassword: set a user's password
   aliases: sp
   Usage: kas setpassword -name <name of user>
   [-new_password <new password>] [-kvno <key version number>]
   [-admin_username <admin principal to use for authentication>]
   [-password_for_admin <password>] [-cell <cell name>]
   [-servers <explicit list of authentication servers>+] [-help]
   

必要となる特権

なし。パスワードは不要です。

関連情報

kas

kas apropos