update changelog
[fanfix.git] / README-fr.md
... / ...
CommitLineData
1[English](README.md) Français
2
3# Fanfix
4Fanfix est un petit programme Java qui peut télécharger des histoires sur internet et les afficher hors ligne.
5
6## Synopsis
7
8- ```fanfix``` --import [*URL*]
9- ```fanfix``` --export [*id*] [*output_type*] [*target*]
10- ```fanfix``` --convert [*URL*] [*output_type*] [*target*] (+info)
11- ```fanfix``` --read [*id*] ([*chapter number*])
12- ```fanfix``` --read-url [*URL*] ([*chapter number*])
13- ```fanfix``` --search
14- ```fanfix``` --search [*where*] [*keywords*] (page [*page*]) (item [*item*])
15- ```fanfix``` --tag
16- ```fanfix``` --tag [*index 1*]... (page [*page*]) (item [*item*])
17- ```fanfix``` --list
18- ```fanfix``` --set-reader [*GUI* | *TUI* | *CLI*]
19- ```fanfix``` --server [*key*] [*port*]
20- ```fanfix``` --stop-server [*key*] [*port*]
21- ```fanfix``` --remote [*key*] [*host*] [*port*]
22- ```fanfix``` --help
23
24## Description
25
26(Si vous voulez juste voir les derniers changements, vous pouvez regarder le [Changelog](changelog-fr.md) -- remarquez que le programme affiche le changelog si une version plus récente est détectée depuis la version 1.4.0.)
27
28(Il y a aussi une [TODO list](TODO.md) sur le site parlant du futur du programme.)
29
30![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
31
32Une gallerie de screenshots est disponible [ici](screenshots/README-fr.md).
33
34Le fonctionnement du programme est assez simple : il converti une URL venant d'un site supporté en un fichier .epub pour les histoires ou .cbz pour les comics (d'autres options d'enregistrement sont disponibles, comme du texte simple, du HTML...)
35
36Pour vous aider à organiser vos histoires, il peut aussi servir de bibliothèque locale vous permettant :
37
38- d'importer une histoire depuis son URL (ou depuis un fichier)
39- d'exporter une histoire dans un des formats supportés vers un fichier
40- d'afficher une histoire en mode texte
41- d'afficher une histoire en mode GUI **nativement** ou **en appelant un programme natif pour lire le fichier** (potentiellement converti en HTML avant, pour que n'importe quel navigateur web puisse l'afficher)
42
43### Sites supportés
44
45Pour le moment, les sites suivants sont supportés :
46
47- http://FimFiction.net/ : fanfictions dévouées à la série My Little Pony
48- http://Fanfiction.net/ : fanfictions venant d'une multitude d'univers différents, depuis les shows télévisés aux livres en passant par les jeux-vidéos
49- http://mangafox.me/ : un site répertoriant une quantité non négligeable de mangas
50- https://e621.net/ : un site Furry proposant des comics, y compris de MLP
51- https://sofurry.com/ : même chose, mais orienté sur les histoires plutôt que les images
52- https://e-hentai.org/ : support ajouté sur demande : n'hésitez pas à demander un site !
53- http://mangas-lecture-en-ligne.fr/ : un site proposant beaucoup de mangas, en français
54
55### Types de fichiers supportés
56
57Nous supportons les types de fichiers suivants (aussi bien en entrée qu'en sortie) :
58
59- epub : les fichiers .epub créés avec Fanfix (nous ne supportons pas les autres fichiers .epub, du moins pour le moment)
60- text : les histoires enregistrées en texte (.txt), avec quelques règles spécifiques :
61 - le titre doit être sur la première ligne
62 - l'auteur (précédé de rien, ```Par ```, ```De ``` ou ```©```) doit être sur la deuxième ligne, optionnellement suivi de la date de publication entre parenthèses (i.e., ```Par Quelqu'un (3 octobre 1998)```)
63 - les chapitres doivent être déclarés avec ```Chapitre x``` ou ```Chapitre x: NOM DU CHAPTITRE```, où ```x``` est le numéro du chapitre
64 - une description de l'histoire doit être donnée en tant que chaptire 0
65 - une image de couverture peut être présente avec le même nom de fichier que l'histoire, mais une extension .png, .jpeg ou .jpg
66- info_text : fort proche du format texte, mais avec un fichier .info accompagnant l'histoire pour y enregistrer quelques metadata (le fichier de metadata est supposé être créé par Fanfix, ou être compatible avec)
67- cbz : les fichiers .cbz (une collection d'images zipées), de préférence créés avec Fanfix (même si les autres .cbz sont aussi supportés, mais sans la majorité des metadata de Fanfix dans ce cas)
68- html : les fichiers HTML que vous pouvez ouvrir avec n'importe quel navigateur ; remarquez que Fanfix créera un répertoire pour y mettre les fichiers nécessaires, dont un fichier ```index.html``` pour afficher le tout -- nous ne supportons en entrée que les fichiers HTML créés par Fanfix
69
70### Plateformes supportées
71
72Toute plateforme supportant Java 1.6 devrait suffire.
73
74Le programme a été testé sur Linux (Debian, Slackware et Ubuntu), MacOS X et Windows pour le moment, mais n'hésitez pas à nous informer si vous l'essayez sur un autre système.
75
76Si vous avez des difficultés pour le compiler avec une version supportée de Java (1.6+), contactez-nous.
77
78## Options
79
80Vous pouvez démarrer le programme en mode graphique (comme dans le screenshot en haut) :
81
82- ```java -jar fanfix.jar```
83- ```fanfix``` (si vous avez utilisé *make install*)
84
85Les arguments suivants sont aussi supportés :
86
87- ```--import [URL]```: importer une histoire dans la librairie
88- ```--export [id] [output_type] [target]```: exporter l'histoire "id" vers le fichier donné
89- ```--convert [URL] [output_type] [target] (+info)```: convertir l'histoire vers le fichier donné, et forcer l'ajout d'un fichier .info si +info est utilisé
90- ```--read [id] ([chapter number])```: afficher l'histoire "id"
91- ```--read-url [URL] ([chapter number])```: convertir l'histoire et la lire à la volée, sans la sauver
92- ```--search```: liste les sites supportés (```where```)
93- ```--search [where] [keywords] (page [page]) (item [item])```: lance une recherche et affiche les résultats de la page ```page``` (page 1 par défaut), et de l'item ```item``` spécifique si demandé
94- ```--tag [where]```: liste tous les tags supportés par ce site web
95- ```--tag [index 1]... (page [page]) (item [item])```: affine la recherche, tag par tag, et affiche si besoin les sous-tags, les histoires ou les infos précises de l'histoire demandée
96- ```--list```: lister les histoires presentes dans la librairie et leurs IDs
97- ```--set-reader [reader type]```: changer le type de lecteur pour la commande en cours sur CLI, TUI ou GUI
98- ```--server [key] [port]```: démarrer un serveur d'histoires sur ce port
99- ```--stop-server [key] [port]```: arrêter le serveur distant sur ce port (key doit avoir la même valeur)
100- ```--remote [key] [host] [port]```: contacter ce server au lieu de la librairie habituelle (key doit avoir la même valeur)
101- ```--help```: afficher la liste des options disponibles
102- ```--version```: retourne la version du programme
103
104### Environnement
105
106Certaines variables d'environnement sont reconnues par le programme :
107
108- ```LANG=en```: forcer la langue du programme en anglais
109- ```CONFIG_DIR=$HOME/.fanfix```: utilise ce répertoire pour les fichiers de configuration du programme (et copie les fichiers de configuration par défaut si besoin)
110- ```NOUTF=1```: essaye d'utiliser des caractères non-unicode quand possible (cela peut avoir un impact sur les fichiers générés, pas uniquement sur les messages à l'utilisateur)
111- ```DEBUG=1```: force l'option ```DEBUG=true``` du fichier de configuration (pour afficher plus d'information en cas d'erreur)
112
113## Compilation
114
115```./configure.sh && make```
116
117Vous pouvez aussi importer les sources java dans, par exemple, [Eclipse](https://eclipse.org/), et faire un JAR exécutable depuis celui-ci.
118
119Quelques tests unitaires sont disponibles :
120
121```./configure.sh && make build test run-test```
122
123### Librairies dépendantes (incluses)
124
125Nécessaires :
126
127- ```libs/nikiroo-utils-sources.jar```: quelques utilitaires partagés
128- [```libs/unbescape-sources.jar```](https://github.com/unbescape/unbescape): une librairie sympathique pour convertir du texte depuis/vers beaucoup de formats ; utilisée ici pour la partie HTML
129- [```libs/jsoup-sources.jar```](https://jsoup.org/): une libraririe pour parser du HTML
130
131Optionnelles :
132
133- [```libs/jexer-sources.jar```](https://github.com/klamonte/jexer): une petite librairie qui offre des widgets en mode TUI
134- [```pandoc```](http://pandoc.org/): pour générer les man pages depuis les fichiers README
135
136Rien d'autre, si ce n'est Java 1.6+.
137
138À noter : ```make libs``` exporte ces librairies dans le répertoire src/.
139
140## Auteur
141
142Fanfix a été écrit par Niki Roo <niki@nikiroo.be>
143