diff --git a/doc/lightning-setchannelfee.7 b/doc/lightning-setchannelfee.7 index 462a50223..3f44a3bb6 100644 --- a/doc/lightning-setchannelfee.7 +++ b/doc/lightning-setchannelfee.7 @@ -1,13 +1,13 @@ '\" t .\" Title: lightning-setchannelfee .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 03/15/2019 +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/18/2019 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-SETCHANNE" "7" "03/15/2019" "\ \&" "\ \&" +.TH "LIGHTNING\-SETCHANNE" "7" "03/18/2019" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -36,14 +36,14 @@ lightning-setchannelfee \- Command for setting specific routing fees on a lightn .sp The \fBsetchannelfee\fR RPC command sets channel specific routing fees as defined in BOLT #7\&. The channel has to be in normal or awaiting state\&. This can be checked by \fBlistpeers\fR reporting a \fIstate\fR of CHANNELD_NORMAL or CHANNELD_AWAITING_LOCKIN for the channel\&. .sp -\fIid\fR is required and should contain a scid (short channel ID), channel id or peerid (pubkey) of the channel to be modified\&. +\fIid\fR is required and should contain a scid (short channel ID), channel id or peerid (pubkey) of the channel to be modified\&. If \fIid\fR is set to "all", the fees for all channels are updated that are in state CHANNELD_NORMAL or CHANNELD_AWAITING_LOCKIN\&. .sp \fIbase\fR is an optional value in millisatoshi that is added as base fee to any routed payment\&. If the parameter is left out, the global config value fee\-base will be used again\&. It can be a whole number, or a whole number ending in \fImsat\fR or \fIsat\fR, or a number with three decimal places ending in \fIsat\fR, or a number with 1 to 11 decimal places ending in \fIbtc\fR\&. .sp \fIppm\fR is an optional value that is added proportionally per\-millionths to any routed payment volume in satoshi\&. For example, if ppm is 1,000 and 1,000,000 satoshi is being routed trhough the channel, an proportional fee of 1,000 satoshi is added, resulting in a 0\&.1% fee\&. If the parameter is left out, the global config value will be used again\&. .SH "RETURN VALUE" .sp -On success, an object with fields \fIchannel_id\fR, \fIshort_channel_id\fR, \fIbase\fR and \fIppm\fR, describing the new values for this cannel, is returned\&. +On success, an object with the new values \fIbase\fR and \fIppm\fR along with an array \fIchannels\fR which contains objects with fields \fIpeer_id\fR, \fIchannel_id\fR and \fIshort_channel_id\fR\&. .SH "ERRORS" .sp The following error codes may occur: diff --git a/doc/lightning-setchannelfee.7.txt b/doc/lightning-setchannelfee.7.txt index 8c733456a..51248b6ae 100644 --- a/doc/lightning-setchannelfee.7.txt +++ b/doc/lightning-setchannelfee.7.txt @@ -18,7 +18,9 @@ This can be checked by *listpeers* reporting a 'state' of CHANNELD_NORMAL or CHANNELD_AWAITING_LOCKIN for the channel. 'id' is required and should contain a scid (short channel ID), channel id -or peerid (pubkey) of the channel to be modified. +or peerid (pubkey) of the channel to be modified. If 'id' is set to "all", +the fees for all channels are updated that are in state CHANNELD_NORMAL or +CHANNELD_AWAITING_LOCKIN. 'base' is an optional value in millisatoshi that is added as base fee to any routed payment. If the parameter is left out, the global config @@ -34,8 +36,9 @@ is left out, the global config value will be used again. RETURN VALUE ------------ -On success, an object with fields 'channel_id', 'short_channel_id', 'base' -and 'ppm', describing the new values for this cannel, is returned. +On success, an object with the new values 'base' and 'ppm' along with an array +'channels' which contains objects with fields 'peer_id', 'channel_id' and +'short_channel_id'. ERRORS ------ diff --git a/doc/lightningd-config.5 b/doc/lightningd-config.5 index b79f5d850..7832c463c 100644 --- a/doc/lightningd-config.5 +++ b/doc/lightningd-config.5 @@ -2,12 +2,12 @@ .\" Title: lightningd-config .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 03/03/2019 +.\" Date: 03/05/2019 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNINGD\-CONFIG" "5" "03/03/2019" "\ \&" "\ \&" +.TH "LIGHTNINGD\-CONFIG" "5" "03/05/2019" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -188,12 +188,12 @@ Up to 32 UTF\-8 characters to tag your node\&. Completely silly, since anyone ca .PP \fBfee\-base\fR=\fIMILLISATOSHI\fR .RS 4 -The base fee to charge for every payment which passes through\&. Note that millisatoshis are a very, very small unit! Changing this value will only affect new channels and not existing ones\&. +The base fee to charge for every payment which passes through\&. Note that millisatoshis are a very, very small unit! Changing this value will only affect new channels and not existing ones\&. If you want to change fees for existing channels, use the RPC call lightningd\-setchannelfee(7)\&. .RE .PP \fBfee\-per\-satoshi\fR=\fIMILLIONTHS\fR .RS 4 -This is the proportional fee to charge for every payment which passes through\&. As percentages are too coarse, it\(cqs in millionths, so 10000 is 1%, 1000 is 0\&.1%\&. Changing this value will only affect new channels and not existing ones\&. +This is the proportional fee to charge for every payment which passes through\&. As percentages are too coarse, it\(cqs in millionths, so 10000 is 1%, 1000 is 0\&.1%\&. Changing this value will only affect new channels and not existing ones\&. If you want to change fees for existing channels, use the RPC call lightningd\-setchannelfee(7)\&. .RE .PP \fBignore\-fee\-limits\fR=\fIBOOL\fR @@ -485,6 +485,9 @@ You should report bugs on our github issues page, and maybe submit a fix to gain .SH "AUTHOR" .sp Rusty Russell wrote this man page, and much of the configuration language, but many others did the hard work of actually implementing these options\&. +.SH "SEE ALSO" +.sp +lightning\-listconfigs(7) lightningd\-setchannelfee(7) .SH "RESOURCES" .sp Main web site: https://github\&.com/ElementsProject/lightning diff --git a/doc/lightningd-config.5.txt b/doc/lightningd-config.5.txt index 6fd1b42bc..6152dda6f 100644 --- a/doc/lightningd-config.5.txt +++ b/doc/lightningd-config.5.txt @@ -141,13 +141,15 @@ Lightning node customization options *fee-base*='MILLISATOSHI':: The base fee to charge for every payment which passes through. Note that millisatoshis are a very, very small unit! Changing this value will only - affect new channels and not existing ones. + affect new channels and not existing ones. If you want to change fees for + existing channels, use the RPC call lightningd-setchannelfee(7). *fee-per-satoshi*='MILLIONTHS':: This is the proportional fee to charge for every payment which passes through. As percentages are too coarse, it's in millionths, so 10000 is 1%, 1000 is 0.1%. Changing this value will only affect new channels and - not existing ones. + not existing ones. If you want to change fees for existing channels, use + the RPC call lightningd-setchannelfee(7). *ignore-fee-limits*='BOOL':: Allow nodes which establish channels to us to set any fee they @@ -346,6 +348,10 @@ Rusty Russell wrote this man page, and much of the configuration language, but many others did the hard work of actually implementing these options. +SEE ALSO +-------- +lightning-listconfigs(7) lightningd-setchannelfee(7) + RESOURCES --------- Main web site: https://github.com/ElementsProject/lightning