管理解説書

pts help

目的

特定の pts コマンドの構文を表示したり、すべての pts コマンドの機能説明をリストしたりします。

構文

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

構文

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

名前と説明部分に特定のキーワードが含まれている pts コマンドを、すべてリスト表示する場合には、 pts apropos コマンドを使用してください。

オプション

-topic

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

-help

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

出力

pts コマンドのオンライン・ヘルプ項目は、次のように 2 〜 3 行で構成されています。

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

例

次のコマンドは、pts membership コマンドの、オンライン・ヘルプ項目を表示するものです。

   % pts help membership
   pts membership:  list membership of a user or group
   aliases: groups
   Usage: pts membership -nameorid <user or group name or id>+
   [-cell <cell name>] [-noauth] [-force] [-help]
   

必要となる特権

なし。

関連情報

pts

pts apropos