Difference between revisions of "Kiwix-manage"
(→Usage: Added an example of the --url option) |
(→Usage: Removed --indexPath option; = cannot be used with short options; provided examples of all valid usages of the -u|--url option) |
||
| Line 14: | Line 14: | ||
<source lang="bash"> | <source lang="bash"> | ||
kiwix-manage LIBRARY_PATH add ZIM_PATH [--zimPathToSave | kiwix-manage LIBRARY_PATH add ZIM_PATH [-z|--zimPathToSave the_string_you_want_to_see_in_the_library] [-u|--url 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] | ||
| Line 25: | Line 25: | ||
<source lang="bash"> | <source lang="bash"> | ||
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim | kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim | ||
# Add a ZIM file with a download URL (all below examples are equivalent) | |||
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim -u http://example.com/zims/test.zim | |||
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim --url http://example.com/zims/test.zim | kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim --url http://example.com/zims/test.zim | ||
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim --url=http://example.com/zims/test.zim | |||
</source> | </source> | ||
Revision as of 06:48, 15 July 2022
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
- 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 [-z|--zimPathToSave the_string_you_want_to_see_in_the_library] [-u|--url http://...metalink]
kiwix-manage LIBRARY_PATH show [CONTENTID1] [CONTENTID2] ... (show everything if no param.)
kiwix-manage LIBRARY_PATH remove CONTENTID1 [CONTENTID2]
ZIM_PATH is the path, including the filename of the ZIM file. LIBRARY_PATH is the path, including the filename of the library XML file to create or modify. Typically it is called library_zim.xml
Examples:
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim
# Add a ZIM file with a download URL (all below examples are equivalent)
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim -u http://example.com/zims/test.zim
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim --url http://example.com/zims/test.zim
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim --url=http://example.com/zims/test.zim