Difference between revisions of "Kiwix-manage"

From Kiwix
Jump to navigation Jump to search
(→‎Usage: Added an example :) More examples are welcome.)
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''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-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-library 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 ([http://www.kiwix.org/library.xml 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.
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 ==


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.
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 ==
== Usage ==


<source lang="bash">
<source lang="bash">
kiwix-library FILE add FILE1 [FILE2] [FILE3] [FILE4] ...
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-library FILE show [CONTENTID1] [CONTENTID2] ... (show everything if no param.)
kiwix-manage LIBRARY_PATH show [CONTENTID1] [CONTENTID2] ... (show everything if no param.)
kiwix-library FILE remove CONTENTID1 [CONTENTID2] ...
kiwix-manage LIBRARY_PATH remove CONTENTID1 [CONTENTID2]
</source>
</source>
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
Example:
<source lang="bash">
kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim
</source>
== See also ==
* [[FeedFormat]]
* [[library manager]]
* [[Build a DVD]]

Revision as of 10:37, 18 December 2017

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 [--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]

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

Example:

kiwix-manage /var/www/html/library_zim.xml add /var/www/html/zim/test.zim

See also