kiwix/kiwix-tools
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-tools.git synced 2025-09-24 04:20:56 -04:00
Code Issues Packages Projects Releases Wiki Activity

man pages fixes

Browse Source
This commit is contained in:
reg_ 2012-06-09 13:58:47 +00:00
parent 413a6eef3c
commit 00e33f8b84
6 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/man/kiwix-compact.1
View File

@ -6,7 +6,7 @@ kiwix-compact \- ZIM index compacter
kiwix-compact INDEX_PATH kiwix-compact INDEX_PATH
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Compacts ZIM Index files used by Kiwix using xapian-compact Compacts ZIM index files used by Kiwix using xapian-compact
.TP .TP
\fBINDEX_PATH\fR \fBINDEX_PATH\fR

2
src/man/kiwix-index.1
View File

@ -10,7 +10,7 @@ Generates a xapian or clucene full-text index for a ZIM file.
.TP .TP
\fB\-\-backend=xapian|clucene\fR \fB\-\-backend=xapian|clucene\fR
Selects an indexing backend. Select an indexing backend.
.TP .TP
\fBZIM_PATH\fR \fBZIM_PATH\fR

6
src/man/kiwix-install.1
View File

@ -8,7 +8,7 @@ kiwix\-install [\-\-verbose|-v] [\-\-backend|\-b=xapian|clucene] [\-\-buildIndex
.PP .PP
Creates a standalone Kiwix + data hierarchy. Creates a standalone Kiwix + data hierarchy.
.br .br
If specified, also create a full\-text index. If specified, also creates a full\-text index.
.TP .TP
\fB\-\-verbose\fR \fB\-\-verbose\fR
@ -16,11 +16,11 @@ Enable verbose output.
.TP .TP
\fB\-\-backend=xapian|clucene\fR \fB\-\-backend=xapian|clucene\fR
Selects an indexing backend. Select an indexing backend.
.TP .TP
\fB\-\-buildIndex\fR \fB\-\-buildIndex\fR
Whether to build an index for the ZIM file. Build an index for the ZIM file.
.TP .TP
\fBZIM_PATH\fR \fBZIM_PATH\fR

14
src/man/kiwix-manage.1
View File

@ -13,9 +13,9 @@ kiwix\-manage LIBRARY_PATH add ZIM_PATH ...
.SH DESCRIPTION .SH DESCRIPTION
.SS kiwix\-manage .SS kiwix\-manage
.PP .PP
\fBkiwix\-manage\fP Tool for managing a kiwix library. \fBkiwix\-manage\fP tool for managing a kiwix library.
.PP .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, listing ZIM files with all necessary information like favicon, date, creator,
description, indexpath, filepath, title, source/metalink etc. description, indexpath, filepath, title, source/metalink etc.
. .
@ -24,15 +24,15 @@ description, indexpath, filepath, title, source/metalink etc.
.br .br
.TP .TP
\fBadd\fR \fBadd\fR
add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP.
.TP .TP
\fBshow\fR \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 .TP
\fBremove\fR \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 .TP
\fB\-\-zimPathToSave=\fR \fB\-\-zimPathToSave=\fR
@ -44,7 +44,7 @@ Mark this content as the current (default) content in the library.
.TP .TP
\fB\-\-backend=xapian|clucene\fR \fB\-\-backend=xapian|clucene\fR
Selects an indexing backend. Select an indexing backend.
.TP .TP
\fB\-\-indexPath=FULLTEXT_IDX_PATH\fR \fB\-\-indexPath=FULLTEXT_IDX_PATH\fR
@ -52,7 +52,7 @@ Path to full-text index for that ZIM file.
.TP .TP
\fBurl\fR \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 .SH SEE ALSO
kiwix(1) kiwix\-index(1) kiwix\-install(1) kiwix\-serve(1) kiwix\-compact(1) kiwix(1) kiwix\-index(1) kiwix\-install(1) kiwix\-serve(1) kiwix\-compact(1)

4
src/man/kiwix-serve.1
View File

@ -17,9 +17,9 @@ Path to index folder created using \fBkiwix-index\fB.
.TP .TP
\fB\-\-port=PORT\fR \fB\-\-port=PORT\fR
Port number on which server should listen. Port number on which the server should listen.
.br .br
By default server listens on port 80. By default, server listens on port 80.
.TP .TP
\fB\-\-verbose\fR \fB\-\-verbose\fR

10
src/man/kiwix.1
View File

@ -5,15 +5,15 @@ Kiwix \- Offline ZIM file reader
.B kiwix [-jsconsole] .B kiwix [-jsconsole]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Kiwix allows you to read and search through offline content Kiwix is an offline content reader for the ZIM format.
.br .br
as they were online on the Web. Similar to a browser, Kiwix works with ZIM files are compressed content (usually HTML) archives.
.br .br
the highly compressed ZIM file format. Most popular ZIM includes Wikipedia and Wikileaks.
.TP .TP
\fB\-jsconsole\fR \fB\-jsconsole\fR
Enables the Javascript Debug console (Xulrunner) Enable the Javascript Debug console (Xulrunner)
.PP .PP
Features: Features:
@ -39,5 +39,5 @@ kiwix-compact(1) kiwix-manage(1)
Fabien Coullon <fcoulon@linterweb.com> Fabien Coullon <fcoulon@linterweb.com>
Renaud Gaudin <rgaudin@gmail.com> Renaud Gaudin <rgaudin@gmail.com>
Wilfredo Rodriguez <wilfredor@kiwix.org> Wilfredo Rodriguez <wilfredor@kiwix.org>
.br .br
Vasudev Kamath <kamathvasudev@gmail.com> (Manual) Vasudev Kamath <kamathvasudev@gmail.com> (Manual)