Kiwix-manage

From Kiwix
Revision as of 10:14, 29 March 2011 by Kelson (talk | contribs)
Jump to navigation Jump to search

kiwix-library is a console tool which allows to build library files for Kiwix. A library file is an XML flat file listing ZIM files with all the necessarz properties like (favicon, date, creator, description, indexpath, filepath, title, source/metalink, ...).

kiwix-library generated files are thought for two usages:

  • Local library file for kiwix-serve
  • Remote/portable library file for the Kiwix software, providing a list of downloadable content.

By the way, an intern library file is also managed an build directly by Kiwix, following the user behaviour (adding, removing new content)... and the format is exactly the same.

Technical details

kiwix-library is based on a kiwix::library class coded in C++ and using a simple/fast/protable XML/DOM XML library. To exctract content from the ZIM file, it will use the zimlib code.

Usage

kiwix-library FILE add FILE1 [FILE2] [FILE3] [FILE4] ...
kiwix-library FILE show [CONTENTID1] [CONTENTID2] ... (show everything if no param.)
kiwix-library FILE remove CONTENTID1 [CONTENTID2] ...