管理解説書

bos help

目的

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

構文

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

構文

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

指定したキーワードを名前または概説に含無 bos コマンドをすべて表示する場合には、bos apropos コマンドを使用してください。

オプション

-topic

各コマンドの完全なオンライン・ヘルプ項目が表示されます。命令コードだけを指定して、コマンド名の bos 部分は省略してください。(たとえば、bos status ではなく、status と入力してください。) この引き数を省略すると、すべての bos コマンドについて概説が表示されます。

-help

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

出力

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

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

例

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

   % bos help status
   bos status: show server instance status
   Usage: bos status -server <machine name> [-instance <server
   process name>+] [-long] [-cell <cell name>] [-noauth]
   [-localauth] [-help]
   

必要となる特権

なし。

関連情報

bos

bos apropos