From b270ab02ecff18e5049f25112b667dcab90c6693 Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Mon, 27 Aug 2018 15:15:59 +0200 Subject: [PATCH] docs: Compile man-pages Travis is still struggling with `a2x` for some reason. --- doc/lightning-fundchannel.7 | 8 +++++--- doc/lightning-withdraw.7 | 10 ++++++---- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/doc/lightning-fundchannel.7 b/doc/lightning-fundchannel.7 index 68091a8bb..ee90583c4 100644 --- a/doc/lightning-fundchannel.7 +++ b/doc/lightning-fundchannel.7 @@ -2,12 +2,12 @@ .\" Title: lightning-fundchannel .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 07/29/2018 +.\" Date: 08/27/2018 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-FUNDCHANN" "7" "07/29/2018" "\ \&" "\ \&" +.TH "LIGHTNING\-FUNDCHANN" "7" "08/27/2018" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,7 +31,7 @@ lightning-fundchannel \- Command for establishing a lightning channel\&. .SH "SYNOPSIS" .sp -\fBfundchannel\fR \fIid\fR \fIsatoshi\fR +\fBfundchannel\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR \fIfeeratestyle\fR] .SH "DESCRIPTION" .sp The \fBfundchannel\fR RPC command opens a payment channel with a peer by commiting a funding transaction to the blockchain as defined in BOLT #2\&. \fBfundchannel\fR by itself does not attempt to open a connection\&. A connection must first be established using \fBconnect\fR\&. Once the transaction is confirmed, normal channel operations may begin\&. Readiness is indicated by \fBlistpeers\fR reporting a \fIstate\fR of CHANNELD_NORMAL for the channel\&. @@ -39,6 +39,8 @@ The \fBfundchannel\fR RPC command opens a payment channel with a peer by commiti \fIid\fR is the peer id obtained from \fBconnect\fR\&. .sp \fIsatoshi\fR is the amount in satoshis taken from the internal wallet to fund the channel\&. The string \fIall\fR can be used to specify all available funds (or 16777215 satoshi if more is available)\&. The value cannot be less than the dust limit, currently set to 546, nor more than 16777215 satoshi\&. +.sp +\fIfeerate\fR is an optional feerate to use, overriding lightningd\(cqs internal estimate\&. If specified, \fIfeeratestyle\fR must be either \fI"perkw"\fR for if \fIfeerate\fR is in satoshi\-per\-kilosipa (weight), or \fI"perkb"\fR for if \fIfeerate\fR is in bitcoind\-style satoshi\-per\-kilobyte\&. .SH "RETURN VALUE" .sp On success, the \fItx\fR and \fItxid\fR of the transaction is returned, as well as the \fIchannel_id\fR of the newly created channel\&. On failure, an error is reported and the channel is not funded\&. diff --git a/doc/lightning-withdraw.7 b/doc/lightning-withdraw.7 index 9b64b1554..34736e486 100644 --- a/doc/lightning-withdraw.7 +++ b/doc/lightning-withdraw.7 @@ -2,12 +2,12 @@ .\" Title: lightning-withdraw .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 06/15/2018 +.\" Date: 08/27/2018 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-WITHDRAW" "7" "06/15/2018" "\ \&" "\ \&" +.TH "LIGHTNING\-WITHDRAW" "7" "08/27/2018" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,7 +31,7 @@ lightning-withdraw \- Command for withdrawing funds from the internal wallet\&. .SH "SYNOPSIS" .sp -\fBwithdraw\fR \fIdestination\fR \fIsatoshi\fR +\fBwithdraw\fR \fIdestination\fR \fIsatoshi\fR [\fIfeerate\fR \fIfeeratestyle\fR] .SH "DESCRIPTION" .sp The \fBwithdraw\fR RPC command sends funds from c\-lightning\(cqs internal wallet to the address specified in \fIdestination\fR\&. @@ -39,13 +39,15 @@ The \fBwithdraw\fR RPC command sends funds from c\-lightning\(cqs internal walle The address can be of any Bitcoin accepted type, including bech32\&. .sp \fIsatoshi\fR is the amount to be withdrawn from the internal wallet (expressed, as name suggests, in satoshi)\&. The string \fIall\fR can be used to specify withdrawal of all available funds\&. +.sp +\fIfeerate\fR is an optional feerate to use, overriding lightningd\(cqs internal estimate\&. If specified, \fIfeeratestyle\fR must be either \fI"perkw"\fR for if \fIfeerate\fR is in satoshi\-per\-kilosipa (weight), or \fI"perkb"\fR for if \fIfeerate\fR is in bitcoind\-style satoshi\-per\-kilobyte\&. .SH "RETURN VALUE" .sp On success, an object with attributes \fItx\fR and \fItxid\fR will be returned\&. .sp \fItx\fR represents the raw bitcoin, fully signed, transaction and \fItxid\fR represent the bitcoin transaction id\&. .sp -On failure, an error is reported and the withdrawal transaction is not created.\&. +On failure, an error is reported and the withdrawal transaction is not created\&. .sp The following error codes may occur: .sp