change search syntax
[fanfix.git] / src / be / nikiroo / fanfix / bundles / Config.java
1 package be.nikiroo.fanfix.bundles;
2
3 import be.nikiroo.utils.resources.Meta;
4 import be.nikiroo.utils.resources.Meta.Format;
5
6 /**
7 * The configuration options.
8 *
9 * @author niki
10 */
11 @SuppressWarnings("javadoc")
12 public enum Config {
13 @Meta(description = "language (example: en-GB, fr-BE...) or nothing for default system language", format = Format.LOCALE, info = "Force the language (can be overwritten again with the env variable $LANG)")
14 LANG, //
15 @Meta(description = "reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)", format = Format.FIXED_LIST, list = {
16 "CLI", "GUI", "TUI" }, info = "Select the default reader to use to read stories")
17 READER_TYPE, //
18 @Meta(def = "INFO_TEXT", format = Format.COMBO_LIST, list = { "INFO_TEXT",
19 "EPUB", "HTML", "TEXT" }, info = "One of the known output type", description = "The type of output for the Local Reader for non-images documents")
20 NON_IMAGES_DOCUMENT_TYPE, //
21 @Meta(def = "CBZ", format = Format.COMBO_LIST, list = { "CBZ", "HTML" }, description = "The type of output for the Local Reader for images documents")
22 IMAGES_DOCUMENT_TYPE, //
23 @Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)")
24 CACHE_DIR, //
25 @Meta(def = "24", description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh")
26 CACHE_MAX_TIME_CHANGING, //
27 @Meta(def = "720", description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh")
28 CACHE_MAX_TIME_STABLE, //
29 @Meta(def = "Mozilla/5.0 (X11; Linux x86_64; rv:44.0) Gecko/20100101 Firefox/44.0 -- ELinks/0.9.3 (Linux 2.6.11 i686; 80x24)", description = "string", info = "The user-agent to use to download files")
30 USER_AGENT, //
31 @Meta(def = "$HOME/.fanfix/covers/", description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to get the default story covers")
32 DEFAULT_COVERS_DIR, //
33 @Meta(description = "string", info = "The default library to use (KEY:SERVER:PORT), or empty for the local library")
34 DEFAULT_LIBRARY, //
35 @Meta(def = "$HOME/Books", description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store the library")
36 LIBRARY_DIR, //
37 @Meta(def = "false", description = "boolean", format = Format.BOOLEAN, info = "Show debug information on errors")
38 DEBUG_ERR, //
39 @Meta(def = "false", description = "boolean", format = Format.BOOLEAN, info = "Show debug trace information")
40 DEBUG_TRACE, //
41 @Meta(def = "PNG", description = "image format", format = Format.COMBO_LIST, list = {
42 "PNG", "JPG", "BMP" }, info = "Image format to use for cover images")
43 IMAGE_FORMAT_COVER, //
44 @Meta(def = "JPG", description = "image format", format = Format.COMBO_LIST, list = {
45 "PNG", "JPG", "BMP" }, info = "Image format to use for content images")
46 IMAGE_FORMAT_CONTENT, //
47 @Meta(group = true)
48 LATEX_LANG, //
49 @Meta(def = "english", description = "LaTeX output language: English", info = "LaTeX full name")
50 LATEX_LANG_EN, //
51 @Meta(def = "french", description = "LaTeX output language: French", info = "LaTeX full name")
52 LATEX_LANG_FR, //
53 @Meta(def = "by,par,de,©,(c)", description = "other 'by' prefixes before author name, used to identify the author", array = true)
54 BYS, //
55 @Meta(def = "EN,FR", description = "List of languages codes used for chapter identification (should not be changed)", array = true, info = "EN,FR")
56 CHAPTER, //
57 @Meta(def = "Chapter", description = "Chapter identification String: English", info = "used to identify a starting chapter in text mode")
58 CHAPTER_EN, //
59 @Meta(def = "Chapitre", description = "Chapter identification String: French", info = "used to identify a starting chapter in text mode")
60 CHAPTER_FR, //
61 @Meta(description = "Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)")
62 LOGIN_YIFFSTAR_USER, //
63 @Meta(description = "Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)", format = Format.PASSWORD)
64 LOGIN_YIFFSTAR_PASS, //
65 @Meta(description = "If the last update check was done at least that many days, check for updates at startup (-1 for 'no checks' -- default is 1 day)", format = Format.INT)
66 UPDATE_INTERVAL, //
67 @Meta(def = "", description = "", info = "Format is ((user(:pass)@)proxy:port), with ':' being system proxy and an empty String being no proxy")
68 USE_PROXY,
69 @Meta(description = "An API key required to create a token from FimFiction", format = Format.STRING)
70 LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
71 @Meta(description = "An API key required to create a token from FimFiction", format = Format.PASSWORD)
72 LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, //
73 @Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping (default is false, use API if token or ID present)", format = Format.BOOLEAN)
74 LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
75 @Meta(def = "Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D", description = "A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)", format = Format.PASSWORD)
76 LOGIN_FIMFICTION_APIKEY_TOKEN, //
77 }