summaryrefslogtreecommitdiffstats
path: root/system/kiwix-tools-bin/docs/man/kiwix-search.1
diff options
context:
space:
mode:
Diffstat (limited to 'system/kiwix-tools-bin/docs/man/kiwix-search.1')
-rw-r--r--system/kiwix-tools-bin/docs/man/kiwix-search.121
1 files changed, 21 insertions, 0 deletions
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