mirror/kiwix-tools
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-tools.git synced 2025-12-23 22:28:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove more references to kiwix-read

Browse Source 
Was removed in f9ce353ad1.
This commit is contained in:
Kunal Mehta
2022-07-25 16:43:41 -04:00
committed by Kelson
parent 092be45512
commit 0df3c14faa
6 changed files with 3 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -4,7 +4,6 @@ Kiwix tools
The Kiwix tools is a collection of [Kiwix](https://kiwix.org) related The Kiwix tools is a collection of [Kiwix](https://kiwix.org) related
command line tools: command line tools:
* kiwix-manage: Manage XML based library of ZIM files * kiwix-manage: Manage XML based library of ZIM files
* kiwix-read: Read ZIM file content
* kiwix-search: Fulltext search in ZIM files * kiwix-search: Fulltext search in ZIM files
* kiwix-serve: HTTP daemon serving ZIM files * kiwix-serve: HTTP daemon serving ZIM files

1
debian/control vendored
View File

@@ -21,6 +21,5 @@ Description: collection of Kiwix tools
over the network. over the network.
* kiwix-manage allows one to manage the content of the Kiwix library (an * kiwix-manage allows one to manage the content of the Kiwix library (an
XML file listing available ZIM files). XML file listing available ZIM files).
* kiwix-read allows for reading ZIM files from the command-line.
* kiwix-search allows one to find articles in a ZIM file using fulltext * kiwix-search allows one to find articles in a ZIM file using fulltext
search patterns. search patterns.

6
docker/README.md
View File

@@ -11,13 +11,13 @@ Kiwix-tools Docker image
$ docker run -it kiwix/kiwix-tools:3.1.2 $ docker run -it kiwix/kiwix-tools:3.1.2
Welcome to kiwix-tools! The following binaries are available: Welcome to kiwix-tools! The following binaries are available:
kiwix-manage kiwix-read kiwix-search kiwix-serve kiwix-manage kiwix-search kiwix-serve
``` ```
`kiwix-tools` operates on zim files. You shall mount a volume to access the files. `kiwix-tools` operates on zim files. You shall mount a volume to access the files.
```sh ```sh
docker run -v $(pwd):/data -it kiwix/kiwix-tools kiwix-read --suggest="Mali" /data/wikipedia_fr_test.zim docker run -v $(pwd):/data -it kiwix/kiwix-tools kiwix-search /data/wikipedia_fr_test.zim "Mali"
``` ```
## Building and reusing ## Building and reusing
@@ -29,4 +29,4 @@ docker run -v $(pwd):/data -it kiwix/kiwix-tools kiwix-read --suggest="Mali" /da
**Notes:** **Notes:**
- `wget` in `alpine:3` on `arm/v7` (__inside github action only__) crashes when downloading from HTTPs locations. Keep http-only in Dockerfile. - `wget` in `alpine:3` on `arm/v7` (__inside github action only__) crashes when downloading from HTTPs locations. Keep http-only in Dockerfile.
- Was also unhappy when using the mirrors so it's using `mirror.download` on purpose. - Was also unhappy when using the mirrors so it's using `mirror.download` on purpose.

1
format_code.sh
View File

@@ -3,7 +3,6 @@
files=( files=(
"src/installer/kiwix-install.cpp" "src/installer/kiwix-install.cpp"
"src/searcher/kiwix-search.cpp" "src/searcher/kiwix-search.cpp"
"src/reader/kiwix-read.cpp"
"src/manager/kiwix-manage.cpp" "src/manager/kiwix-manage.cpp"
"src/server/kiwix-serve.cpp" "src/server/kiwix-serve.cpp"
) )

18
src/man/kiwix-read.1
View File

@@ -1,18 +0,0 @@
.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

1
src/man/meson.build
View File

@@ -1,5 +1,4 @@
install_man('kiwix-manage.1', install_man('kiwix-manage.1',
'kiwix-read.1',
'kiwix-search.1', 'kiwix-search.1',
'kiwix-serve.1') 'kiwix-serve.1')
subdir('fr') subdir('fr')