diff --git a/src/man/kiwix-compact.fr.1 b/src/man/kiwix-compact.fr.1 new file mode 100644 index 0000000..ce1475a --- /dev/null +++ b/src/man/kiwix-compact.fr.1 @@ -0,0 +1,23 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +kiwix-compact \- Compacteur d'index pour fichier ZIM +.SH SYNOPSIS +.IX Header SYNOPSIS +kiwix-compact INDEX_PATH +.SH DESCRIPTION +.PP +Compacte les fichiers d'index des ZIM à l'aide de xapian-compact. + +.TP +\fBINDEX_PATH\fR +Chemin de l'index plein texte à compacter. + +.SH SEE ALSO +kiwix(1) kiwix-index(1) kiwix-manage(1) xapian-compact(1) +.br +kiwix-install(1) kiwix-serve(1) + +.SH AUTHOR +Emmanuel Engelhart +.br +Vasudev Kamath (Manual) \ No newline at end of file diff --git a/src/man/kiwix-index.fr.1 b/src/man/kiwix-index.fr.1 new file mode 100644 index 0000000..a40edff --- /dev/null +++ b/src/man/kiwix-index.fr.1 @@ -0,0 +1,31 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +kiwix\-index \- Indexeur de fichiers ZIM +.SH SYNOPSIS +.IX Header SYNOPSIS +kiwix\-index [\-\-backend|\-b=xapian|clucene] ZIM_PATH INDEX_PATH +.SH DESCRIPTION +.PP +Génère un index plein texte xapian ou cLucene pour un fichier ZIM. + +.TP +\fB\-\-backend=xapian|clucene\fR +Séléctionne un moteur d'indexation. + +.TP +\fBZIM_PATH\fR +Chemin du fichier ZIM à indexer. + +.TP +\fBINDEX_PATH\fR +Chemin où enregistrer l'index plein texte. + +.SH SEE ALSO +kiwix\-compact(1) kiwix\-manage(1) kiwix\-serve(1) +.br +kiwix(1) kiwix\-install(1) + +.SH AUTHOR +Emmanuel Engelhart +.br +Vasudev Kamath (Manual) \ No newline at end of file diff --git a/src/man/kiwix-install.fr.1 b/src/man/kiwix-install.fr.1 new file mode 100644 index 0000000..ce52986 --- /dev/null +++ b/src/man/kiwix-install.fr.1 @@ -0,0 +1,40 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +kiwix\-install \- Installeur de fichiers ZIM +.SH SYNOPSIS +.IX Header SYNOPSIS +kiwix\-install [\-\-verbose|-v] [\-\-backend|\-b=xapian|clucene] [\-\-buildIndex|\-i] addcontent ZIM_PATH KIWIX_PATH +.SH DESCRIPTION +.PP +Créé une arborescence contenant Kiwix et des données pour redistribution. +.br +Si demandé, créé aussi un index plein texte. + +.TP +\fB\-\-verbose\fR +Active le mode verbeux de la sortie. + +.TP +\fB\-\-backend=xapian|clucene\fR +Séléctionne un moteur d'indexation. + +.TP +\fB\-\-buildIndex\fR +Créer un index plein texte pour le fichier ZIM. + +.TP +\fBZIM_PATH\fR +Chemin du fichier de contenu ZIM. + +.TP +\fBKIWIX_PATH\fR +Chemin d'accès dossier kiwix/. +.br +Le chemin doit contenit le binaire statique de Kiwix. + +.SH SEE ALSO +kiwix(1) kiwix\-index(1) kiwix\-serve(1) kiwix\-compact(1) kiwix\-manage(1) +.SH AUTHOR +Emmanuel Engelhart +.br +Vasudev Kamath (Manual) \ No newline at end of file diff --git a/src/man/kiwix-manage.fr.1 b/src/man/kiwix-manage.fr.1 new file mode 100644 index 0000000..577bae8 --- /dev/null +++ b/src/man/kiwix-manage.fr.1 @@ -0,0 +1,64 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +kiwix\-manage \- Gestionnaire de bibliothèque Kiwix +.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 +Permet de gérer les contenus de la bibliothèque Kiwix. La bibliothèque est un fichier +XML référencant les contenus ZIM et leurs méta-donnnées: Index, icone, date, etc. + +. +.PP +Un fichier d'exemple est disponible à http://www.kiwix.org/library\.xml + +.TP +\fBadd\fR +Ajoute le fichier \fBZIM_FILE\fP à la bibliothèque \fBLIBRARY_FILE\fP. + +.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. +Affiche les détails de \fBCONTENT_ID\fP dans la bibliothèque \fBLIBRARY_FILE\fR. +.br +Sans \fBCONTENT_ID\fP, tous les contenus sont affichés. + +.TP +\fBremove\fR +Supprime le contenu \fBCONTENT_ID\fR de la bibliothèque. Au moins un \fBCONTENT_ID\fR doit être spécifié. + +.TP +\fB\-\-zimPathToSave=\fR +Change le chemin de référence du fichier ZIM dans la bibliothèque. + +.TP +\fB\-\-current\fR +Marque ce contenu comme celui courant (contenu par défaut) dans la biliothèque. + +.TP +\fB\-\-backend=xapian|clucene\fR +Séléctionne un moteur d'indexation. + +.TP +\fB\-\-indexPath=FULLTEXT_IDX_PATH\fR +Chemin vers l'index plein texte correspondant au fichier ZIM. + +.TP +\fBurl\fR +Définit l'adresse URL corresponsant au fichier ZIM pour pouvoir être téléchargé depuis Kiwix. + +.SH SEE ALSO +kiwix(1) kiwix\-index(1) kiwix\-install(1) kiwix\-serve(1) kiwix\-compact(1) +.SH AUTHOR +Emmanuel Engelhart +.br +Vasudev Kamath (Manual) \ No newline at end of file diff --git a/src/man/kiwix-serve.1 b/src/man/kiwix-serve.1 index eb3eadc..3dfe9fa 100644 --- a/src/man/kiwix-serve.1 +++ b/src/man/kiwix-serve.1 @@ -39,6 +39,12 @@ ZIM file of the content to serve. .br Mandatory if not in library mode. +.TP +\fB\-\-library\fR +Enable library mode. +.br +Serves the contents of a library file instead of a single ZIM file. + .TP \fBLIBRARY_PATH\fR Kiwix library file path. diff --git a/src/man/kiwix-serve.fr.1 b/src/man/kiwix-serve.fr.1 new file mode 100644 index 0000000..3670de7 --- /dev/null +++ b/src/man/kiwix-serve.fr.1 @@ -0,0 +1,61 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +kiwix\-serve \- Serveur Web Kiwix +.SH SYNOPSIS +.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 +.PP +Serveur Web (HTTP) autonome pour diffuser des contenus ZIM sur le réseau. + +.TP +\fB\-\-index=INDEX_PATH\fR +Chemin vers l'index plein text du fichier ZIM. + +.TP +\fB\-\-port=PORT\fR +Port sur lequel le serveur doit écouter. +.br +Par défaut, le serveur écoute sur le port 80. + +.TP +\fB\-\-verbose\fR +Active le mode verbeux de la sortie. + +.TP +\fB\-\-daemon\fR +Execute le serveur en mode démon. + +.TP +\fB\-\-attachToProcess=PID\fR +Arrêter le serveur lorsque que le processus PID meurt. + +.TP +\fBZIM_PATH\fR +Chemin vers le fichier ZIM à diffuser. +.br +Obligatoire en dehors du mode bibliothèque. + +.TP +\fB\-\-library\fR +Active le mode bibliothèque. +.br +Sert les contenus d'une bibliothèque Kiwix au lieu d'un seul fichier ZIM. + +.TP +\fBLIBRARY_PATH\fR +Chemin vers le fichier bibliothèque de Kiwix. +.br +Le fichier bibliothèque est un fichier XML créé avec \fBkiwix-manage\fB. + +.SH SEE ALSO +kiwix(1) kiwix\-index(1) kiwix\-manage(1) +.br +kiwix\-install(1) kiwix\-compact(1) +.SH AUTHOR +Emmanuel Engelhart +.br +Vasudev Kamath (Manual) \ No newline at end of file diff --git a/src/man/kiwix.fr.1 b/src/man/kiwix.fr.1 new file mode 100644 index 0000000..b061b50 --- /dev/null +++ b/src/man/kiwix.fr.1 @@ -0,0 +1,43 @@ +.TH KIWIX 1 "21 May 2012" +.SH NAME +Kiwix \- Lecteur hors-ligne de fichiers ZIM +.SH SYNOPSIS +.B kiwix [-jsconsole] +.SH DESCRIPTION +.PP +Kiwix est un lecteur de content au format ZIM. +.br +Les fichiers ZIM sont des archives de contenus compressés (généralement HTML) +.br +Les fichiers ZIM les plus populaires sont ceux de Wikipédia et Wikileaks. + +.TP +\fB\-jsconsole\fR +Active la console de debogage JavaScript de Xulrunner. + +.PP +Fonctionnalités: + * Lecteur de ZIM natif + * Moteur de recherche plein texte. + * Signets et Notes + * Serveur Web pour diffuser les fichiers ZIM sur le réseau. + * Export HTML et PDF. + * Traduits dans de nombreuses langues. + * Suggestions de recherche. + * Indexation des fichiers ZIM. + * Onglets de navigation. + * Bibliothèque de contenus intégrée. + +.SH SEE ALSO +kiwix-index(1) kiwix-install(1) kiwix-serve(1) +.br +kiwix-compact(1) kiwix-manage(1) + +.SH AUTHORS + Emmanuel Engelhart + Guillaume Duhamel + Fabien Coullon + Renaud Gaudin + Wilfredo Rodriguez +.br +Vasudev Kamath (Manual) \ No newline at end of file