lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: add manpages for fundchannel_[start,complete,cancel] 

Manpages for the manpage-god!!
pull/2938/head
lisa neigut 6 years ago
committed by Rusty Russell
parent
388f31a151
commit
c0475d0d9d
7 changed files with 302 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 3
      doc/Makefile
  2. 53
      doc/lightning-fundchannel_cancel.7
  3. 37
      doc/lightning-fundchannel_cancel.7.txt
  4. 59
      doc/lightning-fundchannel_complete.7
  5. 46
      doc/lightning-fundchannel_complete.7.txt
  6. 59
      doc/lightning-fundchannel_start.7
  7. 45
      doc/lightning-fundchannel_start.7.txt

3
doc/Makefile
View File

@ -15,6 +15,9 @@ MANPAGES := doc/lightning-cli.1 \
doc/lightning-delinvoice.7 \
doc/lightning-disconnect.7 \
doc/lightning-fundchannel.7 \
doc/lightning-fundchannel_start.7 \
doc/lightning-fundchannel_complete.7 \
doc/lightning-fundchannel_cancel.7 \
doc/lightning-getroute.7 \
doc/lightning-invoice.7 \
doc/lightning-listchannels.7 \

53
doc/lightning-fundchannel_cancel.7
View File

@ -0,0 +1,53 @@
'\" t
.\" Title: lightning-fundchannel_cancel
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 06/05/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-FUNDCHANN" "7" "06/05/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-fundchannel_cancel \- Command for completing channel establishment
.SH "SYNOPSIS"
.sp
\fBfundchannel_cancel\fR \fIid\fR
.SH "DESCRIPTION"
.sp
fundchannel_cancel is a lower level RPC command\&. It allows a user to cancel an initiated channel establishment with a connected peer\&.
.sp
\fIid\fR is the node id of the remote peer with which to cancel the
.SH "RETURN VALUE"
.sp
On success, returns confirmation that the channel establishment has been canceled\&.
.sp
On failure, returns an error\&.
.SH "AUTHOR"
.sp
Lisa Neigut <niftynei@gmail\&.com> is mainly responsible\&.
.SH "SEE ALSO"
.sp
lightning\-connect(7), lightning\-fundchannel(7), lightning\-fundchannel_start(7), lightning\-fundchannel_complete(7)
.SH "RESOURCES"
.sp
Main web site: https://github\&.com/ElementsProject/lightning

37
doc/lightning-fundchannel_cancel.7.txt
View File

@ -0,0 +1,37 @@
LIGHTNING-FUNDCHANNEL_CANCEL(7)
===============================
:doctype: manpage
NAME
----
lightning-fundchannel_cancel - Command for completing channel establishment
SYNOPSIS
--------
*fundchannel_cancel* 'id'
DESCRIPTION
-----------
`fundchannel_cancel` is a lower level RPC command. It allows a user to cancel an initiated
channel establishment with a connected peer.
'id' is the node id of the remote peer with which to cancel the
RETURN VALUE
------------
On success, returns confirmation that the channel establishment has been canceled.
On failure, returns an error.
AUTHOR
------
Lisa Neigut <niftynei@gmail.com> is mainly responsible.
SEE ALSO
--------
lightning-connect(7), lightning-fundchannel(7), lightning-fundchannel_start(7),
lightning-fundchannel_complete(7)
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning

59
doc/lightning-fundchannel_complete.7
View File

@ -0,0 +1,59 @@
'\" t
.\" Title: lightning-fundchannel_complete
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 06/05/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-FUNDCHANN" "7" "06/05/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-fundchannel_complete \- Command for completing channel establishment
.SH "SYNOPSIS"
.sp
\fBfundchannel_complete\fR \fIid\fR \fItxid\fR \fItxout\fR
.SH "DESCRIPTION"
.sp
fundchannel_complete is a lower level RPC command\&. It allows a user to complete an initiated channel establishment with a connected peer
.sp
\fIid\fR is the node id of the remote peer
.sp
\fItxid\fR is the hex string of the funding transaction id\&.
.sp
\fItxout\fR is the integer outpoint of the funding output for this channel\&.
.sp
Note that the funding transaction should not be broadcast until after channel establishment has been successfully completed, as the commitment transactions for this channel are not secured until this command succesfully completes\&.
.SH "RETURN VALUE"
.sp
On success, returns a confirmation that \fIcommitments_secured\fR and the derived \fIchannel_id\fR\&.
.sp
On failure, returns an error\&.
.SH "AUTHOR"
.sp
Lisa Neigut <niftynei@gmail\&.com> is mainly responsible\&.
.SH "SEE ALSO"
.sp
lightning\-connect(7), lightning\-fundchannel(7), lightning\-fundchannel_start(7), lightning\-fundchannel_cancel(7)
.SH "RESOURCES"
.sp
Main web site: https://github\&.com/ElementsProject/lightning

46
doc/lightning-fundchannel_complete.7.txt
View File

@ -0,0 +1,46 @@
LIGHTNING-FUNDCHANNEL_COMPLETE(7)
=================================
:doctype: manpage
NAME
----
lightning-fundchannel_complete - Command for completing channel establishment
SYNOPSIS
--------
*fundchannel_complete* 'id' 'txid' 'txout'
DESCRIPTION
-----------
`fundchannel_complete` is a lower level RPC command. It allows a user to complete an initiated
channel establishment with a connected peer
'id' is the node id of the remote peer
'txid' is the hex string of the funding transaction id.
'txout' is the integer outpoint of the funding output for this channel.
Note that the funding transaction should not be broadcast until after channel
establishment has been successfully completed, as the commitment transactions
for this channel are not secured until this command succesfully completes.
RETURN VALUE
------------
On success, returns a confirmation that 'commitments_secured' and the
derived 'channel_id'.
On failure, returns an error.
AUTHOR
------
Lisa Neigut <niftynei@gmail.com> is mainly responsible.
SEE ALSO
--------
lightning-connect(7), lightning-fundchannel(7), lightning-fundchannel_start(7),
lightning-fundchannel_cancel(7)
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning

59
doc/lightning-fundchannel_start.7
View File

@ -0,0 +1,59 @@
'\" t
.\" Title: lightning-fundchannel_start
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 06/05/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-FUNDCHANN" "7" "06/05/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-fundchannel_start \- Command for initiating channel establishment for a lightning channel
.SH "SYNOPSIS"
.sp
\fBfundchannel_start\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR \fIannounce\fR]
.SH "DESCRIPTION"
.sp
fundchannel_start is a lower level RPC command\&. It allows a user to initiate channel establishment with a connected peer\&.
.sp
\fIid\fR is the node id of the remote peer\&.
.sp
\fIsatoshi\fR is the satoshi value that the channel will be funded at\&. This value MUST be accurate, otherwise the negotiated commitment transactions will not encompass the correct channel value\&.
.sp
\fIfeerate\fR is an optional field\&. Sets the feerate for subsequent commitment transactions\&.
.sp
\fIannounce\fR whether or not to annouce this channel\&.
.SH "RETURN VALUE"
.sp
On success, returns the \fIfunding_address\fR for the channel\&.
.sp
On failure, returns an error\&.
.SH "AUTHOR"
.sp
Lisa Neigut <niftynei@gmail\&.com> is mainly responsible\&.
.SH "SEE ALSO"
.sp
lightning\-connect(7), lightning\-fundchannel(7), lightning\-fundchannel_complete(7), lightning\-fundchannel_cancel(7)
.SH "RESOURCES"
.sp
Main web site: https://github\&.com/ElementsProject/lightning

45
doc/lightning-fundchannel_start.7.txt
View File

@ -0,0 +1,45 @@
LIGHTNING-FUNDCHANNEL_START(7)
==============================
:doctype: manpage
NAME
----
lightning-fundchannel_start - Command for initiating channel establishment for a lightning channel
SYNOPSIS
--------
*fundchannel_start* 'id' 'satoshi' ['feerate' 'announce']
DESCRIPTION
-----------
`fundchannel_start` is a lower level RPC command. It allows a user to initiate channel
establishment with a connected peer.
'id' is the node id of the remote peer.
'satoshi' is the satoshi value that the channel will be funded at. This value MUST be
accurate, otherwise the negotiated commitment transactions will not encompass the correct
channel value.
'feerate' is an optional field. Sets the feerate for subsequent commitment transactions.
'announce' whether or not to annouce this channel.
RETURN VALUE
------------
On success, returns the 'funding_address' for the channel.
On failure, returns an error.
AUTHOR
------
Lisa Neigut <niftynei@gmail.com> is mainly responsible.
SEE ALSO
--------
lightning-connect(7), lightning-fundchannel(7), lightning-fundchannel_complete(7),
lightning-fundchannel_cancel(7)
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning
Write Preview
Loading…
Cancel
Save