Zimreader

From openZIM
Jump to navigation Jump to search

The ZIMreader is a reader software for end users to access the contents of ZIM files.

It is based on tntnet and works as a webserver:

  • put the ZIM files and the ZIMreader executable in the same directory
  • start ZIMreader
  • access the webapplication via http://localhost:8080/

Command Line Options

$> zimreader
usage: zimreader [options] zim-file

options:
        -l <ip>        listen ip (default 0.0.0.0)
        -p <port>      listen port (default 8080)
        -x <indexfile> full text index file name

Starting the ZIMreader on the DVD

$> bin/zimreader zim/wikipedia-de.zim -x zim/wikipedia-de-x.zim
  • the ZIMreader binary is located in bin/
  • the ZIM files are located in zim/
  • wikipedia-de.zim is the ZIM file with all contents (mandatory)
  • wikipedia-de-x.zim is the ZIM file with the fulltext index (optional)

Other Readers

The ZIMreader provided by openZIM is just an example application, free to use and open source. It has been developed under the name "tntzenoreader" in 2007 by Tommi Mäkitalo, the developer of tntnet (and now lead developer of openZIM), to be used on the german Wikipedia DVD. The "Wikipedia DVD 2007/2008" contained Zeno files, the proprietary ZenoReader by DirectMedia and the free tntzenoreader as source tarball, Linux packages and Mac OS X package.

There are more Wikipedia Offline and other kind of offline readers out there which also use the ZIM File Format.

Feel free to integrate the ZIM file format into your offline reader and list it here.