Difference between revisions of "Kiwix-manage"
Jump to navigation
Jump to search
(→Usage) |
(→Usage) |
||
| Line 14: | Line 14: | ||
<source lang="bash"> | <source lang="bash"> | ||
kiwix-manage LIBRARY_PATH add ZIM_PATH [--zimPathToSave|-z=the_string_you_want_to_see_in_the_library | kiwix-manage LIBRARY_PATH add ZIM_PATH [--zimPathToSave|-z=the_string_you_want_to_see_in_the_library] [--indexPath|-i=FULLTEXT_IDX_PATH] [url|u=http://...metalink] | ||
kiwix-manage LIBRARY_PATH show [CONTENTID1] [CONTENTID2] ... (show everything if no param.) | kiwix-manage LIBRARY_PATH show [CONTENTID1] [CONTENTID2] ... (show everything if no param.) | ||
kiwix-manage LIBRARY_PATH remove CONTENTID1 [CONTENTID2] | kiwix-manage LIBRARY_PATH remove CONTENTID1 [CONTENTID2] | ||
Revision as of 12:12, 27 November 2014
kiwix-manage 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 necessary informations like (favicon, date, creator, description, indexpath, filepath, title, source/metalink, ...).
kiwix-manage generated files are thought for two usages:
- Local library file for kiwix-serve (need to be implemented in kiwix-serve)
- Remote/portable library file for the Kiwix software, providing a list of downloadable content (example).
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-manage is based on a kiwix::Manager class coded in C++ and using a simple/fast/protable XML/DOM XML library (pugixml). To extract content from the ZIM file, it will use the zimlib code.
Usage
kiwix-manage LIBRARY_PATH add ZIM_PATH [--zimPathToSave|-z=the_string_you_want_to_see_in_the_library] [--indexPath|-i=FULLTEXT_IDX_PATH] [url|u=http://...metalink]
kiwix-manage LIBRARY_PATH show [CONTENTID1] [CONTENTID2] ... (show everything if no param.)
kiwix-manage LIBRARY_PATH remove CONTENTID1 [CONTENTID2]