diff options
Diffstat (limited to 'system/kiwix-tools-bin/docs/man')
| -rw-r--r-- | system/kiwix-tools-bin/docs/man/kiwix-manage.1 | 69 | ||||
| -rw-r--r-- | system/kiwix-tools-bin/docs/man/kiwix-search.1 | 21 | ||||
| -rw-r--r-- | system/kiwix-tools-bin/docs/man/kiwix-serve.1 | 136 |
3 files changed, 226 insertions, 0 deletions
diff --git a/system/kiwix-tools-bin/docs/man/kiwix-manage.1 b/system/kiwix-tools-bin/docs/man/kiwix-manage.1 new file mode 100644 index 0000000000..fe5d0420ba --- /dev/null +++ b/system/kiwix-tools-bin/docs/man/kiwix-manage.1 @@ -0,0 +1,69 @@ +.TH KIWIX-MANAGE 1 "21 May 2012" + +.SH NAME +kiwix\-manage \- Kiwix Library Manager + +.SH SYNOPSIS +.IX Header SYNOPSIS +.TP +\fBkiwix\-manage\fR LIBRARY_PATH \fBadd\fR ZIM_PATH ... +.TP +\fBkiwix\-manage\fR LIBRARY_PATH \fBshow\fR [ZIM_ID_1] [ZIM_ID_2] ... +.TP +\fBkiwix\-manage\fR LIBRARY_PATH \fBremove\fR ZIM_ID_1 [ZIM_ID_2] ... +.TP +\fBkiwix\-manage\fR --version +.TP +\fBkiwix\-manage\fR --help + +.SH DESCRIPTION +.PP +\fBkiwix\-manage\fP is a command line tool for manipulating a Kiwix XML library. +.PP +\fBkiwix\-manage\fP allows to manage the entries of the Kiwix +library. The library file is a flat XML file listing ZIM files with +all necessary information like id, favicon, date, creator, +description, filepath, title, url, etc. + +.SH ACTIONS + +.TP +\fBadd\fR +Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. Create the library file if necessary. + +.TP +\fBremove\fR +Remove the given \fBZIM_ID\fR from \fBLIBRARY_FILE\fR. At least one \fBZIM_ID\fR should be specified. + +.TP +\fBshow\fR +Show given \fBZIM_ID\fP from \fBLIBRARY_FILE\fR. If no \fBZIM_ID\fP is given then all contents from \fBLIBRARY_FILE\fR are shown. + +.SH OPTIONS +.TP +Options to be used with the action \fBadd\fR: + +.TP +\fB\-\-url=HTTP_URL\fR +Set the ZIM online HTTP(S) URL + +.TP +\fB\-\-zimPathToSave=OTHER_FS_PATH\fR +Set an arbitrary ZIM filesystem path (instead of the ZIM_PATH) + +.TP +Other options (to be used alone): + +.TP +\fB\-\-help | \-h\fR +Display the kiwix-manage help + +.TP +\fB\-\-version | \-v\fR +Display the version of kiwix-manage and all dependences + +.SH SEE ALSO +kiwix\-serve(1) + +.SH AUTHORS +Kiwix team <contact@kiwix.org> diff --git a/system/kiwix-tools-bin/docs/man/kiwix-search.1 b/system/kiwix-tools-bin/docs/man/kiwix-search.1 new file mode 100644 index 0000000000..43b61cc46e --- /dev/null +++ b/system/kiwix-tools-bin/docs/man/kiwix-search.1 @@ -0,0 +1,21 @@ +.TH KIWIX-SEARCH "1" "July 2020" "kiwix-tools" "User Commands" +.SH NAME +kiwix-search \- find articles using a fulltext search pattern +.SH SYNOPSIS +\fBkiwix-search\fR [OPTIONS] ZIM PATTERN\fR +.SH DESCRIPTION +.TP +ZIM +ZIM file to search +.TP +PATTERN +Words or parts of words to search for in the ZIM file +.TP +\fB\-s\fR, \fB\-\-suggestion\fR +Suggest article titles based on the PATTERN instead of a fulltext search +.TP +\fB\-V\fR, \fB\-\-version\fR +print software version +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Give details about the search process diff --git a/system/kiwix-tools-bin/docs/man/kiwix-serve.1 b/system/kiwix-tools-bin/docs/man/kiwix-serve.1 new file mode 100644 index 0000000000..69d86b462e --- /dev/null +++ b/system/kiwix-tools-bin/docs/man/kiwix-serve.1 @@ -0,0 +1,136 @@ +.TH KIWIX 1 "10 July 2023" + +.SH NAME +kiwix-serve \- Kiwix HTTP Server + +.SH SYNOPSIS + +.B kiwix-serve --library [OPTIONS] LIBRARY_FILE_PATH +.br +.B kiwix-serve [OPTIONS] ZIM_FILE_PATH ... + +.SH DESCRIPTION +The \fBkiwix-serve\fR command is used to run a stand-alone HTTP server for serving ZIM contents over the network. + +.SH ARGUMENTS +.TP +\fBLIBRARY_FILE_PATH\fR +Path of an XML library file listing ZIM files to serve. To be used only with the --library option. Multiple library files can be provided as a semicolon (;) separated list. + +.TP +\fBZIM_FILE_PATH ...\fR +ZIM file path(s). Multiple arguments are allowed. + +.SH OPTIONS +.TP +\fB--library\fR +By default, kiwix-serve expects a list of ZIM files as command line arguments. Providing the --library option tells kiwix-serve that the command line argument is rather a library XML file. + +.TP +\fB-i ADDR, --address=ADDR\fR +Listen only on this IP address. By default, the server listens on all available IP addresses. + +.TP +\fB-p PORT, --port=PORT\fR +TCP port on which to listen for HTTP requests (default: 80). + +.TP +\fB-r ROOT, --urlRootLocation=ROOT\fR +URL prefix on which the content should be made available (default: empty). + +.TP +\fB-d, --daemon\fR +Detach the HTTP server daemon from the main process. + +.TP +\fB-a PID, --attachToProcess=PID\fR +Exit when the process with id PID stops running. + +.TP +\fB-M, --monitorLibrary\fR +Monitor the XML library file and reload it automatically when it changes. + +Library reloading can be forced anytime by sending a SIGHUP signal to the +\*(lqkiwix-serve\*(rq process (this works regardless of the presence of the +\*(lq--monitorLibrary\*(rq/\*(lq-M\*(rq option). + +.TP +\fB-m, --nolibrarybutton\fR +Disable the library home button in the ZIM viewer toolbar. + +.TP +\fB-n, --nosearchbar\fR +Disable the search box in the ZIM viewer toolbar. + +.TP +\fB-b, --blockexternal\fR +Prevent users from directly navigating to external resources via links in ZIM content. + +.TP +\fB-t N, --threads=N\fR +Number of threads to run in parallel (default: 4). + +.TP +\fB-s N, --searchLimit=N\fR +Maximum number of ZIM files in a fulltext multizim search (default: No limit). + +.TP +\fB-z, --nodatealiases\fR +Create URL aliases for each content by removing the date embedded in the file name. + +The expected format of the date in the filename is \*(lq_YYYY-MM\*(rq. For example, a ZIM file named \*(lqwikipedia_en_all_2020-08.zim\*(rq will be accessible both as \*(lqwikipedia_en_all_2020-08\*(rq and \*(lqwikipedia_en_all\*(rq. + +.TP +\fB-c PATH, --customIndex=PATH\fR +Override the welcome page with a custom HTML file. + +.TP +\fB-L N, --ipConnectionLimit=N\fR +Max number of (concurrent) connections per IP (default: infinite, recommended: >= 6). + +.TP +\fB-k, --skipInvalid\fR +Startup even when ZIM files are invalid (those will be skipped) + +.TP +\fB-v, --verbose\fR +Print debug log to STDOUT. + +.TP +\fB-V, --version\fR +Print the software version. + +.TP +\fB-h, --help\fR +Print a help message. + +.SH EXAMPLES +Serve a single ZIM file: +.sp +.nf +.B kiwix-serve myzim.zim +.fi + +Serve multiple ZIM files: +.sp +.nf +.B kiwix-serve zim1.zim zim2.zim zim3.zim +.fi + +Serve ZIM files from a library: +.sp +.nf +.B kiwix-serve --library library.xml +.fi + +.SH DOCUMENTATION +Online documentation: https://kiwix-tools.readthedocs.io/en/latest/kiwix-serve.html +.br +Source code: https://github.com/kiwix/kiwix-tools +.br +More info: https://wiki.kiwix.org/wiki/Kiwix-serve + +.SH AUTHORS +Emmanuel Engelhart <kelson@kiwix.org> +.br +Vasudev Kamath <kamathvasudev@gmail.com> |