Package: kiwix-tools / 3.1.2-3

0001-Add-man-pages-for-kiwix-read-and-kiwix-search.patch Patch series | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
From: Kunal Mehta <legoktm@member.fsf.org>
Date: Thu, 9 Jul 2020 00:32:04 -0700
Subject: Add man pages for kiwix-read and kiwix-search

Origin: https://github.com/kiwix/kiwix-tools/commit/f5762c72d30d95c7197934b31b110e3b67cd5054
---
 src/man/kiwix-read.1   | 18 ++++++++++++++++++
 src/man/kiwix-search.1 | 21 +++++++++++++++++++++
 src/man/meson.build    |  2 ++
 3 files changed, 41 insertions(+)
 create mode 100644 src/man/kiwix-read.1
 create mode 100644 src/man/kiwix-search.1

diff --git a/src/man/kiwix-read.1 b/src/man/kiwix-read.1
new file mode 100644
index 0000000..94526f9
--- /dev/null
+++ b/src/man/kiwix-read.1
@@ -0,0 +1,18 @@
+.TH KIWIX-READ "1" "July 2020" "kiwix-tools" "User Commands"
+.SH NAME
+kiwix-read \- Read ZIM file content
+.SH SYNOPSIS
+\fBkiwix-read\fR [\-\-verbose] [\-\-version] \-\-suggest=PATTERN ZIM\fR
+.SH DESCRIPTION
+.TP
+ZIM
+ZIM file to search
+.TP
+\fB\-\-verbose\fR
+Enable extra output
+.TP
+\fB\-\-version\fR
+print software version
+.TP
+\fB\-\-suggest=PATTERN\fR
+Get search suggestions for the provided pattern
diff --git a/src/man/kiwix-search.1 b/src/man/kiwix-search.1
new file mode 100644
index 0000000..43b61cc
--- /dev/null
+++ b/src/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/src/man/meson.build b/src/man/meson.build
index 2345deb..6e77cca 100644
--- a/src/man/meson.build
+++ b/src/man/meson.build
@@ -1,3 +1,5 @@
 install_man('kiwix-manage.1',
+            'kiwix-read.1',
+            'kiwix-search.1',
             'kiwix-serve.1')
 subdir('fr')