summaryrefslogtreecommitdiffstats
path: root/system/kiwix-tools-bin/docs/man/kiwix-manage.1
blob: fe5d0420ba622e518ae8564f94395d3724ceb665 (plain)
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
.TH KIWIX-MANAGE 1 "21 May 2012"

.SH NAME
kiwix\-manage \- Kiwix Library Manager

.SH SYNOPSIS
.IX Header SYNOPSIS
.TP
\fBkiwix\-manage\fR LIBRARY_PATH \fBadd\fR ZIM_PATH ...
.TP
\fBkiwix\-manage\fR LIBRARY_PATH \fBshow\fR [ZIM_ID_1] [ZIM_ID_2] ...
.TP
\fBkiwix\-manage\fR LIBRARY_PATH \fBremove\fR ZIM_ID_1 [ZIM_ID_2] ...
.TP
\fBkiwix\-manage\fR --version
.TP
\fBkiwix\-manage\fR --help

.SH DESCRIPTION
.PP
\fBkiwix\-manage\fP is a command line tool for manipulating a Kiwix XML library.
.PP
\fBkiwix\-manage\fP allows to manage the entries of the Kiwix
library. The library file is a flat XML file listing ZIM files with
all necessary information like id, favicon, date, creator,
description, filepath, title, url, etc.

.SH ACTIONS

.TP
\fBadd\fR
Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. Create the library file if necessary.

.TP
\fBremove\fR
Remove the given \fBZIM_ID\fR from \fBLIBRARY_FILE\fR. At least one \fBZIM_ID\fR should be specified.

.TP
\fBshow\fR
Show given \fBZIM_ID\fP from \fBLIBRARY_FILE\fR. If no \fBZIM_ID\fP is given then all contents from \fBLIBRARY_FILE\fR are shown.

.SH OPTIONS
.TP
Options to be used with the action \fBadd\fR:

.TP
\fB\-\-url=HTTP_URL\fR
Set the ZIM online HTTP(S) URL

.TP
\fB\-\-zimPathToSave=OTHER_FS_PATH\fR
Set an arbitrary ZIM filesystem path (instead of the ZIM_PATH)

.TP
Other options (to be used alone):

.TP
\fB\-\-help | \-h\fR
Display the kiwix-manage help

.TP
\fB\-\-version | \-v\fR
Display the version of kiwix-manage and all dependences

.SH SEE ALSO
kiwix\-serve(1)

.SH AUTHORS
Kiwix team <contact@kiwix.org>