X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Fbundles%2Fconfig.properties;h=d03fc611714dda56d3e7daf8969c906eba83eaca;hb=f59eafefdd1484e2b0940713cd46205154ad3a0c;hp=79f2ac9c67701a5dc5c28b795eb9ac3d68d80903;hpb=3727aae2b0516c5ed5366cde29544565f1d6c6b0;p=fanfix.git

diff --git a/src/be/nikiroo/fanfix/bundles/config.properties b/src/be/nikiroo/fanfix/bundles/config.properties
index 79f2ac9..d03fc61 100644
--- a/src/be/nikiroo/fanfix/bundles/config.properties
+++ b/src/be/nikiroo/fanfix/bundles/config.properties
@@ -2,60 +2,110 @@
 #
 
 
-# (WHAT: language, FORMAT: language (example: en-GB) or nothing for default system language)
-# Force the language (can be overwritten again with the env variable $LANG)
+# language (example: en-GB, fr-BE...) or nothing for default system language
+# (FORMAT: LOCALE) Force the language (can be overwritten again with the env variable $LANG)
 LANG = 
-# (WHAT: reader type, FORMAT: CLI or LOCAL)
-# Select the reader to use to read stories (CLI = simple output to console, LOCAL = use local system file handler)
+# reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)
+# (FORMAT: FIXED_LIST) Select the default reader to use to read stories
+# ALLOWED VALUES: "CLI" "GUI" "TUI"
 READER_TYPE = 
-# (WHAT: directory, FORMAT: absolute path, $HOME variable supported, / is always accepted as dir separator)
-# The directory where to store temporary files, defaults to a directory 'fanfic-tmp' in the system default temporary directory
+# The type of output for the Local Reader for non-images documents
+# (FORMAT: COMBO_LIST) One of the known output type
+# ALLOWED VALUES: "INFO_TEXT" "EPUB" "HTML" "TEXT"
+NON_IMAGES_DOCUMENT_TYPE = INFO_TEXT
+# The type of output for the Local Reader for images documents
+# (FORMAT: COMBO_LIST) 
+# ALLOWED VALUES: "CBZ" "HTML"
+IMAGES_DOCUMENT_TYPE = CBZ
+# absolute path, $HOME variable supported, / is always accepted as dir separator
+# (FORMAT: DIRECTORY) The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)
 CACHE_DIR = 
-# (WHAT: directory, FORMAT: absolute path, $HOME variable supported, / is always accepted as dir separator)
-# The directory where to store temporary files, defaults to a directory 'fanfic-reader' in the system default temporary directory
-CACHE_DIR_LOCAL_READER = 
-# (WHAT: delay in hours, FORMAT: integer | 0: no cache | -1: infinite time cache which is default)
-# The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh
+# delay in hours, or 0 for no cache, or -1 for infinite time (default)
+# (FORMAT: INT) The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh
 CACHE_MAX_TIME_CHANGING = 24
-# (WHAT: delay in hours, FORMAT: integer | 0: no cache | -1: infinite time cache which is default)
-# The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh
-CACHE_MAX_TIME_STABLE = 
-# (WHAT: string)
-# The user-agent to use to download files
-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; 79x24)
-# (WHAT: directory, FORMAT: absolute path, $HOME variable supported, / is always accepted as dir separator)
-# The directory where to get the default story covers
-DEFAULT_COVERS_DIR = $HOME/bin/epub/
-# (WHAT: directory, FORMAT: absolute path, $HOME variable supported, / is always accepted as dir separator)
-# The directory where to store the library
+# delay in hours, or 0 for no cache, or -1 for infinite time (default)
+# (FORMAT: INT) The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh
+CACHE_MAX_TIME_STABLE = 720
+# string (FORMAT: STRING) The user-agent to use to download files
+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)
+# absolute path, $HOME variable supported, / is always accepted as dir separator
+# (FORMAT: DIRECTORY) The directory where to get the default story covers
+DEFAULT_COVERS_DIR = $HOME/.fanfix/covers/
+# string (FORMAT: STRING) The default library to use (KEY:SERVER:PORT), or empty for the local library
+DEFAULT_LIBRARY = 
+# The port on which we can start the server
+# (FORMAT: INT) A valid port
+SERVER_PORT = 58365
+# The encryption key for the server (NOT including a subkey)
+# (FORMAT: PASSWORD) cannot contain the pipe character (|)
+SERVER_KEY = 
+# Allow write access to the clients by default (download story, move story...)
+# (FORMAT: BOOLEAN) 
+SERVER_RW = 
+# If not empty, only the EXACT listed sources will be available for clients
+# (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
+SERVER_WHITELIST = 
+# The subkeys that the server will allow, including the modes
+# (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
+SERVER_ALLOWED_SUBKEYS = 
+# absolute path, $HOME variable supported, / is always accepted as dir separator
+# (FORMAT: DIRECTORY) The directory where to store the library
 LIBRARY_DIR = $HOME/Books
-# (WHAT: boolean, FORMAT: 'true' or 'false')
-# Show debug information on errors
-DEBUG_ERR = true
-# (WHAT: image format, FORMAT: PNG, JPG, BMP...)
-# Image format to use for cover images
-IMAGE_FORMAT_COVER = png
-# (WHAT: image format, FORMAT: PNG, JPG, BMP...)
-# Image format to use for content images
-IMAGE_FORMAT_CONTENT = png
-# (FORMAT: not used)
-# This key is only present to allow access to suffixes
+# boolean (FORMAT: BOOLEAN) Show debug information on errors
+DEBUG_ERR = false
+# boolean (FORMAT: BOOLEAN) Show debug trace information
+DEBUG_TRACE = false
+# image format (FORMAT: COMBO_LIST) Image format to use for cover images
+# ALLOWED VALUES: "PNG" "JPG" "BMP"
+IMAGE_FORMAT_COVER = PNG
+# image format (FORMAT: COMBO_LIST) Image format to use for content images
+# ALLOWED VALUES: "PNG" "JPG" "BMP"
+IMAGE_FORMAT_CONTENT = JPG
+# This item is used as a group, its content is not expected to be used.
 LATEX_LANG = 
-# (WHAT: LaTeX output language, WHERE: LaTeX)
-# LaTeX full name for English
+# LaTeX output language: English
+# (FORMAT: STRING) LaTeX full name
 LATEX_LANG_EN = english
-# (WHAT: LaTeX output language, WHERE: LaTeX)
-# LaTeX full name for French
+# LaTeX output language: French
+# (FORMAT: STRING) LaTeX full name
 LATEX_LANG_FR = french
-# (WHAT: other 'by' prefixes before author name, FORMAT: coma-separated list)
-# used to identify the author
+# other 'by' prefixes before author name, used to identify the author
+# (FORMAT: STRING) 
+# (This item accept a list of comma-separated values)
 BYS = by,par,de,©,(c)
-# (WHAT: Chapter identification languages, FORMAT: coma-separated list)
-# used to identify a starting chapter in text mode
+# List of languages codes used for chapter identification (should not be changed)
+# (FORMAT: STRING) EN,FR
+# (This item accept a list of comma-separated values)
 CHAPTER = EN,FR
-# (WHAT: Chapter identification string)
-# used to identify a starting chapter in text mode
+# Chapter identification String: English
+# (FORMAT: STRING) used to identify a starting chapter in text mode
 CHAPTER_EN = Chapter
-# (WHAT: Chapter identification string)
-# used to identify a starting chapter in text mode
+# Chapter identification String: French
+# (FORMAT: STRING) used to identify a starting chapter in text mode
 CHAPTER_FR = Chapitre
+# Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)
+# (FORMAT: STRING) 
+LOGIN_YIFFSTAR_USER = 
+# Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)
+# (FORMAT: PASSWORD) 
+LOGIN_YIFFSTAR_PASS = 
+# 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: INT) 
+UPDATE_INTERVAL = 
+#  (FORMAT: STRING) Format is ((user(:pass)@)proxy:port), with ':' being system proxy and an empty String being no proxy
+USE_PROXY = 
+# FimFiction APIKEY credentials
+#This item is used as a group, its content is not expected to be used.
+LOGIN_FIMFICTION_APIKEY = 
+# An API key required to create a token from FimFiction
+# (FORMAT: STRING) 
+LOGIN_FIMFICTION_APIKEY_CLIENT_ID = 
+# An API key required to create a token from FimFiction
+# (FORMAT: PASSWORD) 
+LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET = 
+# 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: BOOLEAN) 
+LOGIN_FIMFICTION_APIKEY_FORCE_HTML = 
+# A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)
+# (FORMAT: PASSWORD) 
+LOGIN_FIMFICTION_APIKEY_TOKEN = Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D