doc
[nikiroo-utils.git] / bundles / config.properties
1 # Configuration options
2 #
3
4
5 # language (example: en-GB, fr-BE...) or nothing for default system language
6 # (FORMAT: LOCALE) Force the language (can be overwritten again with the env variable $LANG)
7 LANG =
8 # reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)
9 # (FORMAT: FIXED_LIST) Select the default reader to use to read stories
10 # ALLOWED VALUES: "CLI" "GUI" "TUI"
11 READER_TYPE =
12 # The type of output for the Local Reader for non-images documents
13 # (FORMAT: COMBO_LIST) One of the known output type
14 # ALLOWED VALUES: "INFO_TEXT" "EPUB" "HTML" "TEXT"
15 NON_IMAGES_DOCUMENT_TYPE = INFO_TEXT
16 # The type of output for the Local Reader for images documents
17 # (FORMAT: COMBO_LIST)
18 # ALLOWED VALUES: "CBZ" "HTML"
19 IMAGES_DOCUMENT_TYPE = CBZ
20 # absolute path, $HOME variable supported, / is always accepted as dir separator
21 # (FORMAT: DIRECTORY) The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)
22 CACHE_DIR =
23 # delay in hours, or 0 for no cache, or -1 for infinite time (default)
24 # (FORMAT: INT) The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh
25 CACHE_MAX_TIME_CHANGING = 24
26 # delay in hours, or 0 for no cache, or -1 for infinite time (default)
27 # (FORMAT: INT) 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 = 720
29 # string (FORMAT: STRING) The user-agent to use to download files
30 USER_AGENT = 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)
31 # absolute path, $HOME variable supported, / is always accepted as dir separator
32 # (FORMAT: DIRECTORY) The directory where to get the default story covers
33 DEFAULT_COVERS_DIR = $HOME/bin/epub/
34 # absolute path, $HOME variable supported, / is always accepted as dir separator
35 # (FORMAT: DIRECTORY) The directory where to store the library
36 LIBRARY_DIR = $HOME/Books
37 # boolean (FORMAT: BOOLEAN) Show debug information on errors
38 DEBUG_ERR = false
39 # boolean (FORMAT: BOOLEAN) Show debug trace information
40 DEBUG_TRACE = false
41 # image format (FORMAT: COMBO_LIST) Image format to use for cover images
42 # ALLOWED VALUES: "PNG" "JPG" "BMP"
43 IMAGE_FORMAT_COVER = png
44 # image format (FORMAT: COMBO_LIST) Image format to use for content images
45 # ALLOWED VALUES: "PNG" "JPG" "BMP"
46 IMAGE_FORMAT_CONTENT = png
47 # This item is used as a group, its content is not expected to be used.
48 LATEX_LANG =
49 # LaTeX output language: English
50 # (FORMAT: STRING) LaTeX full name
51 LATEX_LANG_EN = english
52 # LaTeX output language: French
53 # (FORMAT: STRING) LaTeX full name
54 LATEX_LANG_FR = french
55 # other 'by' prefixes before author name, used to identify the author
56 # (FORMAT: STRING)
57 # (This item accept a list of comma-separated values)
58 BYS = by,par,de,©,(c)
59 # List of languages codes used for chapter identification (should not be changed)
60 # (FORMAT: STRING) EN,FR
61 # (This item accept a list of comma-separated values)
62 CHAPTER = EN,FR
63 # Chapter identification String: English
64 # (FORMAT: STRING) used to identify a starting chapter in text mode
65 CHAPTER_EN = Chapter
66 # Chapter identification String: French
67 # (FORMAT: STRING) used to identify a starting chapter in text mode
68 CHAPTER_FR = Chapitre
69 # Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)
70 # (FORMAT: STRING)
71 LOGIN_YIFFSTAR_USER =
72 # Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)
73 # (FORMAT: PASSWORD)
74 LOGIN_YIFFSTAR_PASS =
75 # 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)
76 # (FORMAT: INT)
77 UPDATE_INTERVAL =
78 # An API key required to create a token from FimFiction
79 # (FORMAT: STRING)
80 LOGIN_FIMFICTION_APIKEY_CLIENT_ID =
81 # An API key required to create a token from FimFiction
82 # (FORMAT: PASSWORD)
83 LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET =
84 # 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)
85 # (FORMAT: BOOLEAN)
86 LOGIN_FIMFICTION_APIKEY_FORCE_HTML =
87 # A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)
88 # (FORMAT: PASSWORD)
89 LOGIN_FIMFICTION_APIKEY_TOKEN = Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D