From 00e33f8b8433e935a23706bf59ff9fa381a7b0d1 Mon Sep 17 00:00:00 2001 From: reg_ Date: Sat, 9 Jun 2012 13:58:47 +0000 Subject: [PATCH] man pages fixes --- src/man/kiwix-compact.1 | 2 +- src/man/kiwix-index.1 | 2 +- src/man/kiwix-install.1 | 6 +++--- src/man/kiwix-manage.1 | 14 +++++++------- src/man/kiwix-serve.1 | 4 ++-- src/man/kiwix.1 | 10 +++++----- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/man/kiwix-compact.1 b/src/man/kiwix-compact.1 index 8c4e0a2..04729e6 100644 --- a/src/man/kiwix-compact.1 +++ b/src/man/kiwix-compact.1 @@ -6,7 +6,7 @@ kiwix-compact \- ZIM index compacter kiwix-compact INDEX_PATH .SH DESCRIPTION .PP -Compacts ZIM Index files used by Kiwix using xapian-compact +Compacts ZIM index files used by Kiwix using xapian-compact .TP \fBINDEX_PATH\fR diff --git a/src/man/kiwix-index.1 b/src/man/kiwix-index.1 index bf7d1b4..c411fcb 100644 --- a/src/man/kiwix-index.1 +++ b/src/man/kiwix-index.1 @@ -10,7 +10,7 @@ Generates a xapian or clucene full-text index for a ZIM file. .TP \fB\-\-backend=xapian|clucene\fR -Selects an indexing backend. +Select an indexing backend. .TP \fBZIM_PATH\fR diff --git a/src/man/kiwix-install.1 b/src/man/kiwix-install.1 index c5f88c6..f04dc12 100644 --- a/src/man/kiwix-install.1 +++ b/src/man/kiwix-install.1 @@ -8,7 +8,7 @@ kiwix\-install [\-\-verbose|-v] [\-\-backend|\-b=xapian|clucene] [\-\-buildIndex .PP Creates a standalone Kiwix + data hierarchy. .br -If specified, also create a full\-text index. +If specified, also creates a full\-text index. .TP \fB\-\-verbose\fR @@ -16,11 +16,11 @@ Enable verbose output. .TP \fB\-\-backend=xapian|clucene\fR -Selects an indexing backend. +Select an indexing backend. .TP \fB\-\-buildIndex\fR -Whether to build an index for the ZIM file. +Build an index for the ZIM file. .TP \fBZIM_PATH\fR diff --git a/src/man/kiwix-manage.1 b/src/man/kiwix-manage.1 index 060c495..aed3d27 100644 --- a/src/man/kiwix-manage.1 +++ b/src/man/kiwix-manage.1 @@ -13,9 +13,9 @@ kiwix\-manage LIBRARY_PATH add ZIM_PATH ... .SH DESCRIPTION .SS kiwix\-manage .PP -\fBkiwix\-manage\fP Tool for managing a kiwix library. +\fBkiwix\-manage\fP tool for managing a kiwix library. .PP -Allows one to manage the content of the kiwix library. Library file is XML flat file +Allows one to manage the content of the kiwix library. Library file is an XML flat file listing ZIM files with all necessary information like favicon, date, creator, description, indexpath, filepath, title, source/metalink etc. . @@ -24,15 +24,15 @@ description, indexpath, filepath, title, source/metalink etc. .br .TP \fBadd\fR -add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. +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. +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. .TP \fBremove\fR -Removes the given \fBCONTENT_ID\fR from \fBLIBRARY_FILE\fR. At least one \fBCONTENT_ID\fR should be specified. +Remove the given \fBCONTENT_ID\fR from \fBLIBRARY_FILE\fR. At least one \fBCONTENT_ID\fR should be specified. .TP \fB\-\-zimPathToSave=\fR @@ -44,7 +44,7 @@ Mark this content as the current (default) content in the library. .TP \fB\-\-backend=xapian|clucene\fR -Selects an indexing backend. +Select an indexing backend. .TP \fB\-\-indexPath=FULLTEXT_IDX_PATH\fR @@ -52,7 +52,7 @@ Path to full-text index for that ZIM file. .TP \fBurl\fR -Sets the content location of the ZIM file over the network for in\-kiwix download. +Set the content location of the ZIM file over the network for in\-kiwix download. .SH SEE ALSO kiwix(1) kiwix\-index(1) kiwix\-install(1) kiwix\-serve(1) kiwix\-compact(1) diff --git a/src/man/kiwix-serve.1 b/src/man/kiwix-serve.1 index bfed489..eb3eadc 100644 --- a/src/man/kiwix-serve.1 +++ b/src/man/kiwix-serve.1 @@ -17,9 +17,9 @@ Path to index folder created using \fBkiwix-index\fB. .TP \fB\-\-port=PORT\fR -Port number on which server should listen. +Port number on which the server should listen. .br -By default server listens on port 80. +By default, server listens on port 80. .TP \fB\-\-verbose\fR diff --git a/src/man/kiwix.1 b/src/man/kiwix.1 index 90a12ec..c72d98c 100644 --- a/src/man/kiwix.1 +++ b/src/man/kiwix.1 @@ -5,15 +5,15 @@ Kiwix \- Offline ZIM file reader .B kiwix [-jsconsole] .SH DESCRIPTION .PP -Kiwix allows you to read and search through offline content +Kiwix is an offline content reader for the ZIM format. .br -as they were online on the Web. Similar to a browser, Kiwix works with +ZIM files are compressed content (usually HTML) archives. .br -the highly compressed ZIM file format. +Most popular ZIM includes Wikipedia and Wikileaks. .TP \fB\-jsconsole\fR -Enables the Javascript Debug console (Xulrunner) +Enable the Javascript Debug console (Xulrunner) .PP Features: @@ -39,5 +39,5 @@ kiwix-compact(1) kiwix-manage(1) Fabien Coullon Renaud Gaudin Wilfredo Rodriguez - .br +.br Vasudev Kamath (Manual) \ No newline at end of file