core-lightning/doc/lightning-setconfig.7.md
Tony Aldon 8f6a02c182 doc: fix display of lists and code blocks in manpages.
The conversion from markdown to manpages does not display lists and
code blocks correctly if they are not preceded by an empty line.

Changelog-None
2023-10-14 17:55:51 +02:00

2.0 KiB

lightning-setconfig -- Dynamically change some config options

SYNOPSIS

setconfig config [val]

DESCRIPTION

The setconfig RPC command allows you set the (dynamic) configuration option named by config: options which take a value (as separate from simple flag options) also need a val parameter.

This new value will also be written at the end of the config file, for persistence across restarts (and any old value commented out).

You can see what options are dynamically adjustable using lightning-listconfigs(7). Note that you can also adjust existing options for stopped plugins; they will have an effect when the plugin is restarted.

RETURN VALUE

On success, an object containing config is returned. It is an object containing:

  • config (string): name of the config variable which was set
  • source (string): source of configuration setting (file:linenum)
  • dynamic (boolean): whether this option is settable via setconfig (always true)
  • plugin (string, optional): the plugin this configuration setting is for
  • set (boolean, optional): for simple flag options
  • value_str (string, optional): for string options
  • value_msat (msat, optional): for msat options
  • value_int (integer, optional): for integer options
  • value_bool (boolean, optional): for boolean options

ERRORS

The following error codes may occur:

  • -32602: JSONRPC2_INVALID_PARAMS, i.e. the parameter is not dynamic, or the val was invalid.

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible for this feature.

SEE ALSO

lightningd-config(5), lightning-listconfigs(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning