Configuration files

From SeventeenOrBust

Configuration files for the new client are compartmentalized. There is one "global" file, called client.conf, which contains core options such as logging, where to find plugins and where to store cache and temporary files. There are also plugin configuration files, one for each plugin, named pluginname.conf.

All configuration files must be located in the same directory. From the commandline, the user can pass -c DIR or --config=DIR to tell the client where to look. If this option isn't given, the client has a list of default locations where it will search for configuration files. For each directory in the search list, the client checks for the existence of client.conf, and, if found, treats that directory as the active configuration directory.

Search paths

• On Windows systems:
  1. execdir\config\
  2. cwd\config\
• On UNIX systems:
  1. home/.sb-client/config/
  2. localstatedir/sb-client/config/
  3. cwd/config/

Symbolic names

• cwd -- the current working directory
• execdir -- the location of the sb-client[.exe] executable
• home -- the user's home directory
• localstatedir -- the directory given to ./configure using the --localstatedir option (the default is /var)