管理解説書

vos help

目的

指定された vos コマンドの構文、またはすべての vos コマンドの簡単な説明を表示します。

構文

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

構文

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

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

オプション

-topic

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

-help

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

出力

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

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

例

次のコマンドは、 vos create コマンドのオンライン・ヘルプ項目を表示します。

   % vos help create
   vos create: create a new volume
   Usage: vos create -server <machine name> -partition <partition name>
   -name <volume name> [-cell <cell name>] [-noauth] [-localauth]
   [-verbose] [-help]
   

必要となる特権

なし。

関連情報

vos

vos apropos