mirror of
https://github.com/kiwix/kiwix-tools.git
synced 2025-12-22 03:47:06 +00:00
@@ -4,7 +4,6 @@ Kiwix tools
|
||||
The Kiwix tools is a collection of [Kiwix](https://kiwix.org) related
|
||||
command line tools:
|
||||
* kiwix-manage: Manage XML based library of ZIM files
|
||||
* kiwix-read: Read ZIM file content
|
||||
* kiwix-search: Fulltext search in ZIM files
|
||||
* kiwix-serve: HTTP daemon serving ZIM files
|
||||
|
||||
|
||||
1
debian/control
vendored
1
debian/control
vendored
@@ -21,6 +21,5 @@ Description: collection of Kiwix tools
|
||||
over the network.
|
||||
* kiwix-manage allows one to manage the content of the Kiwix library (an
|
||||
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
|
||||
search patterns.
|
||||
|
||||
@@ -11,13 +11,13 @@ Kiwix-tools Docker image
|
||||
$ docker run -it kiwix/kiwix-tools:3.1.2
|
||||
|
||||
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.
|
||||
|
||||
```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
|
||||
@@ -29,4 +29,4 @@ docker run -v $(pwd):/data -it kiwix/kiwix-tools kiwix-read --suggest="Mali" /da
|
||||
**Notes:**
|
||||
|
||||
- `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.
|
||||
|
||||
@@ -3,7 +3,6 @@
|
||||
files=(
|
||||
"src/installer/kiwix-install.cpp"
|
||||
"src/searcher/kiwix-search.cpp"
|
||||
"src/reader/kiwix-read.cpp"
|
||||
"src/manager/kiwix-manage.cpp"
|
||||
"src/server/kiwix-serve.cpp"
|
||||
)
|
||||
|
||||
@@ -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,5 +1,4 @@
|
||||
install_man('kiwix-manage.1',
|
||||
'kiwix-read.1',
|
||||
'kiwix-search.1',
|
||||
'kiwix-serve.1')
|
||||
subdir('fr')
|
||||
|
||||
Reference in New Issue
Block a user