From cef30cd0b85c266a503c480bfcf88b73c599d110 Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Sat, 10 Sep 2022 10:11:38 +0200 Subject: [PATCH 1/6] Rewritten kiwix-manage man page --- src/man/kiwix-manage.1 | 84 +++++++++++++++++++++++------------------- 1 file changed, 47 insertions(+), 37 deletions(-) diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 index 16a3d97..2b3107a 100644 --- a/src/man/kiwix-manage.1 +++ b/src/man/kiwix-manage.1 @@ -1,62 +1,72 @@ -.TH KIWIX 1 "21 May 2012" +.TH KIWIX-MANAGE 1 "21 May 2012" + .SH NAME kiwix\-manage \- Kiwix Library Manager + .SH SYNOPSIS .IX Header SYNOPSIS -.B kiwix\-manage -.br -kiwix\-manage LIBRARY_PATH add ZIM_PATH ... -.br - kiwix-manage LIBRARY_PATH show [CONTENTID1] [CONTENTID2] ... -.br - kiwix\-manage LIBRARY_PATH remove CONTENTID1 [CONTENTID2] +.TP +\fBkiwix\-manage\fR LIBRARY_PATH add ZIM_PATH ... +.TP +\fBkiwix\-manage\fR LIBRARY_PATH show [ZIM_ID_1] [ZIM_ID_2] ... +.TP +\fBkiwix\-manage\fR LIBRARY_PATH remove ZIM_ID_1 [ZIM_ID_2] ... +.TP +\fBkiwix\-manage\fR --version +.TP +\fBkiwix\-manage\fR --help + .SH DESCRIPTION -.SS kiwix\-manage -.PP -\fBkiwix\-manage\fP tool for managing a kiwix library. .PP -Allows one to manage the content of the kiwix library. The library file is a -flat XML file listing ZIM files with all necessary information like favicon, -date, creator, description, indexpath, filepath, title, source/metalink, etc. -. +\fBkiwix\-manage\fP is a command line tool for manipulating a Kiwix XML library. .PP - Example library file can be found at https://www.kiwix.org/library\.xml -.br +\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. +Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\f. + +.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 \fBCONTENT_ID\fP from \fBLIBRARY_FILE\fR. If no \fBCONTENT_ID\fP is given then all contents from \fBLIBRARY_FILE\fR are shown. +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 -\fBremove\fR -Remove the given \fBCONTENT_ID\fR from \fBLIBRARY_FILE\fR. At least one \fBCONTENT_ID\fR should be specified. +Options to be used with the action \fBadd\fR: .TP -\fB\-\-zimPathToSave=\fR -Change the location reference of the ZIM file in the library. +\fB\-\-url=HTTP_URL\fR +Set the ZIM online HTTP(S) URL .TP -\fB\-\-current\fR -Mark this content as the current (default) content in the library. +\fB\-\-zimPathToSave=OTHER_FS_PATH\fR +Set an arbitrary ZIM filesystem path (instead of the ZIM_PATH) .TP -\fB\-\-backend=xapian|clucene\fR -Select an indexing backend. +Other options (to be used alone): .TP -\fB\-\-indexPath=FULLTEXT_IDX_PATH\fR -Path to full-text index for that ZIM file. +\fB\-\-help | \-h +Display the kiwix-manage help .TP -\fBurl\fR -Set the content location of the ZIM file over the network for in\-kiwix download. +\fB\-\-version | \-v +Display the version of kiwix-manage and all dependences + +.SH EXAMPLE +Example library file can be found at https://download.kiwix.org/library/library_zim\.xml + +.SH SEE ALOS +kiwix\-serve(1) -.SH SEE ALSO -kiwix(1) kiwix\-serve(1) -.SH AUTHOR -Emmanuel Engelhart -.br -Vasudev Kamath (Manual) +.SH AUTHORS +Kiwix team From 3c6e8ed6c82323bfae6e9642fe49435fb17dc81b Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Sun, 18 Sep 2022 16:57:47 +0200 Subject: [PATCH 2/6] Fix: simple ALOS typo --- src/man/kiwix-manage.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 index 2b3107a..f7b49e8 100644 --- a/src/man/kiwix-manage.1 +++ b/src/man/kiwix-manage.1 @@ -65,7 +65,7 @@ Display the version of kiwix-manage and all dependences .SH EXAMPLE Example library file can be found at https://download.kiwix.org/library/library_zim\.xml -.SH SEE ALOS +.SH SEE ALSO kiwix\-serve(1) .SH AUTHORS From db7f30fb811e4b41360e58656746661935260d17 Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Sun, 18 Sep 2022 17:00:53 +0200 Subject: [PATCH 3/6] Fix: Remove example library.xml because useless --- src/man/kiwix-manage.1 | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 index f7b49e8..01cdf6b 100644 --- a/src/man/kiwix-manage.1 +++ b/src/man/kiwix-manage.1 @@ -62,9 +62,6 @@ Display the kiwix-manage help \fB\-\-version | \-v Display the version of kiwix-manage and all dependences -.SH EXAMPLE -Example library file can be found at https://download.kiwix.org/library/library_zim\.xml - .SH SEE ALSO kiwix\-serve(1) From 0a7e91ceb7cd3ce1046fc1e95a6d30815526c281 Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Sun, 18 Sep 2022 17:03:24 +0200 Subject: [PATCH 4/6] Fix: Fix missing enclosures --- src/man/kiwix-manage.1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 index 01cdf6b..ec94310 100644 --- a/src/man/kiwix-manage.1 +++ b/src/man/kiwix-manage.1 @@ -29,7 +29,7 @@ description, filepath, title, url, etc. .TP \fBadd\fR -Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\f. +Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. .TP \fBremove\fR @@ -55,11 +55,11 @@ Set an arbitrary ZIM filesystem path (instead of the ZIM_PATH) Other options (to be used alone): .TP -\fB\-\-help | \-h +\fB\-\-help | \-h\fR Display the kiwix-manage help .TP -\fB\-\-version | \-v +\fB\-\-version | \-v\fR Display the version of kiwix-manage and all dependences .SH SEE ALSO From 6f0f666be5c93055faca66af7a4e3d573b9617de Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Sun, 18 Sep 2022 17:12:05 +0200 Subject: [PATCH 5/6] Fix: Add actions in bold --- src/man/kiwix-manage.1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 index ec94310..b1cc2de 100644 --- a/src/man/kiwix-manage.1 +++ b/src/man/kiwix-manage.1 @@ -6,11 +6,11 @@ kiwix\-manage \- Kiwix Library Manager .SH SYNOPSIS .IX Header SYNOPSIS .TP -\fBkiwix\-manage\fR LIBRARY_PATH add ZIM_PATH ... +\fBkiwix\-manage\fR LIBRARY_PATH \fBadd\fR ZIM_PATH ... .TP -\fBkiwix\-manage\fR LIBRARY_PATH show [ZIM_ID_1] [ZIM_ID_2] ... +\fBkiwix\-manage\fR LIBRARY_PATH \fBshow\fR [ZIM_ID_1] [ZIM_ID_2] ... .TP -\fBkiwix\-manage\fR LIBRARY_PATH remove ZIM_ID_1 [ZIM_ID_2] ... +\fBkiwix\-manage\fR LIBRARY_PATH \fBremove\fR ZIM_ID_1 [ZIM_ID_2] ... .TP \fBkiwix\-manage\fR --version .TP From dd53bef147723ee846f246c831b1cae113fa550f Mon Sep 17 00:00:00 2001 From: Emmanuel Engelhart Date: Sat, 24 Sep 2022 20:19:40 +0200 Subject: [PATCH 6/6] Fix: Create library file if necessary with 'add' action --- src/man/kiwix-manage.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 index b1cc2de..fe5d042 100644 --- a/src/man/kiwix-manage.1 +++ b/src/man/kiwix-manage.1 @@ -29,7 +29,7 @@ description, filepath, title, url, etc. .TP \fBadd\fR -Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. +Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. Create the library file if necessary. .TP \fBremove\fR