mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-10 07:37:05 +01:00
c3254e6639
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
76 lines
2.3 KiB
Groff
76 lines
2.3 KiB
Groff
.TH "LIGHTNING-WITHDRAW" "7" "" "" "lightning-withdraw"
|
||
.SH NAME
|
||
lightning-withdraw - Command for withdrawing funds from the internal wallet
|
||
.SH SYNOPSIS
|
||
|
||
\fBwithdraw\fR \fIdestination\fR \fIsatoshi\fR [\fIfeerate\fR] [\fIminconf\fR]
|
||
|
||
.SH DESCRIPTION
|
||
|
||
The \fBwithdraw\fR RPC command sends funds from c-lightning’s internal
|
||
wallet to the address specified in \fIdestination\fR\.
|
||
|
||
|
||
The address can be of any Bitcoin accepted type, including bech32\.
|
||
|
||
|
||
\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\. Otherwise, it is in
|
||
satoshi precision; it can be a whole number, a whole number ending in
|
||
\fIsat\fR, a whole number ending in \fI000msat\fR, or a number with 1 to 8
|
||
decimal places ending in \fIbtc\fR\.
|
||
|
||
|
||
\fIfeerate\fR is an optional feerate to use\. It can be one of the strings
|
||
\fIurgent\fR (aim for next block), \fInormal\fR (next 4 blocks or so) or \fIslow\fR
|
||
(next 100 blocks or so) to use lightningd’s internal estimates: \fInormal\fR
|
||
is the default\.
|
||
|
||
|
||
Otherwise, \fIfeerate\fR is a number, with an optional suffix: \fIperkw\fR means
|
||
the number is interpreted as satoshi-per-kilosipa (weight), and \fIperkb\fR
|
||
means it is interpreted bitcoind-style as satoshi-per-kilobyte\. Omitting
|
||
the suffix is equivalent to \fIperkb\fR\.
|
||
|
||
|
||
\fIminconf\fR specifies the minimum number of confirmations that used
|
||
outputs should have\. Default is 1\.
|
||
|
||
.SH RETURN VALUE
|
||
|
||
On success, an object with attributes \fItx\fR and \fItxid\fR will be returned\.
|
||
|
||
|
||
\fItx\fR represents the raw bitcoin, fully signed, transaction and \fItxid\fR
|
||
represent the bitcoin transaction id\.
|
||
|
||
|
||
On failure, an error is reported and the withdrawal transaction is not
|
||
created\.
|
||
|
||
|
||
The following error codes may occur:
|
||
|
||
.IP \[bu]
|
||
-1: Catchall nonspecific error\.
|
||
.IP \[bu]
|
||
301: There are not enough funds in the internal wallet (including
|
||
fees) to create the transaction\.
|
||
.IP \[bu]
|
||
302: The dust limit is not met\.
|
||
|
||
.SH AUTHOR
|
||
|
||
Felix \fI<fixone@gmail.com\fR> is mainly responsible\.
|
||
|
||
.SH SEE ALSO
|
||
|
||
\fBlightning-listfunds\fR(7), \fBlightning-fundchannel\fR(7), \fBlightning-newaddr\fR(7),
|
||
\fBlightning-txprepare\fR(7)\.
|
||
|
||
.SH RESOURCES
|
||
|
||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||
|