src/be/nikiroo/fanfix/bundles/Config.java

   1 package be.nikiroo.fanfix.bundles;
   2
   3 import be.nikiroo.utils.resources.Meta;
   4
   5 /**
   6  * The configuration options.
   7  *
   8  * @author niki
   9  */
  10 public enum Config {
  11         @Meta(what = "language (example: en-GB, fr-BE...) or nothing for default system language", where = "", format = "Locale|''", info = "Force the language (can be overwritten again with the env variable $LANG)")
  12         LANG, //
  13         @Meta(what = "reader type (CLI = simple output to console, LOCAL = use local system file handler)", where = "", format = "'CLI'|'LOCAL'", info = "Select the default reader to use to read stories")
  14         READER_TYPE, //
  15         @Meta(what = "absolute path, $HOME variable supported, / is always accepted as dir separator", where = "", format = "Directory", info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)")
  16         CACHE_DIR, //
  17         @Meta(what = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", where = "", format = "int", info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh")
  18         CACHE_MAX_TIME_CHANGING, //
  19         @Meta(what = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", where = "", format = "int", info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh")
  20         CACHE_MAX_TIME_STABLE, //
  21         @Meta(what = "string", where = "", format = "String", info = "The user-agent to use to download files")
  22         USER_AGENT, //
  23         @Meta(what = "absolute path, $HOME variable supported, / is always accepted as dir separator", where = "", format = "Directory", info = "The directory where to get the default story covers")
  24         DEFAULT_COVERS_DIR, //
  25         @Meta(what = "absolute path, $HOME variable supported, / is always accepted as dir separator", where = "", format = "Directory", info = "The directory where to store the library")
  26         LIBRARY_DIR, //
  27         @Meta(what = "boolean", where = "", format = "'true'|'false'", info = "Show debug information on errors")
  28         DEBUG_ERR, //
  29         @Meta(what = "image format", where = "", format = "'PNG'|JPG'|'BMP'", info = "Image format to use for cover images")
  30         IMAGE_FORMAT_COVER, //
  31         @Meta(what = "image format", where = "", format = "'PNG'|JPG'|'BMP'", info = "Image format to use for content images")
  32         IMAGE_FORMAT_CONTENT, //
  33         // This key is only present to allow access to suffixes, so no Meta
  34         LATEX_LANG, //
  35         @Meta(what = "LaTeX output language", where = "LaTeX", format = "String", info = "LaTeX full name for English")
  36         LATEX_LANG_EN, //
  37         @Meta(what = "LaTeX output language", where = "LaTeX", format = "String", info = "LaTeX full name for French")
  38         LATEX_LANG_FR, //
  39         @Meta(what = "other 'by' prefixes before author name", where = "", format = "comma-separated list|String", info = "used to identify the author")
  40         BYS, //
  41         @Meta(what = "Chapter identification languages", where = "", format = "comma-separated list|String", info = "used to identify a starting chapter in text mode")
  42         CHAPTER, //
  43         @Meta(what = "Chapter identification string", where = "String", format = "", info = "used to identify a starting chapter in text mode")
  44         CHAPTER_EN, //
  45         @Meta(what = "Chapter identification string", where = "String", format = "", info = "used to identify a starting chapter in text mode")
  46         CHAPTER_FR, //
  47         @Meta(what = "Login information", where = "", format = "String", info = "used to login on YiffStar to have access to all the stories (should not be necessary anymore)")
  48         LOGIN_YIFFSTAR_USER, //
  49         @Meta(what = "Login information", where = "", format = "Password", info = "used to login on YiffStar to have access to all the stories (should not be necessary anymore)")
  50         LOGIN_YIFFSTAR_PASS, //
  51         @Meta(what = "Minimum time between version update checks in days, or -1 for 'no checks' -- default is 1 day", where = "VersionCheck", format = "int", info = "If the last update check was done at least that many days, check for updates at startup")
  52         UPDATE_INTERVAL,
  53 }