ドキュメントはどこに?

面白そうなアプリケーションをインストールしたけど、使い方がよく分からない… ということはよくあります。 ここでは LinuxMLD 5,6,7 の標準インストール状態を前提に、ドキュメントの探し方、読み方を説明します。

man page

まずは マニュアル・ページ (man page) を参照しましょう。基本です。そこに help の出し方も書いてあるかもしれません。 マニュアル・ページを見るコマンドは man です。 man コマンドの使い方もマニュアル・ページにあります。 ターミナルから

$ man man

とすると表示されます。

この表示は less を使っているので、 less のコマンドが全て使えます。

「less って何?」という方は早速 man less してください。

スペースキーで次の画面に進みます。リターンキーでは1行ずつ進みます。 'b' を押すと1画面戻ります。先頭に戻るのは 'g' です。 '/' で検索ができます。終わるのは 'q' です。

'h' を押すとヘルプが表示されます。

マニュアル・ページを参照したときページの上に「man(1)」のように表示されますが この数字はマニュアルのセクションを表します。
マニュアルのセクションは Unix の伝統に従って次のようになっています。

  1. ユーザコマンド
  2. システムコール
  3. ライブラリ関数(サブルーチン)
  4. スペシャルファイル
  5. ファイルフォーマット
  6. ゲームプログラム
  7. 習慣やプロトコル、ファイルシステム、その他
  8. 管理コマンドと特権コマンド

通常のアプリケーションのマニュアルはセクション1にあります。

man コマンドは引数で与えられた名前のマニュアルを セクション1から順に探して行き、最初に見つかったページを表示します。 セクションを指定したいとき、例えばコマンドの read ではなく システムコールの read のマニュアルを参照したい場合は

$ man 2 read

のようにセクションの番号を指定します。

日本語環境 (環境変数 LANG が ja_JP.eucJP) では、日本語のマニュアル・ページがあればそれが表示されます。 そういうときに英語の方を表示したい場合は、

$ LANG=en_US man name

のようにします (このようにコマンドの前に環境変数を指定するとそのコマンドを実行する環境だけ 一時的に環境変数を変更できます)。 LANG=de_DE とすれば、ドイツ語のページが (もしあれば) 表示されるでしょう。 英語はデフォルトの環境なので 単に LANG= とすることもできます。

man の不便なところは、「名前」が分からないと参照できないことです。 apropos コマンド (または man -k) を使うと短い説明のデータベース (whatis) から検索してくれます。 例えば、

$ apropos 対数
exp                  (3)  - 指数、対数、ベキ乗関数
expm1                (3)  - 引数の指数マイナス 1 と、引数プラス 1 の対数を与える
lgamma               (3)  - 対数ガンマ関数
log [exp]            (3)  - 指数、対数、ベキ乗関数
log10 [exp]          (3)  - 指数、対数、ベキ乗関数
log1p [expm1]        (3)  - 引数の指数マイナス 1 と、引数プラス 1 の対数を与える
pow [exp]            (3)  - 指数、対数、ベキ乗関数

LinuxMLD 7man は日本語 man page の索引を作ってくれません。 MLD 7 のサポートページ から man のアップデート を入手してください。

LinuxMLD 6 の標準インストールでは、日本語などローカライズされた man page の whatis データベースは作成しない設定になっていますので、 apropos で日本語のキーワードを使用するには /etc/cron.daily/makewhatis.cron

makewhatis -u -w

の行を

LANGUAGE=ja makewhatis -u -w

のようにします。 /etc/cron.weekly/makewhatis.cron も同様に修正します。
この、cron による makewhatis は午前4時ころに起動されますので、この時間帯にマシンを稼働させない運用の場合は 手動で

# LANGUAGE=ja /usr/sbin/makewhatis -w

を実行します。
なお、MLD 6,7 では whatis データベースは /var/cache/man/ に作成されます。

man のオプション -K (大文字の K) を使うとすべての man ページから文字列を検索することもできます (ただし、時間は掛かります)。

Info

Info は GNU のドキュメントシステムです。

$ info

とすると、info システムに登録されている topic がリストされます。 topic 名が分かっているなら info コマンドの引数に指定できます。 終了は 'q' です。Ctrl-h でヘルプが出ます。
Info システムは GNU Emacs から使うと便利なようにできています。 Emacs に慣れていない人は次の GNOME ヘルプからアクセスする方が便利かもしれません。

GNOME ヘルプ

GNOME ヘルプは、GNOME についてのヘルプ情報だけでなく、man page、info ドキュメントも読むことができます。

LinuxMLD 7 の場合

MLD 7 で GNOME ヘルプを表示するには、 イン・メニューから「GNOME ヘルプ・システム」を選択します。 GNOME ヘルプ・ブラウザが起動します。

「マニュアル・ページ」をクリックすると マニュアル・ページのセクションに相当するカテゴリが表示されます。 各カテゴリをクリックすればそれぞれの項目がリストされます。 それぞれのページは html に変換されて表示されるので、 「関連項目」などがリンクとして扱われ、便利です。

同様に、「Info ページ」をクリックすると Info の目次が表示されます。 man ページ同様 html に変換されて表示されるので info コマンドになれていない人には 便利でしょう。

LinuxMLD 6 の場合

MLD 6 ではスクリーン下の GNOME パネルにあるアイコン gnome-help-icon をクリックします。またはメニューの「プログラム」→「ヘルプシステム」 を選択します。Galeon でヘルプインデックスが表示されます。

「マニュアル・ページ」をクリックすると マニュアル・ページの目次が、セクション別にアルファベット順で表示されます。

同様に、「Info ページ」をクリックすると まず Info のディレクトリがリストされ、 そこから「/usr/share/info」をクリックすれば Info の目次が表示されます。

「マニュアル・ページ」では、デフォルトでは /usr/share/man 以下の man page がリストされます。 /usr/X11R6/man/usr/local/share/man 以下もリストするには、~/.bash_profile

export MANPATH=/usr/share/man:/usr/X11R6/man:/usr/man:/usr/local/share/man

のように書いておきます。
Info もデフォルトでは /usr/share/info しか対象にされませんが、 同じく ~/.bash_profile

export INFOPATH=/usr/share/info:/usr/local/share/info

のように書いておけば他のディレクトリも参照できます。

LinuxMLD 5 の場合

MLD 5 ではスクリーン下の GNOME パネルにあるアイコン gnome-help-icon をクリックします。Gnome ヘルプブラウザが起動します。

最初に出て来る「ヘルプ・インデックス」にある「Man ページ」をクリックすると マニュアル・ページの目次が、セクション別にアルファベット順で表示されます。

同様に、「Info ページ」をクリックすると Info の目次が表示されます。

MLD 5 の Gnome ヘルプブラウザでは man と info のパスは 「設定」メニューの「パス」で指定できます。

アプリケーション固有のドキュメント

アプリケーション固有のドキュメントがある場合、 それらは大抵 /usr/share/doc/ ディレクトリ下のアプリケーション名 (にバージョン番号を付けた名前) のサブディレクトリにインストールされます。 ほとんどの場合、README あるいは Readme というような ドキュメントファイルが見付かります。

やや古いシステムではドキュメントのディレクトリは /usr/doc でした。

あるいは、/usr/share/アプリケーション名 のディレクトリ (アプリケーションが実行時に参照するアプリケーション固有のディレクトリ) にドキュメントがある場合もあります。

名前に .ps が付いているファイルは PostScript のファイルです。 印刷するか、Ghostview (gv) を使って

$ gv psファイル

で画面上で読むことができます (MLD 6,7 では gv を追加インストールしてください)。

名前に .pdf が付いているファイルは Adobe 社 の Acrobat が生成する PDF (Portable Document Format) ファイルです。 MLD 6,7 では標準インストールの xpdf または gv で読むことができます (PDF のバージョンや言語セットによっては読めないこともあります)。 MLD5 では gv または Disc3 に収録している xpdf を使用してください。

名前に .dvi が付いているファイルは TeX が生成する Device Independent ファイルです。 TeX のパッケージに含まれる xdvi で読むことができます。 MLD 6,7 では tetex を追加インストールしてください (tetex のインストール方法はユーザーズマニュアルを参照してください)。 MLD5 では xdvi は標準インストールされています。

.html が付いたファイルなら web ブラウザで読めます。 適当な web ブラウザを 起動して、ファイルメニューから「ファイルを開く」のようなメニューを使って そのファイルを開いてみてください。

アプリケーションによっては --help オプション (あるいは -h) 付きで 起動するとヘルプを表示するものがあります。

[2001/03/16 作成] [2003/10/31 更新]


このページに関する御意見、御要望を science@mlb.co.jp までお寄せ下さい
Copyright © 2001-2005 Media Lab. All Rights Reserved.