8,236
edits
Difference between revisions of "Kiwix-manage"
Jump to navigation
Jump to search
no edit summary
Julianharty (talk | contribs) (→Usage: Added a couple of explanations to this section to help the perplexed (as I was).) |
|||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
kiwix-manage generated files are thought for two usages: | kiwix-manage generated files are thought for two usages: | ||
* Local library file for kiwix-serve | * Local library file for kiwix-serve | ||
* Remote/portable library file for the Kiwix software, providing a list of downloadable content ([ | * Remote/portable library file for the Kiwix software, providing a list of downloadable content ([https://download.kiwix.org/library/library_zim.xml 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. | 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. | ||
| 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 21: | Line 21: | ||
ZIM_PATH is the path, including the filename of the ZIM file. | 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 | 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: | |||
<source lang="bash"> | |||
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 | |||
</source> | |||
== See also == | == See also == | ||