マニュアルページ内の情報の検索

man コマンドを使用して、Oracle Solaris のコマンドに関する情報をマニュアルページから検索することができます。新しい -K (大文字) keywords オプションを使用すると、すべてのマニュアルページのすべてのセクションから、指定されたキーワードを検索できます。-k オプション (小文字) は、すべてのマニュアルページセクションの NAME サブセクションのみに検索範囲を限定します。

マニュアルページから特定のキーワードを検索するためのインデックスファイルの作成

キーワードを指定してマニュアルページ内の情報を検索するには、まず、man コマンドによるクエリーが可能なインデックスファイルを作成します。catman ユーティリティーを使用すると、あらかじめフォーマットされたバージョンのオンラインリファレンスマニュアルを作成できます。オプションを指定せずに catman ユーティリティーを使用すると、/usr/share/man および usr/gnu/share/man ディレクトリにあるマニュアルページのインデックスファイルが生成されます。catman ユーティリティーを使用するには、root ユーザーである必要があります。.

catman ユーティリティーには -w オプションも含まれています。このオプションを使用すると、MANPATH 変数で指定されたディレクトリ内にあるマニュアルページの、または -M オプションの使用時にインデックスファイルを作成できます。catman ユーティリティーの -M オプションを使用すると、代替ディレクトリを指定して、サードパーティーのマニュアルページのインデックスファイルを作成できます。デフォルトでは、オプションを指定せずに catman ユーティリティーを使用すると、/usr/share/man および /usr/gnu/share/man ディレクトリにあるマニュアルページのインデックスファイルが作成されます。

代替ディレクトリを指定するには、次のコマンドを入力します:

# catman -M directory -w

たとえば、/usr/local/share/man ディレクトリにあるマニュアルページのインデックスファイルを作成するには、次のコマンドを入力します:

# catman -M /usr/local/share/man -w

-M directory

指定されたディレクトリ (デフォルトでは /usr/share/man) にあるマニュアルページを更新します。コンマはマニュアルページのセクション番号を示すために使用されているので、-Mオプションが指定されている場合、ディレクトリの引数にはコンマ (「,」) が含まれないようにしてください。

-w

MANPATH 変数によって、または -M オプションを使用して指定されたディレクトリにインデックスファイルを作成します。MANPATH 変数または -M オプションを指定しない場合、/usr/share/man/ ディレクトリと /usr/gnu/share/man ディレクトリの両方を対象にインデックスファイルが作成されます。

指定できるすべてのコマンド行オプションを含む catman ユーティリティーの詳細は、catman(1M) のマニュアルページを参照してください。

キーワードを指定してマニュアルページ内の情報を検索する

キーワードを指定してマニュアルページ内の情報を検索するには、catman ユーティリティーを使用してインデックスファイルを作成します。手順については、「マニュアルページから特定のキーワードを検索するためのインデックスファイルの作成」を参照してください。

キーワードを指定して、すべてのマニュアルページセクション内の情報のフルテキスト検索を実行するには、次のように、新しい -K keywords オプションを指定して man コマンドを入力します:

$ man -K keywords

-K

すべてのマニュアルページセクションから、keywords で指定されたキーワードのフルテキスト検索を実行します。

keywords

指定されるユーザー定義の文字列です。1 回の検索で複数のキーワードを指定するには、二重引用符を使用します。例:

$ man -K "create zfs pool"

すべてのマニュアルページの NAME サブセクションのみから情報を検索するには、次のように、-k keywords オプションを指定して man コマンドを入力します:

$ man -k keywords

すべてのマニュアルページの特定のサブセクションから情報を検索するには、次のように、man -K keywords コマンドの構文に SECTNAME を含めます:

$ man -K SECTNAME:keywords

SECTNAME には、すべてのマニュアルページセクション内のサブセクションとして、次のいずれかを指定できます:

• ATTRIBUTES

• DESCRIPTION

• ENVIRONMENT VARIABLES

• EXAMPLES

• EXIT STATUS

• FILES

• LIST OF COMMANDS

• NAME

• NOTES

• NULL

• OPTIONS

• OPERANDS

• OUTPUT

• SECURITY

• SEE ALSO

• SYNOPSIS

• USAGE

特定のマニュアルページセクションを検索するには、man コマンドと -k または -K オプションとともに、-s オプションを使用します。

$ man -s manpage-section -K "keywords"

たとえば、1M マニュアルページセクションからキーワード「cpu usage」を検索するには、次のコマンドを入力します:

$ man -s 1m -K "cpu usage"

次に示す、man コマンドに関するその他の重要情報にも注意してください:

• man コマンドの -k または -K オプションを指定してマニュアルページを検索するために使用するコマンド構文では、大文字と小文字が区別されません。

• man コマンドは、検索を実行する前にキーワードを正規化しません。つまり、指定されたキーワードのクエリーによって、その語の一部を含むすべての語の検索結果も生成されます。たとえば、「searching」という語をクエリーする場合、「search」、「searches」、および「searched」の各語も検索結果に含まれます。

例 1-1 キーワードを指定してすべてのマニュアルページの NAME サブセクションからコマンドを検索する

次の例では、man -k コマンドを使用して、すべてのマニュアルページの NAME セクションのみを対象に init コマンドのインスタンスを検索します:

$ man -k init
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. init(1m)     "NAME"  /usr/share/man/man1m/init.1m
init, telinit - process control initialization


2. inittab(4)   "NAME"  /usr/share/man/man4/inittab.4
inittab - script for init


3. init.d(4)    "NAME"  /usr/share/man/man4/init.d.4
init.d - initialization and termination scripts for changing init states

この例では、man -k コマンドの出力は、すべてのマニュアルページセクションの NAME サブセクションのみから init コマンドを検索した結果を表示します。検索結果には、名前に init が含まれるすべてのマニュアルページも含まれることに注意してください。.

例 1-2 キーワードを指定してすべてのマニュアルページセクションからコマンドを検索する

次の例では、man -K keywords コマンドを使用して、マニュアルページのすべてのセクションから dumpadm コマンドのインスタンスを検索します。

$ man -K dumpadm
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. dumpadm(1m)  NAME    /usr/share/man/man1m/dumpadm.1m
dumpadm - configure operating system crash dump


2. savecore(1m) DESCRIPTION     /usr/share/man/man1m/savecore.1m
The savecore utility saves a crash dump of the kernel (assuming that one
was made) and writes a reboot message in the shutdown log. It is invoked
by the dumpadm service each time the system boots.


3. svccfg(1m)   EXAMPLES        /usr/sh

この例では、検索によって、マニュアルページ内の dumpadm コマンドの 3 つのインスタンスが返されます:

• 最初のインスタンスは、dumpadm(1M) のマニュアルページの NAME サブセクションに見つかったものです。

• 2 番目のインスタンスは、savecore(1M) のマニュアルページの DESCRIPTION サブセクションに見つかったものです。

• 3 番目のインスタンスは、svccfg(1M) のマニュアルページの EXAMPLES サブセクションに見つかったものです。

ユーザーはこのクエリーの結果によって、dumpadm コマンドに関する追加の情報が、すべてのマニュアルページ内のどの場所にあるかを知ることができます。

例 1-3 キーワードを指定してマニュアルページの特定のサブセクションからコマンドを検索する

次の例では、man -K コマンドと SECTNAME:keywords 引数を使用して、すべてのマニュアルページセクションの DESCRIPTION サブセクションから bootadm コマンドのインスタンスを検索します。

$ man -K description:bootadm
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. bootadm(1m)  DESCRIPTION     /usr/share/man/man1m/bootadm.1m
The bootadm command manages the boot archive and, with x86 boot environments,
the GRUB (GRand Unified Bootloader) menu. The update-archive option
provides a way for user to update the boot archive as a preventative
measure or as part of a


2. boot(1m)     DESCRIPTION     /usr/share/man/man1m/boot.1m
# bootadm update-archive

この例では、検索によって、次のマニュアルページセクションの DESCRIPTION サブセクションにある bootadm コマンドの 2 つのインスタンスが返されます:

• 最初のインスタンスは、bootadm(1M) のマニュアルページに見つかったものです。

• 2 番目のインスタンスは、boot(1M) のマニュアルページに見つかったものです。

man コマンドの使用方法の詳細は、man(1) のマニュアルページを参照してください。