From 315f1d3ba7660703a9b2221341581c8f77e44509 Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Mon, 27 Jul 2020 21:53:06 +0200 Subject: [PATCH] doc: Document the `msatoshi` parameter for `sendonion` --- doc/lightning-sendonion.7 | 6 +++++- doc/lightning-sendonion.7.md | 5 ++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/lightning-sendonion.7 b/doc/lightning-sendonion.7 index 47f6a44a2..260921fee 100644 --- a/doc/lightning-sendonion.7 +++ b/doc/lightning-sendonion.7 @@ -3,7 +3,7 @@ lightning-sendonion - Send a payment with a custom onion packet .SH SYNOPSIS -\fBsendonion\fR \fIonion\fR \fIfirst_hop\fR \fIpayment_hash\fR [\fIlabel\fR] [\fIshared_secrets\fR] [\fIpartid\fR] [\fIbolt11\fR] +\fBsendonion\fR \fIonion\fR \fIfirst_hop\fR \fIpayment_hash\fR [\fIlabel\fR] [\fIshared_secrets\fR] [\fIpartid\fR] [\fIbolt11\fR] [\fImsatoshi\fR] .SH DESCRIPTION @@ -89,6 +89,10 @@ partial payments with the same \fIpayment_hash\fR\. The \fIbolt11\fR parameter, if provided, will be returned in \fIwaitsendpay\fR and \fIlistsendpays\fR results\. + +The \fImsatoshi\fR parameter is used to annotate the payment, and is returned by +\fIwaitsendpay\fR and \fIlistsendpays\fR\. + .SH RETURN VALUE On success, an object similar to the output of \fBsendpay\fR will be diff --git a/doc/lightning-sendonion.7.md b/doc/lightning-sendonion.7.md index 28ca83977..cde69a1db 100644 --- a/doc/lightning-sendonion.7.md +++ b/doc/lightning-sendonion.7.md @@ -4,7 +4,7 @@ lightning-sendonion -- Send a payment with a custom onion packet SYNOPSIS -------- -**sendonion** *onion* *first_hop* *payment_hash* \[*label*\] \[*shared_secrets*\] \[*partid*\] \[*bolt11*\] +**sendonion** *onion* *first_hop* *payment_hash* \[*label*\] \[*shared_secrets*\] \[*partid*\] \[*bolt11*\] \[*msatoshi*\] DESCRIPTION ----------- @@ -78,6 +78,9 @@ partial payments with the same *payment_hash*. The *bolt11* parameter, if provided, will be returned in *waitsendpay* and *listsendpays* results. +The *msatoshi* parameter is used to annotate the payment, and is returned by +*waitsendpay* and *listsendpays*. + RETURN VALUE ------------