From b5bd198ffcf8022fb7617d7a2f9952385835ba73 Mon Sep 17 00:00:00 2001 From: reg_ Date: Mon, 4 Jun 2012 14:43:18 +0000 Subject: [PATCH] updated man pages --- src/man/kiwix-compact.1 | 18 +++++++++++---- src/man/kiwix-index.1 | 29 ++++++++++++++++++++++++ src/man/kiwix-install.1 | 38 +++++++++++++++++++++++++++++++ src/man/kiwix-manage.1 | 40 +++++++++++++++++++++++++++++++++ src/man/kiwix-serve.1 | 50 +++++++++++++++++++++++++++++++++++++---- src/man/kiwix.1 | 18 ++++++++++++--- 6 files changed, 182 insertions(+), 11 deletions(-) create mode 100644 src/man/kiwix-index.1 create mode 100644 src/man/kiwix-install.1 create mode 100644 src/man/kiwix-manage.1 diff --git a/src/man/kiwix-compact.1 b/src/man/kiwix-compact.1 index 3572a64..e5f449a 100644 --- a/src/man/kiwix-compact.1 +++ b/src/man/kiwix-compact.1 @@ -1,11 +1,21 @@ -.TH kiwix-compact 1 "21 May 2012" "0.1" "ZIM index compacter" +.TH KIWIX 1 "21 May 2012" .SH NAME kiwix-compact \- ZIM index compacter .SH SYNOPSIS -.B kiwix-compact +.IX Header SYNOPSIS +kiwix-compact INDEX_PATH .SH DESCRIPTION -Compacts ZIM files used by Kiwix using xapian-compact +.PP +Compacts ZIM Index files used by Kiwix using xapian-compact + +.TP +\fBZIM_PATH\fR +ZIM file path to compact. + .SH SEE ALSO -kiwix(1) kiwix-index(1) kiwix-install(1) kiwix-serve(1) kiwix-manage(1) xapian-compact(1) +kiwix(1) kiwix-index(1) kiwix-manage(1) xapian-compact(1) +.br +kiwix-install(1) kiwix-serve(1) + .SH AUTHOR Emmanuel Engelhart \ No newline at end of file diff --git a/src/man/kiwix-index.1 b/src/man/kiwix-index.1 new file mode 100644 index 0000000..c9b690a --- /dev/null +++ b/src/man/kiwix-index.1 @@ -0,0 +1,29 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +kiwix-index \- Kiwix ZIM Indexer +.SH SYNOPSIS +.IX Header SYNOPSIS +kiwix-index [--backend|-b=xapian|clucene] ZIM_PATH INDEX_PATH +.SH DESCRIPTION +.PP +Generates a xapian or clucene full-text index for a ZIM file. + +.TP +\fB\-\-backend=xapian|clucene\fR +Selects an indexing backend. + +.TP +\fBZIM_PATH\fR +ZIM file path to index. + +.TP +\fBINDEX_PATH\fR +Path to save the full-text index to. + +.SH SEE ALSO +kiwix-compact(1) kiwix-manage(1) kiwix-serve(1) +.br +kiwix(1) kiwix-install(1) + +.SH AUTHOR +Emmanuel Engelhart \ No newline at end of file diff --git a/src/man/kiwix-install.1 b/src/man/kiwix-install.1 new file mode 100644 index 0000000..7874ddc --- /dev/null +++ b/src/man/kiwix-install.1 @@ -0,0 +1,38 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +kiwix-install \- Kiwix ZIM Installer +.SH SYNOPSIS +.IX Header SYNOPSIS +kiwix-install [--verbose|-v] [--backend|-b=xapian|clucene] [--buildIndex|-i] ADDCONTENT ZIM_PATH KIWIX_PATH +.SH DESCRIPTION +.PP +Creates a standalone Kiwix + data hierarchy. +.br +If specified, also create a full-text index. + +.TP +\fB\-\-verbose\fR +Enable verbose output. + +.TP +\fB\-\-backend=xapian|clucene\fR +Selects an indexing backend. + +.TP +\fB\-\-buildIndex\fR +Whether to build an index for the ZIM file. + +.TP +\fBZIM_PATH\fR +ZIM content file path. + +.TP +\fBKIWIX_PATH\fR +Path to the kiwix/ folder. +.br +The path must contain the kiwix standalone binary. + +.SH SEE ALSO +kiwix(1) kiwix-index(1) kiwix-serve(1) kiwix-compact(1) kiwix-manage(1) +.SH AUTHOR +Emmanuel Engelhart \ No newline at end of file diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 new file mode 100644 index 0000000..f3c51bc --- /dev/null +++ b/src/man/kiwix-manage.1 @@ -0,0 +1,40 @@ +.TH KIWIX 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] +.SH DESCRIPTION +.SS kiwix\-manage +.PP +\fBkiwix\-manage\fP Tool for managing a kiwix library. +.PP +Allows to manage the content of the kiwix library. Library file is XML flat file +listing ZIM files with all necessary information like favicon, date, creator, +description, indexpath, filepath, title, source/metalink etc. +. +.PP + Example library file can be found at http://www.kiwix.org/library\.xml +.br +.TP +\fBadd\fR +add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. + +.TP +\fBshow\fR +Show the given \fBCONTENT_ID\fP from \fBLIBRARY_FILE\fR. If no \fBCONTENT_ID\fP is given then all contents from \fBLIBRARY_FILE\fR is shown. + +.TP +\fBremove\fR +Removes the given \fBCONTENT_ID\fR from \fBLIBRARY_FILE\fR. At least one \fBCONTENT_ID\fR should be specified. + +.SH SEE ALSO +kiwix(1) kiwix-index(1) kiwix-install(1) kiwix-serve(1) kiwix-compact(1) +.SH AUTHOR +Emmanuel Engelhart diff --git a/src/man/kiwix-serve.1 b/src/man/kiwix-serve.1 index 7e91bf6..77bef20 100644 --- a/src/man/kiwix-serve.1 +++ b/src/man/kiwix-serve.1 @@ -1,11 +1,53 @@ -.TH kiwix-serve 1 "21 May 2012" "0.1" "Kiwix HTTP Server" +.TH KIWIX 1 "21 May 2012" .SH NAME kiwix-serve \- Kiwix HTTP Server .SH SYNOPSIS -.B kiwix-serve +.IX Header "SYNOPSIS" +.br +kiwix-serve [--index=INDEX_PATH] [--port=PORT] [--verbose] [--daemon] [--attachToProcess=PID] ZIM_PATH +.br +kiwix-serve --library [--port=PORT] [--verbose] [--daemon] [--attachToProcess=PID] LIBRARY_PATH .SH DESCRIPTION -Serves a ZIM file or a Kiwix library over HTTP for in-browser access. +.PP +Stand-alone HTTP server for serving ZIM content over the network. + +.TP +\fB\-\-index=INDEX_PATH\fR +Path to index folder created using \fBkiwix-index\fB. + +.TP +\fB\-\-port=PORT\fR +Port number on which server should listen. +.br +By default server listens on port 80. + +.TP +\fB\-\-verbose\fR +Enable verbose output. + +.TP +\fB\-\-daemon\fR +Run the server as a daemon + +.TP +\fB\-\-attachToProcess=PID\fR +Shutdown the server when process numbered PID dies. + +.TP +\fBZIM_PATH\fR +ZIM file of the content to serve. +.br +Mandatory if not in library mode. + +.TP +\fBLIBRARY_PATH\fR +Kiwix library file path. +.br +Library is XML file created using \fBkiwix-manage\fB. + .SH SEE ALSO -kiwix(1) kiwix-index(1) kiwix-install(1) kiwix-compact(1) kiwix-manage(1) +kiwix(1) kiwix-index(1) kiwix-manage(1) +.br +kiwix-install(1) kiwix-compact(1) .SH AUTHOR Emmanuel Engelhart \ No newline at end of file diff --git a/src/man/kiwix.1 b/src/man/kiwix.1 index f93bd27..1f08219 100644 --- a/src/man/kiwix.1 +++ b/src/man/kiwix.1 @@ -1,12 +1,20 @@ -.TH kiwix 1 "21 May 2012" "0.9" "ZIM reader" +.TH KIWIX 1 "21 May 2012" .SH NAME Kiwix \- Offline ZIM file reader .SH SYNOPSIS -.B kiwix +.B kiwix [-jsconsole] .SH DESCRIPTION +.PP Kiwix allows you to read and search through offline content +.br as they were online on the Web. Similar to a browser, Kiwix works with +.br the highly compressed ZIM file format. + +.TP +\fB\-jsconsole\fR +Enables the Javascript Debug console (Xulrunner) + .PP Features: * Pure ZIM file reader @@ -19,8 +27,12 @@ Features: * ZIM file Index capacity * Tabs navigation * Content manager + .SH SEE ALSO -kiwix-index(1) kiwix-install(1) kiwix-serve(1) kiwix-compact(1) kiwix-manage(1) +kiwix-index(1) kiwix-install(1) kiwix-serve(1) +.br +kiwix-compact(1) kiwix-manage(1) + .SH AUTHORS Emmanuel Engelhart Guillaume Duhamel