[nikiroo-utils.git] / src / be / nikiroo / fanfix / bundles / config.properties

# Configuration options
#


# 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 = 
# 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 = 
# 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 = 
# 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
# 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
# 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 = 
# LaTeX output language: English
# (FORMAT: STRING) LaTeX full name
LATEX_LANG_EN = english
# LaTeX output language: French
# (FORMAT: STRING) LaTeX full name
LATEX_LANG_FR = french
# 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)
# 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
# Chapter identification String: English
# (FORMAT: STRING) used to identify a starting chapter in text mode
CHAPTER_EN = Chapter
# 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 = 
# 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
Commit	Line	Data
08fe2e33 NR	1	# Configuration options
	2	#
	3
	4
ce788468 NR	5	# language (example: en-GB, fr-BE...) or nothing for default system language
ce788468 NR	6	# (FORMAT: LOCALE) Force the language (can be overwritten again with the env variable $LANG)
08fe2e33	7	LANG =
c1873e56	8	# reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)
ce788468	9	# (FORMAT: FIXED_LIST) Select the default reader to use to read stories
c1873e56	10	# ALLOWED VALUES: "CLI" "GUI" "TUI"
3727aae2	11	READER_TYPE =
e604986c NR	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
ce788468 NR	20	# absolute path, $HOME variable supported, / is always accepted as dir separator
ce788468 NR	21	# (FORMAT: DIRECTORY) The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)
08fe2e33	22	CACHE_DIR =
ce788468 NR	23	# delay in hours, or 0 for no cache, or -1 for infinite time (default)
ce788468 NR	24	# (FORMAT: INT) The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh
08fe2e33	25	CACHE_MAX_TIME_CHANGING = 24
ce788468 NR	26	# delay in hours, or 0 for no cache, or -1 for infinite time (default)
ce788468 NR	27	# (FORMAT: INT) The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh
a8209dd0	28	CACHE_MAX_TIME_STABLE = 720
ce788468	29	# string (FORMAT: STRING) The user-agent to use to download files
edd46289	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)
ce788468 NR	31	# absolute path, $HOME variable supported, / is always accepted as dir separator
ce788468 NR	32	# (FORMAT: DIRECTORY) The directory where to get the default story covers
51c5d9a7	33	DEFAULT_COVERS_DIR = $HOME/.fanfix/covers/
e023483b NR	34	# string (FORMAT: STRING) The default library to use (KEY:SERVER:PORT), or empty for the local library
e023483b NR	35	DEFAULT_LIBRARY =
fb25273c NR	36	# The port on which we can start the server
	37	# (FORMAT: INT) A valid port
	38	SERVER_PORT = 58365
	39	# The encryption key for the server (NOT including a subkey)
	40	# (FORMAT: PASSWORD) cannot contain the pipe character (\|)
	41	SERVER_KEY =
	42	# Allow write access to the clients by default (download story, move story...)
	43	# (FORMAT: BOOLEAN)
	44	SERVER_RW =
	45	# If not empty, only the EXACT listed sources will be available for clients
	46	# (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
	47	SERVER_WHITELIST =
	48	# The subkeys that the server will allow, including the modes
	49	# (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
	50	SERVER_ALLOWED_SUBKEYS =
ce788468 NR	51	# absolute path, $HOME variable supported, / is always accepted as dir separator
ce788468 NR	52	# (FORMAT: DIRECTORY) The directory where to store the library
08fe2e33	53	LIBRARY_DIR = $HOME/Books
ce788468	54	# boolean (FORMAT: BOOLEAN) Show debug information on errors
d0114000	55	DEBUG_ERR = false
a8209dd0 NR	56	# boolean (FORMAT: BOOLEAN) Show debug trace information
a8209dd0 NR	57	DEBUG_TRACE = false
ce788468 NR	58	# image format (FORMAT: COMBO_LIST) Image format to use for cover images
ce788468 NR	59	# ALLOWED VALUES: "PNG" "JPG" "BMP"
ae78e517	60	IMAGE_FORMAT_COVER = PNG
ce788468 NR	61	# image format (FORMAT: COMBO_LIST) Image format to use for content images
ce788468 NR	62	# ALLOWED VALUES: "PNG" "JPG" "BMP"
ae78e517	63	IMAGE_FORMAT_CONTENT = JPG
ce788468 NR	64	# This item is used as a group, its content is not expected to be used.
	65	LATEX_LANG =
	66	# LaTeX output language: English
	67	# (FORMAT: STRING) LaTeX full name
08fe2e33	68	LATEX_LANG_EN = english
ce788468 NR	69	# LaTeX output language: French
ce788468 NR	70	# (FORMAT: STRING) LaTeX full name
08fe2e33	71	LATEX_LANG_FR = french
ce788468 NR	72	# other 'by' prefixes before author name, used to identify the author
	73	# (FORMAT: STRING)
	74	# (This item accept a list of comma-separated values)
08fe2e33	75	BYS = by,par,de,©,(c)
ce788468 NR	76	# List of languages codes used for chapter identification (should not be changed)
	77	# (FORMAT: STRING) EN,FR
	78	# (This item accept a list of comma-separated values)
08fe2e33	79	CHAPTER = EN,FR
ce788468 NR	80	# Chapter identification String: English
ce788468 NR	81	# (FORMAT: STRING) used to identify a starting chapter in text mode
08fe2e33	82	CHAPTER_EN = Chapter
ce788468 NR	83	# Chapter identification String: French
ce788468 NR	84	# (FORMAT: STRING) used to identify a starting chapter in text mode
08fe2e33	85	CHAPTER_FR = Chapitre
ce788468 NR	86	# Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)
ce788468 NR	87	# (FORMAT: STRING)
6e06d2cc	88	LOGIN_YIFFSTAR_USER =
ce788468 NR	89	# Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)
ce788468 NR	90	# (FORMAT: PASSWORD)
6e06d2cc	91	LOGIN_YIFFSTAR_PASS =
ce788468 NR	92	# 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)
ce788468 NR	93	# (FORMAT: INT)
b42117f1	94	UPDATE_INTERVAL =
4ff0b1a9 N	95	# (FORMAT: STRING) Format is ((user(:pass)@)proxy:port), with ':' being system proxy and an empty String being no proxy
4ff0b1a9 N	96	USE_PROXY =
a8209dd0 NR	97	# An API key required to create a token from FimFiction
	98	# (FORMAT: STRING)
	99	LOGIN_FIMFICTION_APIKEY_CLIENT_ID =
	100	# An API key required to create a token from FimFiction
315f14ae	101	# (FORMAT: PASSWORD)
a8209dd0 NR	102	LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET =
a8209dd0 NR	103	# 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)
315f14ae	104	# (FORMAT: BOOLEAN)
a8209dd0 NR	105	LOGIN_FIMFICTION_APIKEY_FORCE_HTML =
	106	# A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)
	107	# (FORMAT: PASSWORD)
e604986c	108	LOGIN_FIMFICTION_APIKEY_TOKEN = Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D