aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 07:04:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix GH/readthedocs rendering of manual pages.

Browse Source 
They render the comment as if it's in the list.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2021-09-03 19:37:59 +09:30
committed by Christian Decker
parent 0f05238e97
commit 6d1897b796
161 changed files with 245 additions and 164 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/lightning-addgossip.7 generated
View File

@@ -35,4 +35,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:cf8eccccfb5e26329100122ce2ed8a0dde4892aab91761c18b935a62fba73eeb
\" SHA256STAMP:abe4b88f82d3e6894742133522bbc025409c8bca287f47dbe41e63f78fa76ef9

3
doc/lightning-addgossip.7.md
View File

@@ -24,6 +24,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an empty object is returned.
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -41,4 +42,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:f807f98a54c194fab710f8a3393e96685fdbd0efa5e178cca54507a70a7a5c20)
[comment]: # ( SHA256STAMP:86b47e27413141ffd6e8b79d83ac4a5cc80e5a7e6f5ba4b0df6825e744f9eea7)

2
doc/lightning-autocleaninvoice.7 generated
View File

@@ -54,4 +54,4 @@ ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:607f888f8c0228257fbeeb382262be93191f1da2be1fdebcf619b500889e349a
\" SHA256STAMP:ec375ac1566528596d5e382cc9d82718266c8ccb32469ff1fc6df52c92ea4dab

3
doc/lightning-autocleaninvoice.7.md
View File

@@ -32,6 +32,7 @@ On success, an object is returned, containing:
If **enabled** is *true*:
- **expired_by** (u64): how long an invoice must be expired (seconds) before we delete it
- **cycle_seconds** (u64): how long an invoice must be expired (seconds) before we delete it
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -49,4 +50,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:b03847eff3fac04edb72f6ef86b31a2d05c077a8771845717a26f463ebed4ae7)
[comment]: # ( SHA256STAMP:dc9caae8f7ca886630f2685ea972fb1113ffcfd5a5e46c2d212c3c4bbc4e5f44)

2
doc/lightning-check.7 generated
View File

@@ -39,4 +39,4 @@ Mark Beckwith \fI<wythe@intrig.com\fR> and Rusty Russell
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:23dcfd6ce780b46a9d700cee5cdf7221702ea2a8c587461b92982172e79ee836
\" SHA256STAMP:3a0e3635cb3ec89d67ec13485220e16e362ed8588213382c8ae5cf4f6f1e0523

3
doc/lightning-check.7.md
View File

@@ -26,6 +26,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **command_to_check** (string): the *command_to_check* argument
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -39,4 +40,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:3dd679aceebf5dca6daabc1b28a0f95c413daa9a689bf55270b38b57f0b17957)
[comment]: # ( SHA256STAMP:47419eb2a6d8d83866773a49170f6fa6047de01435d602fa08487c59d87fb93c)

2
doc/lightning-checkmessage.7 generated
View File

@@ -56,4 +56,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:db4d5955a5e6a9c11ba8ea7717598e867131243c2ccf249eb2b50c803fc5e085
\" SHA256STAMP:48a79a23d402a4f88eadf7db3515c1887534e01931f842380642460bb62f9691

3
doc/lightning-checkmessage.7.md
View File

@@ -32,6 +32,7 @@ If **verified** is *true*:
If **verified** is *false*:
- **pubkey** (pubkey): the *pubkey* (if any) which could have signed this; this is usually not useful!
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -49,4 +50,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:7c0607f4a7d11de4c9d4cac0e56df8475c0a14e9f1ce70d7fc49322a5b184901)
[comment]: # ( SHA256STAMP:eb1ea64cb5e8e16e8e7214f38184b60f2c30d8e7f68db1623fabda665bf1fdec)

2
doc/lightning-close.7 generated
View File

@@ -130,4 +130,4 @@ ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:a28dd05f6b0a86e1f3d748759ae9bcaa0ffc95686fb904969f07def600c23168
\" SHA256STAMP:0af2affd80bd44dcd733b24c17429058c20b0c3ca41d23e06d70487ea759320c

3
doc/lightning-close.7.md
View File

@@ -90,6 +90,7 @@ On success, an object is returned, containing:
If **type** is "mutual" or "unilateral":
- **tx** (hex): the raw bitcoin transaction used to close the channel (if it was open)
- **txid** (txid): the transaction id of the *tx* field
[comment]: # (GENERATE-FROM-SCHEMA-END)
A unilateral close may still occur at any time if the peer did not
@@ -113,4 +114,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:d590b312dff1e1fb4e0bf5540d04bfa4925f6cba51bef6664a642e382ec257d9)
[comment]: # ( SHA256STAMP:db5ba99eb3393f6c55833f0bbace34b3ca504d490a25cb26c53b8790ae325981)

2
doc/lightning-connect.7 generated
View File

@@ -130,4 +130,4 @@ Felix \fI<fixone@gmail.com\fR> is the original author of this manpage\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:47e5ec1e2d3cca8a40bd9b93faff9fd226b4fd481ab4c3c81d67f15dc6f8b839
\" SHA256STAMP:87969bceedc028fb46f2bcbf437dab468ed34df73cb1010d6e7073ce2aa6cc33

3
doc/lightning-connect.7.md
View File

@@ -53,6 +53,7 @@ On success, an object is returned, containing:
If **type** is "ipv4", "ipv6", "torv2" or "torv3":
- **address** (string): address in expected format for **type**
- **port** (u16): port number
[comment]: # (GENERATE-FROM-SCHEMA-END)
ERRORS
@@ -88,4 +89,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:973f366e2f87becdece4ba3b71f9a5156529d7c155bb8fcac0d2b6662a9e467d)
[comment]: # ( SHA256STAMP:306d0966721f20c9a8688f33a030114a5ac095c6218eeb7fafd88fca97b9ee52)

2
doc/lightning-createinvoice.7 generated
View File

@@ -93,4 +93,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:98d930c694694138e37f3db934e2e8d5f4454c6761da5dfae667dd9b869d972c
\" SHA256STAMP:60b18d0cd15a2133f653b4623d5172df2ffa101b38e36add17fd9d2836b0845b

3
doc/lightning-createinvoice.7.md
View File

@@ -46,6 +46,7 @@ On success, an object is returned, containing:
- **payment_preimage** (hex, optional): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
- **local_offer_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters)
- **payer_note** (string, optional): the optional *payer_note* from invoice_request which created this invoice (**experimental-offers** only).
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, an error is returned and no invoice is created. If the
@@ -73,4 +74,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:72b3b200462e9e16c72dd5e3281d35d9ec2eded62e6a7d87e9361573c85dcc32)
[comment]: # ( SHA256STAMP:4582bb142f91497a1bc09a10c745d5c03b5540c6c53675426a6c5c5d079420a9)

2
doc/lightning-createonion.7 generated
View File

@@ -153,4 +153,4 @@ Christian Decker \fI<decker.christian@gmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:cf1acef3ea6f29fc4fb98ee418693d8ffb1b35b4f22345c9e2ce45a91f3efd4d
\" SHA256STAMP:969d90ddb478aaff5ca1416aac1a588af9f2324b775b430169e1a317981811cb

3
doc/lightning-createonion.7.md
View File

@@ -97,6 +97,7 @@ On success, an object is returned, containing:
- **onion** (hex): the onion packet (*onion_size* bytes)
- **shared_secrets** (array of hexs): one shared secret for each node in the *hops* parameter:
- the shared secret with this hop (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
EXAMPLE
@@ -135,4 +136,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
[comment]: # ( SHA256STAMP:68e54caa71beb0445389b61d8b384e40ec91e7569d4e2f2de05ed7612713ee64)
[comment]: # ( SHA256STAMP:a00e746c41b59c6f34fb4a875cf3bf1cded7101f3e4d6d5b35f577d6aca6387f)

2
doc/lightning-datastore.7 generated
View File

@@ -81,4 +81,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:cd66becc88b27328ebf6629d1ea607166b935fcd970c8a4a851e45fc1abe67d8
\" SHA256STAMP:f7c58a75435979f3bc6a3f0019298bebf33c1c199a6c98655778705fc7e86e0e

3
doc/lightning-datastore.7.md
View File

@@ -39,6 +39,7 @@ On success, an object is returned, containing:
- **generation** (u64, optional): The number of times this has been updated
- **hex** (hex, optional): The hex data which has been added to the datastore
- **string** (string, optional): The data as a string, if it's valid utf-8
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error codes may occur:
@@ -64,4 +65,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:a66ad377a86e479704a3f5db06cffbd54bcd34fc9d36724649ace7b1f1e16bce)
[comment]: # ( SHA256STAMP:fd53ebaf7190249460f62aa509010207dbdbc3ae3c90279f49d3c61d4a621c7d)

2
doc/lightning-decode.7 generated
View File

@@ -411,4 +411,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:a455b69caed56afb3bca4263a1cba9fbedbe16a5201b9397cfd0168fb297ea87
\" SHA256STAMP:f07ab7fbb0d031aa5b56560954cf071c481acf0880bf60ec15ff733f8d9e3c01

3
doc/lightning-decode.7.md
View File

@@ -159,6 +159,7 @@ If **type** is "bolt11 invoice", and **valid** is *true*:
- **extra** (array of objects, optional): Any extra fields we didn't know how to parse:
- **tag** (string): The bech32 letter which identifies this field (always 1 characters)
- **data** (string): The bech32 data for this field
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -181,4 +182,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:fbbfc116c23489d4f346b4d5eb06dd922592c543ec68e5a76b6822b2658bd46d)
[comment]: # ( SHA256STAMP:d9e00b0a8c93fecd75aab0688204601a7ceeca0f424012cf0d04ce24b6017aee)

2
doc/lightning-decodepay.7 generated
View File

@@ -107,4 +107,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:38fe5fd558271a8c5d34f3a4dd114d83389545b38b92b89ec0b16da70b73539a
\" SHA256STAMP:2bd0b4c9b0e358ae5dbfde5d6a460fc6d24c397614c120a29c43a5cce4ebf721

3
doc/lightning-decodepay.7.md
View File

@@ -43,6 +43,7 @@ On success, an object is returned, containing:
- **extra** (array of objects, optional): Any extra fields we didn't know how to parse:
- **tag** (string): The bech32 letter which identifies this field (always 1 characters)
- **data** (string): The bech32 data for this field
[comment]: # (GENERATE-FROM-SCHEMA-END)
Technically, the *description* field is optional if a
@@ -68,4 +69,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:435b2a155971979a75be7e9aefc5a686795c3ab210b94af72cf069bd5f3bcefc)
[comment]: # ( SHA256STAMP:b6cf489b74ca9719c8adc7d17115f8109d61e288e77f8b3bed02ac64d7ede08f)

2
doc/lightning-deldatastore.7 generated
View File

@@ -59,4 +59,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:5450068ba0e62da8f46465b4f87cce4b4a59d064efbb13d03b24228790173dcc
\" SHA256STAMP:4329b32593f9d6d70bcd3de3fffa047b09d32fb82e59b923834eb2a11b5e8670

3
doc/lightning-deldatastore.7.md
View File

@@ -25,6 +25,7 @@ On success, an object is returned, containing:
- **generation** (u64, optional): The number of times this has been updated
- **hex** (hex, optional): The hex data which has removed from the datastore
- **string** (string, optional): The data as a string, if it's valid utf-8
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error codes may occur:
@@ -47,4 +48,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:cd6f944965165b0e276da493592f9decb15046150367e06ff3e5b5547517d4b9)
[comment]: # ( SHA256STAMP:b9d59e2d14e91b9440f75fc1577e9f26848821d87d8281e5ca2393adf412fa0d)

2
doc/lightning-delexpiredinvoice.7 generated
View File

@@ -30,4 +30,4 @@ ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:dfb82c8bfb0c1891ac29d98f9eddaf05fb1ae8a9529893003371581e4343e72c
\" SHA256STAMP:1692e45b90818d4d55ad816c13c47abf4aeaee53d8b5de17fe43b8be27fa8e61

3
doc/lightning-delexpiredinvoice.7.md
View File

@@ -20,6 +20,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an empty object is returned.
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -37,4 +38,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:644749218693cab4f48f6557a908aba66ae32f6b769576345f66ad62a6c7e7e0)
[comment]: # ( SHA256STAMP:cfc042477a22946d8f3a07fbecf543a0063a73b54f955b1fc6adc4e8a294ec32)

2
doc/lightning-delinvoice.7 generated
View File

@@ -95,4 +95,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:67e7b489e78df3ad58efad5cad431d5b927a9294b7cbe2ebfef6903fbd2be170
\" SHA256STAMP:5b2e2104fde0b6ff907a46f1993e484089825568edd06b5b87d7bdddc331132e

3
doc/lightning-delinvoice.7.md
View File

@@ -40,6 +40,7 @@ If **status** is "paid":
- **amount_received_msat** (msat): how much was actually received
- **paid_at** (u64): UNIX timestamp of when payment was received
- **payment_preimage** (hex): SHA256 of this is the *payment_hash* offered in the invoice (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
ERRORS
@@ -72,4 +73,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:65c14a16b939461a06d81b0ff41e976ea4c7bf963cccdeba47739fe9ca1658a1)
[comment]: # ( SHA256STAMP:63d72da38a7b758ef7fb7f3a35fbb1c48fd3f3c2a5bffef6559fc98dccd77cf6)

2
doc/lightning-delpay.7 generated
View File

@@ -120,4 +120,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:143436ad1fe8687300cb5ccb433630905a56af81aaf3aa61abfa7b1548af9177
\" SHA256STAMP:0e7079fcdb644918b1dbea73392b5d367a8cb2ee404a9fb4083b5d86053ba469

3
doc/lightning-delpay.7.md
View File

@@ -50,6 +50,7 @@ On success, an object containing **payments** is returned. It is an array of ob
- **bolt11** (string, optional): the bolt11 string (if pay supplied one)
- **bolt12** (string, optional): the bolt12 string (if supplied for pay: **experimental-offers** only).
- **erroronion** (hex, optional): the error onion returned on failure, if any.
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, an error is returned. If the lightning process fails before responding, the
@@ -99,4 +100,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:c3a603b1e43a370ff38a3d9eebe63f8acf26447b024cf5e4bd6f93fe41632529)
[comment]: # ( SHA256STAMP:59b05702a120f92395c71c392d934ccfba343f5ffa98cfc715c657d312d457c2)

2
doc/lightning-disableoffer.7 generated
View File

@@ -80,4 +80,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:e905cb7b8acef73c3ca6bbd41d861234b006aa28185c46b6ba1419c4a0065c3a
\" SHA256STAMP:4566fb3a77342f32ca7ce150c47fa169749dd0cd8eb8e1a512c3004f15084f2a

3
doc/lightning-disableoffer.7.md
View File

@@ -43,6 +43,7 @@ On success, an object is returned, containing:
- **bolt12_unsigned** (string): The bolt12 string representing this offer, without signature
- **used** (boolean): Whether the offer has had an invoice paid / payment made
- **label** (string, optional): The label provided when offer was created
[comment]: # (GENERATE-FROM-SCHEMA-END)
EXAMPLE JSON RESPONSE
@@ -73,4 +74,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:8f0595c22a7684d99da3000cc19b2465991fa1d2ee435a395b7a1527330aa490)
[comment]: # ( SHA256STAMP:75f31b4614cfb2083d7f5c5de17d0892aae8504434da600132668b326fa4e0a4)

2
doc/lightning-disconnect.7 generated
View File

@@ -63,4 +63,4 @@ Michael Hawkins \fI<michael.hawkins@protonmail.com\fR>\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:ce9e367309c8e5cabc9d4ac8dfd878f893dd3b9235c0c4b1a2bb0e431cf5b5f6
\" SHA256STAMP:f967b94a7ef6c5f3cd9b135338bcfd8711d7efe05791fa12f5dde43fa547878c

3
doc/lightning-disconnect.7.md
View File

@@ -35,6 +35,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an empty object is returned.
[comment]: # (GENERATE-FROM-SCHEMA-END)
On error the returned object will contain `code` and `message` properties,
@@ -58,4 +59,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:f807f98a54c194fab710f8a3393e96685fdbd0efa5e178cca54507a70a7a5c20)
[comment]: # ( SHA256STAMP:86b47e27413141ffd6e8b79d83ac4a5cc80e5a7e6f5ba4b0df6825e744f9eea7)

2
doc/lightning-feerates.7 generated
View File

@@ -169,4 +169,4 @@ manpage\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:3c68e2e2b47bc4107d71e263372b3ec3ac77434d7319c670f293d3be88703fe7
\" SHA256STAMP:b60c81ed07764db66f4b8d4486dec8a4a6a83337aec8ab5871adbefce10356b2

3
doc/lightning-feerates.7.md
View File

@@ -73,6 +73,7 @@ On success, an object is returned, containing:
The following warnings may also be returned:
- **warning_missing_feerates**: Some fee estimates are missing
[comment]: # (GENERATE-FROM-SCHEMA-END)
ERRORS
@@ -118,4 +119,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:b7efbc2380ce39e1d8f244a9c16203f034d53b84f8396f4c4fc06973d24cefe4)
[comment]: # ( SHA256STAMP:aa3360c535d2f7e42adead8e78a290a21c5bd88d412f9afa53dfe7388c7edeab)

4
doc/lightning-fetchinvoice.7 generated
View File

@@ -57,7 +57,6 @@ we fail (default, 60 seconds)\.
On success, an object is returned, containing:
.RS
.IP \[bu]
\fBinvoice\fR (string): The BOLT12 invoice we fetched
@@ -98,7 +97,6 @@ On success, an object is returned, containing:
The following error codes may occur:
.RS
.IP \[bu]
-1: Catchall nonspecific error\.
@@ -124,4 +122,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:278c8d05aa5412cd3dd58c2903d23b670e0666f2ac923d914f438d9808bd9ac8
\" SHA256STAMP:73bfed34c90b4689100c54e8521a5b23eca520acb0cbc0509a853d7f996920cc

3
doc/lightning-fetchinvoice.7.md
View File

@@ -63,6 +63,7 @@ On success, an object is returned, containing:
- **endtime** (u64): UNIX timestamp that the next period ends
- **paywindow_start** (u64): UNIX timestamp of the earliest time that the next invoice can be fetched
- **paywindow_end** (u64): UNIX timestamp of the latest time that the next invoice can be fetched
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error codes may occur:
@@ -87,4 +88,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:c98a6dd644a23fb336aa2ce190e15ae602da8b4142afbed28e4243114f679e90)
[comment]: # ( SHA256STAMP:5820acc18bb293035f040e2079363cd2ae03fd31be0c4de78b957502fbd31b4e)

2
doc/lightning-fundchannel.7 generated
View File

@@ -139,4 +139,4 @@ channel parameters (funding limits, channel reserves, fees, etc\.)\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:73f87ce2618c7be8bce775de6e879f88a26e7b2cc48bedb077c29dba725d24eb
\" SHA256STAMP:b45c037781f1b61f191734434c380fb0c3d52ade3c439992a6bc6e8143a4305e

3
doc/lightning-fundchannel.7.md
View File

@@ -89,6 +89,7 @@ On success, an object is returned, containing:
- **outnum** (u32): The 0-based output index showing which output funded the channel
- **channel_id** (hex): The channel_id of the resulting channel (always 64 characters)
- **close_to** (hex, optional): The raw scriptPubkey which mutual close will go to; only present if *close_to* parameter was specified and peer supports `option_upfront_shutdown_script`
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error codes may occur:
@@ -112,4 +113,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:6c8f18b20d695e0b4dba0786f9fc70042a6cc9970aeb7cca2ad1c8fc4c406244)
[comment]: # ( SHA256STAMP:43dfc7b25dad697f3589492a5bdcd895b8edbc2d39e9edb6a9c18313fac9ca50)

2
doc/lightning-fundchannel_cancel.7 generated
View File

@@ -64,4 +64,4 @@ lightning-openchannel_\fBsigned\fR(7), lightning-openchannel_\fBabort\fR(7)
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:b7e57e7a5eec165705d41d34205ac47ce1fe540c0bb9e4b6e36ae2da51322d67
\" SHA256STAMP:f53625b0a2131e1227431a22fda7081f2acfa87f31acb5a5ebceefa6093ecf45

3
doc/lightning-fundchannel_cancel.7.md
View File

@@ -28,6 +28,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **cancelled** (string): A message indicating it was cancelled by RPC
[comment]: # (GENERATE-FROM-SCHEMA-END)
On error the returned object will contain `code` and `message` properties,
@@ -58,4 +59,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:61df28ebb6211155b8be8810c09e7d238b4a6857d5f1c558f30c63df19c2fd4d)
[comment]: # ( SHA256STAMP:9c612f1a2569f40743dff555768e2138ce31f7794eeec06d5ff834461be2e45a)

2
doc/lightning-fundchannel_complete.7 generated
View File

@@ -68,4 +68,4 @@ lightning-openchannel_\fBabort\fR(7)
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:51894a500920df4510ca85db038527f8ef7138fba3afcea0cb1326ac1142f567
\" SHA256STAMP:dcef11ad5a6327df2cf5794620c8e6f13baa025846caa2e4c7f36eea2d6da143

3
doc/lightning-fundchannel_complete.7.md
View File

@@ -30,6 +30,7 @@ RETURN VALUE
On success, an object is returned, containing:
- **channel_id** (hex): The channel_id of the resulting channel (always 64 characters)
- **commitments_secured** (boolean): Indication that channel is safe to use (always *true*)
[comment]: # (GENERATE-FROM-SCHEMA-END)
On error the returned object will contain `code` and `message` properties,
@@ -60,4 +61,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:5d6a53a68f16ec338c75e26e0e7ffbc4390afb771ca636eed4206cb8fdd56943)
[comment]: # ( SHA256STAMP:29c1e2bbc878ffb6b7e41f552afc608af58e335a329c79d09680e8e2995ff0d5)

2
doc/lightning-fundchannel_start.7 generated
View File

@@ -93,4 +93,4 @@ lightning-openchannel_\fBabort\fR(7)
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:2eeea3afea8c76e2cc9d5f449d43f1dbfe8e68edcc4e1ee33cb88d024e5f03de
\" SHA256STAMP:131bcdb525df95f5c2da4fc74cfa0948e1d3bb618c341509cd5ad354aad5edcb

3
doc/lightning-fundchannel_start.7.md
View File

@@ -46,6 +46,7 @@ On success, an object is returned, containing:
- **funding_address** (string): The address to send funding to for the channel
- **scriptpubkey** (hex): The raw scriptPubkey for the address
- **close_to** (hex, optional): The raw scriptPubkey which mutual close will go to; only present if *close_to* parameter was specified and peer supports `option_upfront_shutdown_script`
[comment]: # (GENERATE-FROM-SCHEMA-END)
On error the returned object will contain `code` and `message` properties,
@@ -78,4 +79,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:164e9d5c0adfe28e392e0d7e5401ca301ce1f0fafeb944b56836f0be91754e2f)
[comment]: # ( SHA256STAMP:8d7a9f3cf343f7c72148a5d0b1aa0217cd9ef91e8c618dc2ff1077b15b9f25d4)

2
doc/lightning-funderupdate.7 generated
View File

@@ -182,4 +182,4 @@ The following error code may occur:
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:338d5b9547c47d3fa1ef7ed7a2985d190bba3f1bd911057cda8aa0d0f3ae0cea
\" SHA256STAMP:4c09e1f691bae4f465e9010823079231dc549808b2c65d96c777a39d07bd9bff

3
doc/lightning-funderupdate.7.md
View File

@@ -123,6 +123,7 @@ On success, an object is returned, containing:
- **channel_fee_max_base_msat** (msat, optional): Maximum channel_fee_base_msat we'll charge for routing funds leased on this channel.
- **channel_fee_max_proportional_thousandths** (u32, optional): Maximum channel_fee_proportional_millitionths we'll charge for routing funds leased on this channel, in thousandths.
- **compact_lease** (hex, optional): Compact description of the channel lease parameters.
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error code may occur:
@@ -145,4 +146,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:e09e7cd45085dbcbf9a5ea556a413f004812995506703f91973c1d2671780c5b)
[comment]: # ( SHA256STAMP:ed47e802b2e61f46461f5b65312c8c4de40e64a0970d1d745e59d63201dbfae8)

2
doc/lightning-fundpsbt.7 generated
View File

@@ -141,4 +141,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:91af62e37e674390ba68863ac7d788740f2eb61cbf8ed61465751fcfd9ad4e6a
\" SHA256STAMP:874514015517f7761a848942160729b820443de359046c378ad904c24b5027f2

3
doc/lightning-fundpsbt.7.md
View File

@@ -84,6 +84,7 @@ On success, an object is returned, containing:
- **was_reserved** (boolean): Whether this output was previously reserved (always *false*)
- **reserved** (boolean): Whether this output is now reserved (always *true*)
- **reserved_to_block** (u32): The blockheight the reservation will expire
[comment]: # (GENERATE-FROM-SCHEMA-END)
If *excess_as_change* is true and the excess is enough to cover
@@ -114,4 +115,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:4b3ea2f97eb94e65c752f165a989d99afee0eb8453178bf6a23e4a662fb6abf3)
[comment]: # ( SHA256STAMP:fd84205c50f43a2e55b0adb1c4d0709cd5d909c211148b005674e8e1afffba53)

2
doc/lightning-getinfo.7 generated
View File

@@ -147,4 +147,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:3e1c0f27024c64e02c2a84c093f9de3dbec882c4dacb3fd45b7bc3f4eb98fc5e
\" SHA256STAMP:a086a07b8f98712ce397aae77532b5110bdc8746c65f603966c9f0619990c94d

3
doc/lightning-getinfo.7.md
View File

@@ -52,6 +52,7 @@ On success, an object is returned, containing:
The following warnings may also be returned:
- **warning_bitcoind_sync**: Bitcoind is not up-to-date with network.
- **warning_lightningd_sync**: Lightningd is still loading latest blocks from bitcoind.
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, one of the following error codes may be returned:
@@ -114,4 +115,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:50348a6798a89537bd7a15b1725c479e13f890fe77cbf6d8f0722e91c05eadd1)
[comment]: # ( SHA256STAMP:a41fb9bb8e6e61bec105ff250584ae019dda93d4f97bfff53bc86d57ab6e8607)

2
doc/lightning-getlog.7 generated
View File

@@ -127,4 +127,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:2503c2177e9d87f2d00338f2844f041dceec9458604d228732dade6e38fdf26e
\" SHA256STAMP:d32e85e5edbf39507b876a3e44c81e2e097d6926df6c45e0ec9c75d998e80818

3
doc/lightning-getlog.7.md
View File

@@ -51,6 +51,7 @@ On success, an object is returned, containing:
- **log** (string): The associated log message
- **data** (hex): The IO which occurred
- **node_id** (pubkey, optional): The peer this is associated with
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, one of the following error codes may be returned:
@@ -89,4 +90,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:4336a649aa44151ac41b408fea9e3c68c76a6b3b981925fb79c0e7b0ca73a543)
[comment]: # ( SHA256STAMP:155507c9105521bb4c113232d9bc6fd585cce269303ee8e7e27ea803ca8405cf)

2
doc/lightning-getroute.7 generated
View File

@@ -147,4 +147,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:313ccec881c876d2383b65f9fe0e6f95cfc8bebf3b5739cd5aa439530a98bb53
\" SHA256STAMP:fc6982d81943e6d235a9cfd1584573e3dd4e4da369ffc9da8e3c5fc2e3726370

3
doc/lightning-getroute.7.md
View File

@@ -285,6 +285,7 @@ On success, an object containing **route** is returned. It is an array of objec
- **amount_msat** (msat): The amount expected by the node at the end of this hop
- **delay** (u32): The total CLTV expected by the node at the end of this hop
- **style** (string): The features understood by the destination node (one of "legacy", "tlv")
[comment]: # (GENERATE-FROM-SCHEMA-END)
The final *id* will be the destination *id* given in the input. The
@@ -308,4 +309,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:a65836437a8dd19873cb9ff09a7fcbb2cee5e90f6bf61cabc1215c6dc41e01c3)
[comment]: # ( SHA256STAMP:a297c66baaf5dd18528e4e8bc1bac3348536fed7be474f1c26475b88198a2c1e)

2
doc/lightning-getsharedsecret.7 generated
View File

@@ -94,4 +94,4 @@ SECG SEC-1 ECIES: \fIhttps://secg.org/sec1-v2.pdf\fR
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
.RE
\" SHA256STAMP:15ae6db73b5935de65901d6507c99c15c6dd847965555963c6fcf7cd7a64c74b
\" SHA256STAMP:cff207f06144d00f76e494f84357e8d25609437376403656d6f61e64d49d9da1

3
doc/lightning-getsharedsecret.7.md
View File

@@ -20,6 +20,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **shared_secret** (hex): the SHA-2 of the compressed encoding of the shared secp256k1 point (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
This command may fail if communications with the HSM has a
@@ -90,4 +91,4 @@ RESOURCES
* Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:e7542ba319a25191968aacaa577e0bc29928f6069156eff286c7892444691c74)
[comment]: # ( SHA256STAMP:41cce7390624f69aeac9118887ac751825087e0ef792cff8d5197500af9539ba)

2
doc/lightning-help.7 generated
View File

@@ -78,4 +78,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:69bc1cd80da8ce53c2f258fdcd5b8d0909478629d1d3ceeead0d6a3052484f2e
\" SHA256STAMP:66482cf0107b1ccf2a8b673653c01421fde72933c05c2c095a26d8491d251c9a

3
doc/lightning-help.7.md
View File

@@ -35,6 +35,7 @@ On success, an object is returned, containing:
- **category** (string): the category for this command (useful for grouping)
- **description** (string): a one-line description of the purpose of this command
- **verbose** (string): a full description of this command (including whether it's deprecated)
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, one of the following error codes may be returned:
@@ -66,4 +67,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:89fb5e6d1f3127f8a4331fb00756871565c10e874a24554c60fa1a0e26ca5c8f)
[comment]: # ( SHA256STAMP:2e41227e559aac229adc2cab0f0a2e591ed0ad33218bfe8647ce4022f25332fd)

2
doc/lightning-invoice.7 generated
View File

@@ -138,4 +138,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:1617a52d2c9c5adbee4b410d15889a5f1c32e0a2fb2982dac82c5e74fb028ff3
\" SHA256STAMP:d88271f45513d2811f76d476cc94b3354f3d307448913762eee3069120444793

3
doc/lightning-invoice.7.md
View File

@@ -84,6 +84,7 @@ The following warnings may also be returned:
- **warning_deadends**: there would be enough incoming capacity, but some channels are dead-ends (no other public channels from those peers), so there isn't.
- **warning_private_unused**: there would be enough incoming capacity, but some channels are unannounced and *exposeprivatechannels* is *false*, so there isn't.
- **warning_mpp**: there is sufficient capacity, but not in a single channel, so the payer will have to use multi-part payments.
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, an error is returned and no invoice is created. If the
@@ -112,4 +113,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:cba838098a7f95ab74906f387b2d67777b33ccc40349cb9a8ef1f7c9cc28c6ef)
[comment]: # ( SHA256STAMP:a65026d45e3a70b98c97d838c08748f873aeab20321d930de17fb45cf5022848)

2
doc/lightning-keysend.7 generated
View File

@@ -149,4 +149,4 @@ Christian Decker \fI<decker@blockstream.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:254e1c9b650b8224720894a9fe6c7a0687c77972ec8c67c8b62b3a8e22e095b6
\" SHA256STAMP:04c660a720d5ee16a0385a351eb1a8f8d6c7a5540e00e2e204c07573b7fff7bc

3
doc/lightning-keysend.7.md
View File

@@ -78,6 +78,7 @@ On success, an object is returned, containing:
The following warnings may also be returned:
- **warning_partial_completion**: Not all parts of a multi-part payment have completed
[comment]: # (GENERATE-FROM-SCHEMA-END)
You can monitor the progress and retries of a payment using the lightning-paystatus(7) command.
@@ -113,4 +114,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:787ea6ae933da77756aca49aee68ba996cd54aea53b85ce2e5fcc85841022241)
[comment]: # ( SHA256STAMP:1c931f2ff49a169011ca6c2abde58281570a1db0dfbdca829105999723fe8bb8)

2
doc/lightning-listchannels.7 generated
View File

@@ -98,4 +98,4 @@ BOLT #7:
\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md\fR
.RE
\" SHA256STAMP:b53e67e29b3ac9efe5157e8656ea5af5b2e418559655cc6f39fa99875f52bdc0
\" SHA256STAMP:bf737cfe3773d3482b4d8fb9b3a5fef2b7f43e9218fb8881aed87b6deeb14888

3
doc/lightning-listchannels.7.md
View File

@@ -46,6 +46,7 @@ On success, an object containing **channels** is returned. It is an array of ob
- **htlc_minimum_msat** (msat): The smallest payment *source* will allow via this channel
- **features** (hex): BOLT #9 features bitmap for this channel
- **htlc_maximum_msat** (msat, optional): The largest payment *source* will allow via this channel
[comment]: # (GENERATE-FROM-SCHEMA-END)
If one of *short\_channel\_id*, *source* or *destination* is supplied and no
@@ -76,4 +77,4 @@ Lightning RFC site
- BOLT \#7:
<https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md>
[comment]: # ( SHA256STAMP:b24b9cef75bf6809a85ee5ff9b821ffad68d012dc58b514844675c63c469488e)
[comment]: # ( SHA256STAMP:ab173bcd769b6abd351a670e63be6adfbdfb0c24abcef157c0912b28f86d2250)

4
doc/lightning-listconfigs.7 generated
View File

@@ -148,7 +148,7 @@ On success, an object is returned, containing:
.IP \[bu]
\fBlog-timestamps\fR (boolean, optional): \fBlog-timestamps\fR field from config or cmdline, or default
.IP \[bu]
\fBforce-feerates\fR (string, optional): \fBforce-feerates\fR field from config or cmdline, if any
\fBforce-feerates\fR (string, optional): force-feerate configuration setting, if any
.IP \[bu]
\fBsubdaemon\fR (string, optional): \fBsubdaemon\fR fields from config or cmdline if any (can be more than one)
.IP \[bu]
@@ -270,4 +270,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:4591f6c754162b2dcdf82a36d584a48795752d39a986bc1d39c49e0cdbea440f
\" SHA256STAMP:b6e48314de5642ec61a3e2c989ac0197630c2a3c0e8e6d86020b597679049400

5
doc/lightning-listconfigs.7.md
View File

@@ -84,9 +84,10 @@ On success, an object is returned, containing:
- **log-prefix** (string, optional): `log-prefix` field from config or cmdline, or default
- **log-file** (string, optional): `log-file` field from config or cmdline, or default
- **log-timestamps** (boolean, optional): `log-timestamps` field from config or cmdline, or default
- **force-feerates** (string, optional): `force-feerates` field from config or cmdline, if any
- **force-feerates** (string, optional): force-feerate configuration setting, if any
- **subdaemon** (string, optional): `subdaemon` fields from config or cmdline if any (can be more than one)
- **tor-service-password** (string, optional): `tor-service-password` field from config or cmdline, if any
[comment]: # (GENERATE-FROM-SCHEMA-END)
@@ -204,4 +205,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:ad98179a7b6254a936d4fde179918b6a975e186adcbc396917a0c2ed2888519e)
[comment]: # ( SHA256STAMP:7bb40fc8fac201b32d9701b02596d0fa59eb14a3baf606439cbf96dc11548ed4)

2
doc/lightning-listdatastore.7 generated
View File

@@ -55,4 +55,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:bf75b8d32d0c95b4b5d5b9e8c220afc7c26cf8eef318facc9fb2923fdc3ab93b
\" SHA256STAMP:7e165fb1ff5774c381d2a05d85b51b58dc195ddfa7142928a86cb1e2b6d8f040

3
doc/lightning-listdatastore.7.md
View File

@@ -25,6 +25,7 @@ On success, an object containing **datastore** is returned. It is an array of o
- **generation** (u64, optional): The number of times this has been updated
- **hex** (hex, optional): The hex data from the datastore
- **string** (string, optional): The data as a string, if it's valid utf-8
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error codes may occur:
@@ -45,4 +46,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:ee29b53cad20c6dfe9e19a979816280cc9f778507e5638d1803418284125e4c1)
[comment]: # ( SHA256STAMP:052a5b86380b78fe292fae2f0378b4bd3d200f838a6ad36e0ee8bed619cb9d1c)

2
doc/lightning-listforwards.7 generated
View File

@@ -77,4 +77,4 @@ Rene Pickhardt \fI<r.pickhardt@gmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:d4a2dabe17b640041d019e82549c8cd5492e9c00ccec544b9bf80ff0f2c68ad0
\" SHA256STAMP:66506c6c5ebb9628f20bb6e20d696ac8e4b650d20e48ef8626e877f8447a1544

3
doc/lightning-listforwards.7.md
View File

@@ -40,6 +40,7 @@ If **status** is "settled" or "failed":
If **status** is "local_failed" or "failed":
- **failcode** (u32, optional): the numeric onion code returned
- **failreason** (string, optional): the name of the onion code returned
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -57,4 +58,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:d2fe60f5039f5ad4682c88ce88d513c0ad74d8d4967dd233b399a19e27aac2ee)
[comment]: # ( SHA256STAMP:8d5189bf6f515520f1acd225f372e1123378eab01b032313b5956089a635c2f7)

2
doc/lightning-listfunds.7 generated
View File

@@ -110,4 +110,4 @@ Felix \fI<fixone@gmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:0df04d09e7e7d3344a64f0ecd03186d1499014346d4c37c0d08390328f1f8f04
\" SHA256STAMP:1f231ccc1bb70f63b8af8c80b059f5a90fec51cc5aebac69da5241ca952f3a7f

3
doc/lightning-listfunds.7.md
View File

@@ -49,6 +49,7 @@ On success, an object is returned, containing:
If **state** is "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN" or "ONCHAIN":
- **short_channel_id** (short_channel_id, optional): short channel id of channel (only if funding reached lockin depth before closing)
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -66,4 +67,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:878fab92cc95fdb4680c13f3a2d791e9bbaac3ea732608ece65e684428f7705a)
[comment]: # ( SHA256STAMP:26ae5f60c67eb3a481191ccf109b09ded7dc14d2881898b9f0173ef05a2ef47b)

2
doc/lightning-listinvoices.7 generated
View File

@@ -69,4 +69,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:37d1f6f0b6160b9aa4944f730bec6b04469a9f9a293b59cf8f6663d37073da9c
\" SHA256STAMP:debce16ac6b7bebecb1309884709c5b85fcc952d2fdae462e6f97448cb6c7e51

3
doc/lightning-listinvoices.7.md
View File

@@ -38,6 +38,7 @@ If **status** is "paid":
- **amount_received_msat** (msat): the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay)
- **paid_at** (u64): UNIX timestamp of when it was paid
- **payment_preimage** (hex): proof of payment (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -55,4 +56,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:99dd5cb3f84e8201903e531b601a04dafde3f6eae3f582b538caea7fac20aad0)
[comment]: # ( SHA256STAMP:5fc525b5436359e2271f4131a626bcd1654792d980e478738a0564dcedb58761)

2
doc/lightning-listnodes.7 generated
View File

@@ -125,4 +125,4 @@ FIXME:
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:c2a16277345557e4b7c9a6dbcb00f96e5ae823a54851896117d300d65baac704
\" SHA256STAMP:f391e720e6ebead19c2ad2ad6a75f4aa8646dba6cfa920a52ef433ec6d4f347c

3
doc/lightning-listnodes.7.md
View File

@@ -48,6 +48,7 @@ If **option_will_fund** is present:
- **channel_fee_max_base_msat** (msat): the maximum base routing fee this node will charge during the lease
- **channel_fee_max_proportional_thousandths** (u32): the maximum proportional routing fee this node will charge during the lease (in thousandths, not millionths like channel_update)
- **compact_lease** (hex): the lease as represented in the node_announcement
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, one of the following error codes may be returned:
@@ -92,4 +93,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:0674630a9770ef2da2820e83bc19c1c4a3653955edc7a42cb14fa17299713cfe)
[comment]: # ( SHA256STAMP:158477348efb51a8cf71a595b3d76dde545ab6824958c8a32d4b3dbbbe2c8121)

2
doc/lightning-listoffers.7 generated
View File

@@ -84,4 +84,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:bf83e52cc56aaef876eb1039a6fbbcd9d2e15703c54f33163176c7ba41523261
\" SHA256STAMP:3a0d50b8da9f8f11a4e86cf20017fb35dd79dba9cbb8f740e094b430fd30bd01

3
doc/lightning-listoffers.7.md
View File

@@ -38,6 +38,7 @@ On success, an object containing **offers** is returned. It is an array of obje
- **bolt12_unsigned** (string): the bolt12 encoding of the offer, without signature
- **used** (boolean): True if an associated invoice has been paid
- **label** (string, optional): the (optional) user-specified label
[comment]: # (GENERATE-FROM-SCHEMA-END)
EXAMPLE JSON RESPONSE
@@ -79,4 +80,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:e2b8508c98e6161c45fca91bceb273e6c2865cec0e1761dde85f8f2dd6670491)
[comment]: # ( SHA256STAMP:12402a6d1f50df80e6efa5f10de38911385e2e5386e67d38d15b7045d661c78a)

2
doc/lightning-listpays.7 generated
View File

@@ -74,4 +74,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:9b593ed02c10b34ae6f36f91963da0a244df0c3963aaa990e7477008fd3af18d
\" SHA256STAMP:29837ba48de2dd29a3630fc4717cd8a3a8abf3e8f4d8e75fd6fc4f2e7467b455

3
doc/lightning-listpays.7.md
View File

@@ -35,6 +35,7 @@ If **status** is "complete":
If **status** is "failed":
- **erroronion** (hex, optional): the error onion returned on failure, if any.
[comment]: # (GENERATE-FROM-SCHEMA-END)
The returned array is ordered by increasing **created_at** fields.
@@ -54,4 +55,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:22b3a2437901da705b706792b9e263ab65e002835ad3f5735895f8d971699c3b)
[comment]: # ( SHA256STAMP:3599920cbe998244ce7583961cab022f236685c242c781e8767d74709ce4e3d2)

2
doc/lightning-listpeers.7 generated
View File

@@ -644,4 +644,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR Lightning
RFC site (BOLT #9):
\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md\fR
\" SHA256STAMP:16d808a5a346bb7dbffc263846617d33c74fdc6e0d5165f462d634ed8409f882
\" SHA256STAMP:494bfc944d687593469fd420566a08dceeb84765e771e8e2d67cce4392d9b154

3
doc/lightning-listpeers.7.md
View File

@@ -155,6 +155,7 @@ If **connected** is *true*:
- **netaddr** (array of strings): A single entry array:
- address, e.g. 1.2.3.4:1234
- **features** (hex): bitmap of BOLT #9 features from peer's INIT message
[comment]: # (GENERATE-FROM-SCHEMA-END)
On success, an object with a "peers" key is returned containing a list
@@ -375,4 +376,4 @@ Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9):
<https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md>
[comment]: # ( SHA256STAMP:91d30768a795456c75c72cf499df529ae8dbcc8088d06d1ed27150272425ab37)
[comment]: # ( SHA256STAMP:7d11de5d2ff844d6f9e4b8093bd135c7a38d17f159ba7aca4821c5365ca11e71)

2
doc/lightning-listsendpays.7 generated
View File

@@ -75,4 +75,4 @@ responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:01f2a7682c9af98704b04b2b5efe695ae6abc0cf41e13a4bc36c14e8b9662822
\" SHA256STAMP:fa256733033686f8fd53735ba69f34b3fd72c463577e3ad1dfa942662638e42e

3
doc/lightning-listsendpays.7.md
View File

@@ -40,6 +40,7 @@ If **status** is "complete":
If **status** is "failed":
- **erroronion** (hex, optional): the onion message returned
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
@@ -58,4 +59,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:db8e97cc84246f4e836ac7b2f39e265deb51cb0adacfcca8e05bb7cb9c3480de)
[comment]: # ( SHA256STAMP:e6a71b4e168fe64b774dc4738a46470edf00b4566ae2927166621ba79f89ca79)

2
doc/lightning-listtransactions.7 generated
View File

@@ -138,4 +138,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:85b8fd1df3815845e8418d142a0e62589fd386784dc6fe90150db1e43519c4ce
\" SHA256STAMP:ce171bdb7bccae8ec12ceb172e4939c4b903462d3744ff56e6939388de92ef91

3
doc/lightning-listtransactions.7.md
View File

@@ -47,6 +47,7 @@ On success, an object containing **transactions** is returned. It is an array o
- **type** (array of strings, optional):
- Reason we care about this transaction (*EXPERIMENTAL_FEATURES* only) (one of "theirs", "deposit", "withdraw", "channel_funding", "channel_mutual_close", "channel_unilateral_close", "channel_sweep", "channel_htlc_success", "channel_htlc_timeout", "channel_penalty", "channel_unilateral_cheat")
- **channel** (short_channel_id, optional): the channel this transaction is associated with (*EXPERIMENTAL_FEATURES* only)
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, one of the following error codes may be returned:
@@ -103,4 +104,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:33483dcd0b98f2e10aa030080f8367fb814c510b601fc8ff396d0122236d750e)
[comment]: # ( SHA256STAMP:f170fb4e2ab3bf44d6159f9bcf5445102db3774f19cb61e7b8c68acfaac51688)

2
doc/lightning-multifundchannel.7 generated
View File

@@ -212,4 +212,4 @@ ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:a01cd5e8fa80e29fac6a23bc2907207a59714455b15435d4152b999f82da173b
\" SHA256STAMP:dfbc1c3daffa0e935343c05f35e99e517ef828bd4e887a3306af52294e0e938d

3
doc/lightning-multifundchannel.7.md
View File

@@ -113,6 +113,7 @@ On success, an object is returned, containing:
- **code** (integer): JSON error code from failing stage
- **message** (string): Message from stage
- **data**: Additional error data
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, none of the channels are created.
@@ -157,4 +158,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:96f061609558a3baa93a2d212ef9de0d5a3cf3217504ddd42b99bf2bf2249e2c)
[comment]: # ( SHA256STAMP:acad87896396156dff379973010ed1243af8bbb3ee5cfcc052ca177e0725bce3)

2
doc/lightning-multiwithdraw.7 generated
View File

@@ -80,4 +80,4 @@ ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:93a4f65edb728619e1c28906940cd0ca32bff7c80eb01ff9577c20965061b7d1
\" SHA256STAMP:0d0e1d364c4e436e33d3c15d4af7198591437cc2257ec646f3ebec0b90f54046

3
doc/lightning-multiwithdraw.7.md
View File

@@ -44,6 +44,7 @@ RETURN VALUE
On success, an object is returned, containing:
- **tx** (hex): The raw transaction which was sent
- **txid** (txid): The txid of the **tx**
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, an error is reported and the withdrawal transaction is not
@@ -70,4 +71,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:5f289ef109eba26ca686ca0ebde3fed38cd52240ad3ee30e373719872927cfe6)
[comment]: # ( SHA256STAMP:0b374dbb074a5eed153d6a153526c20bd1681f67245dfc42a8ec3a2f1510c6b5)

2
doc/lightning-newaddr.7 generated
View File

@@ -53,4 +53,4 @@ Felix \fI<fixone@gmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:4e2f3697f7a6841d28997583e5fc4b709533b7be73c72428e1af361d0022cb1a
\" SHA256STAMP:f18774bcca3a39c5608f6623280e902b0e0316626e49c0e0ac759c619167bc7e

3
doc/lightning-newaddr.7.md
View File

@@ -31,6 +31,7 @@ RETURN VALUE
On success, an object is returned, containing:
- **bech32** (string, optional): The bech32 (native segwit) address
- **p2sh-segwit** (string, optional): The p2sh-wrapped address
[comment]: # (GENERATE-FROM-SCHEMA-END)
ERRORS
@@ -54,4 +55,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:44731ac3afb4fc3982dff2ae94e360f9addc5712e36b021c880180c68e3ed476)
[comment]: # ( SHA256STAMP:af64240aaa930f899eda7b146a5cdc22abb7572d20ff6f9012097a84b3affeaa)

2
doc/lightning-notifications.7 generated
View File

@@ -112,4 +112,4 @@ Rusty Russell \fI<rusty@blockstream.com\fR> wrote the initial version of this ma
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:bc568c59f4cccbd3f8de1a2c57309b3b07deeabe1dabf1bfbe289973ede7921b
\" SHA256STAMP:651537a5b1e0c017bf362443ea346a762be510d94dffb5da761bdfc56047242a

3
doc/lightning-notifications.7.md
View File

@@ -54,6 +54,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an empty object is returned.
[comment]: # (GENERATE-FROM-SCHEMA-END)
On success, if *enable* was *true*, notifications will be forwarded
@@ -101,4 +102,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:f807f98a54c194fab710f8a3393e96685fdbd0efa5e178cca54507a70a7a5c20)
[comment]: # ( SHA256STAMP:86b47e27413141ffd6e8b79d83ac4a5cc80e5a7e6f5ba4b0df6825e744f9eea7)

2
doc/lightning-offer.7 generated
View File

@@ -159,4 +159,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:e6b321a49c0613e9812343cdc252850930569e63e19291afbcbf6a4a135d2552
\" SHA256STAMP:caa067d4f2b43e99445f165545fe98593402fbb6f10d939067ed2bc963e3fdc3

3
doc/lightning-offer.7.md
View File

@@ -104,6 +104,7 @@ On success, an object is returned, containing:
- **used** (boolean): True if an associated invoice has been paid
- **created** (boolean): false if the offer already existed
- **label** (string, optional): the (optional) user-specified label
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, an error is returned and no offer is created. If the
@@ -133,4 +134,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:53f1460e28d45129b2c00b7116c87eb47a5b717f7912f499e864f4aa28b320fa)
[comment]: # ( SHA256STAMP:c35ff51ba9c0f373c22cbf42504d1328299e5af0e37e7ae3f80324ff2c10100a)

2
doc/lightning-offerout.7 generated
View File

@@ -115,4 +115,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:4998ef3e06f37823c969a524fc3deb96b58eb2babee560df27e3f006fc535186
\" SHA256STAMP:375120b2e154a5421745b2e0ab0e4f869f375e68cdd78e42d4a6ff0343064b41

3
doc/lightning-offerout.7.md
View File

@@ -63,6 +63,7 @@ On success, an object is returned, containing:
- **used** (boolean): True if an incoming invoice has been paid (always *false*)
- **created** (boolean): false if the offer already existed
- **label** (string, optional): the (optional) user-specified label
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, an error is returned and no offer is created. If the
@@ -98,4 +99,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:14fada9336956a08b6d55c4ce01fcb62726cbdef9a065f1966335f61c4e91ce5)
[comment]: # ( SHA256STAMP:99a4e1cdf68ec7bcf05b9d6b088b8a84f01d085fae5a1565192f488ff8484570)

Some files were not shown because too many files have changed in this diff Show More