Zeal

zeal noun

1. a feeling of strong eagerness (usually in favor of a person or cause)
2. excessive fervor to do something or accomplish some end
3. prompt willingness

(from WordNet 3.0)

Zeal is a simple offline documentation browser inspired by Dash. Dash is such a great tool, but you might also need Zeal on OS X for various reasons.

Build Status

OS \ Branch	master	stable
Linux
Windows

Download

Get binary builds for Windows and Linux from the download page.

How to use

After installing Zeal, you need to download docsets. Go to File->Options->Docsets, select the ones you want, and click the Download button.

How to compile

Requirements

• Qt version 5.2.0 or above. Required modules: Qt WebKit Widgets, Qt SQL plugin for SQLite, Qt X11 Extras (X11 only).
  • brew install qt5
• libarchive.
  • libarchive is needed and already included in OS itself, but it lacks header files.
  • Compile libarchive and add it into LIBS in core.pri. You also need some from xcode for its dependency.

To compile Zeal run qmake and then make. Linux users can install Zeal with make install command.

• /usr/local/opt/qt5/bin/qmake
• make

Query & Filter docsets

You can limit the search scope by using ':' to indicate the desired docsets:

java:BaseDAO

You can also search multiple docsets separating them with a comma:

python,django:string

Command line

If you prefer, you can start Zeal with a query from command line:

open -a zeal -n -g --args python:bomb

Creating your own docsets

You can use Dash's instructions for generating docsets.

Contact and Support

We want your feedback! Here's a list of different ways to contact developers and request help:

• Report bugs and submit feature requests to GitHub issues.
• Ask any questions in our Google Group. You can simply send an email to zealdocs@googlegroups.com.
• For a quick chat with developers and other Zeal users use our IRC channel: #zealdocs on Freenode. Also available through Kiwi IRC web interface. Please, take into consideration possible time zone differences.
• Finally, for a private communications send us email.
• And do not forget to follow @zealdocs on Twitter!

License

This software is licensed under the terms of the GNU General Public License version 3 (GPLv3). Full text of the license is available in the COPYING file and online.