ウェブサイト検索

Linux 上で API ドキュメントをオフラインで参照および検索する方法


プログラマーにとって、優れた API ドキュメントはプログラミングの教科書のライブラリよりも価値があります。あなたが熱心な開発者であれば、必要な API ドキュメントをすべて手元に置いて作業を楽にしたいと考えているでしょう。ほとんどの IDE では、API ドキュメントを組み込むための簡単なツールチップまたは IDE 固有の方法が提供されています。ただし、これらはほとんどが IDE 固有であり、ドキュメントの可用性と詳細さは言語によって異なります。

そんな時はZealがお手伝いします。 Zeal は、オフライン API ドキュメント ブラウザーです。 Zeal のアイデアは、MacOS X ドキュメント ブラウザである Dash から来ています。Dash には、人気のあるプログラミング言語、スクリプト、およびフレームワークの 130 以上の厳選されたドキュメント セット (docsets) が付属しています。 Zeal は、Dash によって提供されたのと同じドキュメントセットにアクセスできます。各ドキュメントセットには、詳細な API 定義、コード スニペット、およびユーザーが投稿したメモが含まれています。

このチュートリアルでは、Linux プラットフォーム上で API ドキュメントをオフラインで参照および検索できるように Zeal を設定する方法について説明します。

Ubuntu に Zeal をインストールする

Ubuntu 14.04 以前の場合:

PPA リポジトリのおかげで、Ubuntu LTS への Zeal のインストールは簡単です。


$ sudo add-apt-repository ppa:jerzy-kozera/zeal-ppa
$ sudo apt-get update
$ sudo apt-get install zeal

Ubuntu 14.10 以降の場合:

現時点では、公式 PPA は最新の Ubuntu 14.10 用に更新されていません。したがって、ソースからビルドして Zeal をインストールします。


$ sudo apt-get install git qt5-default libgtk2.0-dev libqt5webkit5-dev libappindicator-dev qtbase5-private-dev libxcb-keysyms1-dev
$ git clone https://github.com/jkozera/zeal.git
$ cd zeal/zeal
$ qmake
$ make
$ sudo make install

Debian に Zeal をインストールする

まず、公式 QT インストーラーを使用して QT5 を Debian にインストールします。

次に、ソースから Zeal をビルドする前に、他の前提条件をインストールします。


$ sudo apt-get install g++ libxcb-keysyms1-dev zlib1g-dev libx11-dev  libxslt1-dev  libgstreamer0.10-dev libgstreamer-plugins-base0.10-dev libgl1-mesa-dev

最後に、ソースをダウンロードし、次のようにソースから Zeal をビルド/インストールします。


$ git clone https://github.com/jkozera/zeal.git
$ cd zeal/zeal
$ qmake
$ make
$ sudo make install

Fedora に Zeal をインストールする

Qt5 で Zeal を構築するための前提条件をインストールします。


$ sudo yum install qt5-qtwebkit-devel qt5-qtbase-devel xcb-util-keysyms-devel bsdtar

公式リポジトリからソースをクローンし、そのソースから Zeal をビルドします。


$ git clone https://github.com/jkozera/zeal.git
$ cd zeal/zeal
$ qmake-qt5
$ make
$ sudo make install

Arch Linux に Zeal をインストールする

Arch Linux へのインストールは、AUR を使用すると簡単です。

Linux で Zeal を起動する

Zeal を起動するには、次のコマンドを実行するだけです。


$ zeal

初回起動時に、ホットキー バインドの競合に関する警告メッセージが表示される場合があります。この警告を回避するには、Zeal のデフォルトのホットキー (Alt+Space) を無効にします。これを行うには、編集 → オプション に移動し、ホットキー オプションで クリア を選択します。必要に応じて、Zeal のカスタム ショートカットを設定できます。

Zeal の 1 回限りのセットアップでは、オフラインで API 定義を検索するために使用される API ドキュメントセットをダウンロードします。前述したように、これらのドキュメントセットは MacOS X Dash プロジェクトの一部として提供されています。 Zeal は同じ API ドキュメントにアクセスできます。

編集 → オプション に移動し、ドキュメント タブを選択して、ダウンロード ボタンをクリックします。

次に、次のように利用可能なドキュメントセットのリストが表示されます。

オフラインでアクセスするドキュメントセットを選択し、ダウンロード ボタンを再度クリックします。選択したドキュメントセットが正常にダウンロードされると、次のように ドキュメント の下にリストされます。デフォルトでは、選択したドキュメントセットは ~/.local/share/zeal/docsets に保存されます。

これで、API ドキュメントにアクセスする準備ができました。左側の検索バーに、調べたい API を入力し始めるだけです。 API 定義は右側のサイドバーにすぐに表示されます。

関連記事: