Difference between revisions of "Kiwix-manage"
Jump to navigation
Jump to search
(→Usage) |
m (typos found with languagetool.org) |
||
| Line 1: | Line 1: | ||
'''kiwix-manage''' is a console tool which allows | '''kiwix-manage''' is a console tool which allows building library files for Kiwix. A library file is an XML flat file listing ZIM files with all the necessary information (like favicon, date, creator, description, indexpath, filepath, title, source/metalink, ...). | ||
kiwix-manage generated files are thought for two usages: | kiwix-manage generated files are thought for two usages: | ||
| Line 5: | Line 5: | ||
* Remote/portable library file for the Kiwix software, providing a list of downloadable content ([http://www.kiwix.org/library.xml example]). | * Remote/portable library file for the Kiwix software, providing a list of downloadable content ([http://www.kiwix.org/library.xml example]). | ||
By the way, an intern library file is also managed | By the way, an intern library file is also managed and build directly by Kiwix, following the user behaviour (adding, removing new content)... and the format is exactly the same. | ||
== Technical details == | == Technical details == | ||
Revision as of 02:53, 21 January 2015
kiwix-manage is a console tool which allows building library files for Kiwix. A library file is an XML flat file listing ZIM files with all the necessary information (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 and 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]