From f5762c72d30d95c7197934b31b110e3b67cd5054 Mon Sep 17 00:00:00 2001 From: Kunal Mehta Date: Thu, 9 Jul 2020 00:32:04 -0700 Subject: [PATCH] Add man pages for kiwix-read and kiwix-search --- 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')