Klipspringer hub options

Options that set various properties of the Klipspringer hub can be specified both at the command line as arguments to the klipspringer-hub command and in an options.json file. It’s also possible to override some options for a specific source by setting an options property in the source specification.

To list the full set of options, run klipspringer-hub -help.

The configuration directory where options.json should be located (and also contains the sources.json file) defaults to /etc/klipspringer-hub, but can be set to any location with an -etc command line option. The file should consist of a single object, whose property names are options (including the leading hyphen) and property values are option arguments. For an option without any parameter, the property value is ignored. Here is an example that specifies a remote control device and a sound device:

{
    "-remote": "/dev/input/event3",
    "-joutput": "PCH [plughw:0,1]"
}

You can find a larger example in the examples directory.

Options given on the command line takes priority over those in the options file, and options later on the command line takes priority over earlier options, except that options that can appear multiple times (like -vlc-arg) don’t override previous values.

All options can be set in options.json except -etc (which would be to late to specify once its value has already been used for finding options.json) and -lib. These are both given as command line options in the klipspringer-hub command script and the klipspringer-hub.service unit, but they can be set again by options given to klipspringer-hub. (The code in main.js specifies the directory ~/.klipspringer as the default value for both of them, so their default values in klipspringer-hub are actually overrides of a more basic default value. In order not to be too confusing, -help doesn’t list their default values.) The values for -etc and -lib in the klipspringer-hub command script and the klipspringer-hub.service unit can only be influenced by specifying install locations with make parameters.