diff --git a/doc/lightning-autocleaninvoice.7.md b/doc/lightning-autocleaninvoice.7.md index 270f63b87..9cb826748 100644 --- a/doc/lightning-autocleaninvoice.7.md +++ b/doc/lightning-autocleaninvoice.7.md @@ -4,7 +4,7 @@ lightning-autocleaninvoice -- Set up auto-delete of expired invoice SYNOPSIS -------- -**autocleaninvoice** \[*cycle\_seconds*\] \[*expired\_by*\] +**autocleaninvoice** [*cycle\_seconds*] [*expired\_by*] DESCRIPTION ----------- diff --git a/doc/lightning-check.7.md b/doc/lightning-check.7.md index a15bba93e..500e2aa43 100644 --- a/doc/lightning-check.7.md +++ b/doc/lightning-check.7.md @@ -4,7 +4,7 @@ lightning-check -- Command for verifying parameters SYNOPSIS -------- -**check** *command\_to\_check* \[*parameters*\] +**check** *command\_to\_check* [*parameters*] DESCRIPTION ----------- diff --git a/doc/lightning-checkmessage.7.md b/doc/lightning-checkmessage.7.md index da056b3fc..9ccf3c13e 100644 --- a/doc/lightning-checkmessage.7.md +++ b/doc/lightning-checkmessage.7.md @@ -4,7 +4,7 @@ lightning-checkmessage -- Command to check if a signature is from a node SYNOPSIS -------- -**checkmessage** *message* *zbase* \[*pubkey*\] +**checkmessage** *message* *zbase* [*pubkey*] DESCRIPTION ----------- diff --git a/doc/lightning-close.7.md b/doc/lightning-close.7.md index c88b6b87f..5f05818d5 100644 --- a/doc/lightning-close.7.md +++ b/doc/lightning-close.7.md @@ -4,7 +4,7 @@ lightning-close -- Command for closing channels with direct peers SYNOPSIS -------- -**close** *id* \[*unilateraltimeout*\] \[*destination*\] \[*fee_negotiation_step*\] \[*wrong_funding*\] \[*force_lease_closed*\] [\*feerange\*] +**close** *id* [*unilateraltimeout*] [*destination*] [*fee_negotiation_step*] [*wrong_funding*] [*force_lease_closed*] [\*feerange\*] DESCRIPTION ----------- diff --git a/doc/lightning-connect.7.md b/doc/lightning-connect.7.md index d2f5a17e4..02a85f1c0 100644 --- a/doc/lightning-connect.7.md +++ b/doc/lightning-connect.7.md @@ -4,7 +4,7 @@ lightning-connect -- Command for connecting to another lightning node SYNOPSIS -------- -**connect** *id* \[*host*\] \[*port*\] +**connect** *id* [*host*] [*port*] DESCRIPTION ----------- diff --git a/doc/lightning-createonion.7.md b/doc/lightning-createonion.7.md index b35d33836..9eed31890 100644 --- a/doc/lightning-createonion.7.md +++ b/doc/lightning-createonion.7.md @@ -4,7 +4,7 @@ lightning-createonion -- Low-level command to create a custom onion SYNOPSIS -------- -**createonion** *hops* *assocdata* \[*session_key*\] \[*onion_size*\] +**createonion** *hops* *assocdata* [*session_key*] [*onion_size*] DESCRIPTION ----------- diff --git a/doc/lightning-datastore.7.md b/doc/lightning-datastore.7.md index 27704c00f..f94e706aa 100644 --- a/doc/lightning-datastore.7.md +++ b/doc/lightning-datastore.7.md @@ -4,7 +4,7 @@ lightning-datastore -- Command for storing (plugin) data SYNOPSIS -------- -**datastore** *key* \[*string*\] \[*hex*\] \[*mode*\] \[*generation*\] +**datastore** *key* [*string*] [*hex*] [*mode*] [*generation*] DESCRIPTION ----------- diff --git a/doc/lightning-decodepay.7.md b/doc/lightning-decodepay.7.md index e74da14f6..bbdc75c04 100644 --- a/doc/lightning-decodepay.7.md +++ b/doc/lightning-decodepay.7.md @@ -4,7 +4,7 @@ lightning-decodepay -- Command for decoding a bolt11 string (low-level) SYNOPSIS -------- -**decodepay** *bolt11* \[*description*\] +**decodepay** *bolt11* [*description*] DESCRIPTION ----------- diff --git a/doc/lightning-deldatastore.7.md b/doc/lightning-deldatastore.7.md index af63fc805..477887641 100644 --- a/doc/lightning-deldatastore.7.md +++ b/doc/lightning-deldatastore.7.md @@ -4,7 +4,7 @@ lightning-deldatastore -- Command for removing (plugin) data SYNOPSIS -------- -**deldatastore** *key* \[*generation*\] +**deldatastore** *key* [*generation*] DESCRIPTION ----------- diff --git a/doc/lightning-delexpiredinvoice.7.md b/doc/lightning-delexpiredinvoice.7.md index 664661ac6..45cf12cbc 100644 --- a/doc/lightning-delexpiredinvoice.7.md +++ b/doc/lightning-delexpiredinvoice.7.md @@ -4,7 +4,7 @@ lightning-delexpiredinvoice -- Command for removing expired invoices SYNOPSIS -------- -**delexpiredinvoice** \[*maxexpirytime*\] +**delexpiredinvoice** [*maxexpirytime*] DESCRIPTION ----------- diff --git a/doc/lightning-disconnect.7.md b/doc/lightning-disconnect.7.md index 19424cdef..d1ec7f708 100644 --- a/doc/lightning-disconnect.7.md +++ b/doc/lightning-disconnect.7.md @@ -4,7 +4,7 @@ lightning-disconnect -- Command for disconnecting from another lightning node SYNOPSIS -------- -**disconnect** *id* \[*force*\] +**disconnect** *id* [*force*] DESCRIPTION ----------- diff --git a/doc/lightning-fetchinvoice.7.md b/doc/lightning-fetchinvoice.7.md index bb7c3f34c..799bde5f6 100644 --- a/doc/lightning-fetchinvoice.7.md +++ b/doc/lightning-fetchinvoice.7.md @@ -6,7 +6,7 @@ SYNOPSIS **(WARNING: experimental-offers only)** -**fetchinvoice** *offer* \[*msatoshi*\] \[*quantity*\] \[*recurrence_counter*\] \[*recurrence_start*\] \[*recurrence_label*\] \[*timeout*\] \[*payer_note*\] +**fetchinvoice** *offer* [*msatoshi*] [*quantity*] [*recurrence_counter*] [*recurrence_start*] [*recurrence_label*] [*timeout*] [*payer_note*] DESCRIPTION ----------- diff --git a/doc/lightning-fundchannel.7.md b/doc/lightning-fundchannel.7.md index 1861d3b57..229e48424 100644 --- a/doc/lightning-fundchannel.7.md +++ b/doc/lightning-fundchannel.7.md @@ -4,8 +4,8 @@ lightning-fundchannel -- Command for establishing a lightning channel SYNOPSIS -------- -**fundchannel** *id* *amount* \[*feerate*\] \[*announce*\] \[*minconf*\] -\[*utxos*\] \[*push_msat*\] \[*close_to*\] \[*request_amt*\] \[*compact_lease*\] +**fundchannel** *id* *amount* [*feerate*] [*announce*] [*minconf*] +[*utxos*] [*push_msat*] [*close_to*] [*request_amt*] [*compact_lease*] DESCRIPTION ----------- diff --git a/doc/lightning-fundchannel_start.7.md b/doc/lightning-fundchannel_start.7.md index af9694d4b..1a0da9c74 100644 --- a/doc/lightning-fundchannel_start.7.md +++ b/doc/lightning-fundchannel_start.7.md @@ -4,7 +4,7 @@ lightning-fundchannel\_start -- Command for initiating channel establishment for SYNOPSIS -------- -**fundchannel\_start** *id* *amount* \[*feerate* *announce* *close_to* *push_msat*\] +**fundchannel\_start** *id* *amount* [*feerate* *announce* *close_to* *push_msat*] DESCRIPTION ----------- diff --git a/doc/lightning-funderupdate.7.md b/doc/lightning-funderupdate.7.md index cec36163b..700ecb9bf 100644 --- a/doc/lightning-funderupdate.7.md +++ b/doc/lightning-funderupdate.7.md @@ -4,7 +4,7 @@ lightning-funderupdate -- Command for adjusting node funding v2 channels SYNOPSIS -------- -**funderupdate** \[*policy*\] \[*policy_mod*\] \[*leases_only*\] \[*min_their_funding_msat*\] \[*max_their_funding_msat*\] \[*per_channel_min_msat*\] \[*per_channel_max_msat*\] \[*reserve_tank_msat*\] \[*fuzz_percent*\] \[*fund_probability*\] \[*lease_fee_base_msat*\] \[*lease_fee_basis*\] \[*funding_weight*\] \[*channel_fee_max_base_msat*\] \[*channel_fee_max_proportional_thousandths*\] \[*compact_lease*\] +**funderupdate** [*policy*] [*policy_mod*] [*leases_only*] [*min_their_funding_msat*] [*max_their_funding_msat*] [*per_channel_min_msat*] [*per_channel_max_msat*] [*reserve_tank_msat*] [*fuzz_percent*] [*fund_probability*] [*lease_fee_base_msat*] [*lease_fee_basis*] [*funding_weight*] [*channel_fee_max_base_msat*] [*channel_fee_max_proportional_thousandths*] [*compact_lease*] NOTE: Must have --experimental-dual-fund enabled for these settings to take effect. diff --git a/doc/lightning-fundpsbt.7.md b/doc/lightning-fundpsbt.7.md index 4dfca65eb..553efdec3 100644 --- a/doc/lightning-fundpsbt.7.md +++ b/doc/lightning-fundpsbt.7.md @@ -4,7 +4,7 @@ lightning-fundpsbt -- Command to populate PSBT inputs from the wallet SYNOPSIS -------- -**fundpsbt** *satoshi* *feerate* *startweight* \[*minconf*\] \[*reserve*\] \[*locktime*\] \[*min_witness_weight*\] \[*excess_as_change*\] +**fundpsbt** *satoshi* *feerate* *startweight* [*minconf*] [*reserve*] [*locktime*] [*min_witness_weight*] [*excess_as_change*] DESCRIPTION ----------- diff --git a/doc/lightning-getlog.7.md b/doc/lightning-getlog.7.md index 3637fe010..8007f70ae 100644 --- a/doc/lightning-getlog.7.md +++ b/doc/lightning-getlog.7.md @@ -4,7 +4,7 @@ lightning-getlog -- Command to show logs. SYNOPSIS -------- -**getlog** \[*level*\] +**getlog** [*level*] DESCRIPTION ----------- diff --git a/doc/lightning-getroute.7.md b/doc/lightning-getroute.7.md index f597678cd..e490542a3 100644 --- a/doc/lightning-getroute.7.md +++ b/doc/lightning-getroute.7.md @@ -4,8 +4,8 @@ lightning-getroute -- Command for routing a payment (low-level) SYNOPSIS -------- -**getroute** *id* *msatoshi* *riskfactor* \[*cltv*\] \[*fromid*\] -\[*fuzzpercent*\] \[*exclude*\] \[*maxhops*\] +**getroute** *id* *msatoshi* *riskfactor* [*cltv*] [*fromid*] +[*fuzzpercent*] [*exclude*] [*maxhops*] DESCRIPTION ----------- @@ -39,8 +39,8 @@ route generated. 0.0 means the exact fee of that channel is used, while 100.0 means the fee used might be from 0 to twice the actual fee. The default is 5.0, or up to 5% fee distortion. -*exclude* is a JSON array of short-channel-id/direction (e.g. \[ -"564334x877x1/0", "564195x1292x0/1" \]) or node-id which should be excluded +*exclude* is a JSON array of short-channel-id/direction (e.g. [ +"564334x877x1/0", "564195x1292x0/1" ]) or node-id which should be excluded from consideration for routing. The default is not to exclude any channels or nodes. Note if the source or destination is excluded, the command result is undefined. diff --git a/doc/lightning-help.7.md b/doc/lightning-help.7.md index 2bccd6cc7..24fdf73bb 100644 --- a/doc/lightning-help.7.md +++ b/doc/lightning-help.7.md @@ -4,7 +4,7 @@ lightning-help -- Command to return all information about RPC commands. SYNOPSIS -------- -**help** \[*command\*] +**help** [*command\*] DESCRIPTION ----------- diff --git a/doc/lightning-invoice.7.md b/doc/lightning-invoice.7.md index 692eea431..5347625ac 100644 --- a/doc/lightning-invoice.7.md +++ b/doc/lightning-invoice.7.md @@ -4,8 +4,8 @@ lightning-invoice -- Command for accepting payments SYNOPSIS -------- -**invoice** *msatoshi* *label* *description* \[*expiry*\] -\[*fallbacks*\] \[*preimage*\] \[*exposeprivatechannels*\] \[*cltv*\] +**invoice** *msatoshi* *label* *description* [*expiry*] +[*fallbacks*] [*preimage*] [*exposeprivatechannels*] [*cltv*] DESCRIPTION ----------- diff --git a/doc/lightning-keysend.7.md b/doc/lightning-keysend.7.md index 559d9813f..f5c613202 100644 --- a/doc/lightning-keysend.7.md +++ b/doc/lightning-keysend.7.md @@ -4,7 +4,7 @@ lightning-keysend -- Send funds to a node without an invoice SYNOPSIS -------- -**keysend** *destination* *msatoshi* \[*label*\] \[*maxfeepercent*\] \[*retry\_for*\] \[*maxdelay*\] \[*exemptfee*\] +**keysend** *destination* *msatoshi* [*label*] [*maxfeepercent*] [*retry\_for*] [*maxdelay*] [*exemptfee*] DESCRIPTION ----------- diff --git a/doc/lightning-listchannels.7.md b/doc/lightning-listchannels.7.md index 668b060fb..7c9063840 100644 --- a/doc/lightning-listchannels.7.md +++ b/doc/lightning-listchannels.7.md @@ -4,7 +4,7 @@ lightning-listchannels -- Command to query active lightning channels in the enti SYNOPSIS -------- -**listchannels** \[*short\_channel\_id*\] \[*source*\] \[*destination*\] +**listchannels** [*short\_channel\_id*] [*source*] [*destination*] DESCRIPTION ----------- diff --git a/doc/lightning-listconfigs.7 b/doc/lightning-listconfigs.7 index 5818f32f4..d946d1e03 100644 --- a/doc/lightning-listconfigs.7 +++ b/doc/lightning-listconfigs.7 @@ -3,7 +3,7 @@ lightning-listconfigs - Command to list all configuration options\. .SH SYNOPSIS -\fBlistconfigs\fR [config] +\fBlistconfigs\fR [\fIconfig\fR] .SH DESCRIPTION @@ -276,4 +276,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:37b3fd1b2c5b2c903c25579f96d0bb4116955f3aebbf6bbb97f8a62e352cf440 +\" SHA256STAMP:759090c2619cd40cba89b670ea16d4885f9aea520588d30d0ee8041369d5b91e diff --git a/doc/lightning-listconfigs.7.md b/doc/lightning-listconfigs.7.md index 26a80c0e5..c6cdf6290 100644 --- a/doc/lightning-listconfigs.7.md +++ b/doc/lightning-listconfigs.7.md @@ -4,7 +4,7 @@ lightning-listconfigs -- Command to list all configuration options. SYNOPSIS -------- -**listconfigs** \[*config*\] +**listconfigs** [*config*] DESCRIPTION ----------- diff --git a/doc/lightning-listdatastore.7.md b/doc/lightning-listdatastore.7.md index 09f365b5f..316e719e9 100644 --- a/doc/lightning-listdatastore.7.md +++ b/doc/lightning-listdatastore.7.md @@ -4,7 +4,7 @@ lightning-listdatastore -- Command for listing (plugin) data SYNOPSIS -------- -**listdatastore** \[*key*\] +**listdatastore** [*key*] DESCRIPTION ----------- diff --git a/doc/lightning-listforwards.7.md b/doc/lightning-listforwards.7.md index 1ff8b2b70..590150a56 100644 --- a/doc/lightning-listforwards.7.md +++ b/doc/lightning-listforwards.7.md @@ -4,7 +4,7 @@ lightning-listforwards -- Command showing all htlcs and their information SYNOPSIS -------- -**listforwards** \[*status*\] \[*in_channel*\] \[*out_channel*\] +**listforwards** [*status*] [*in_channel*] [*out_channel*] DESCRIPTION ----------- diff --git a/doc/lightning-listfunds.7.md b/doc/lightning-listfunds.7.md index e049eeaa1..0712aafde 100644 --- a/doc/lightning-listfunds.7.md +++ b/doc/lightning-listfunds.7.md @@ -4,7 +4,7 @@ lightning-listfunds -- Command showing all funds currently managed by the c-ligh SYNOPSIS -------- -**listfunds** \[*spent*\] +**listfunds** [*spent*] DESCRIPTION ----------- diff --git a/doc/lightning-listinvoices.7.md b/doc/lightning-listinvoices.7.md index 763a8d232..059d460fd 100644 --- a/doc/lightning-listinvoices.7.md +++ b/doc/lightning-listinvoices.7.md @@ -4,7 +4,7 @@ lightning-listinvoices -- Command for querying invoice status SYNOPSIS -------- -**listinvoices** \[*label*\] \[*invstring*\] \[*payment_hash*\] \[*offer_id*\] +**listinvoices** [*label*] [*invstring*] [*payment_hash*] [*offer_id*] DESCRIPTION ----------- diff --git a/doc/lightning-listnodes.7.md b/doc/lightning-listnodes.7.md index c2f040600..b386c5669 100644 --- a/doc/lightning-listnodes.7.md +++ b/doc/lightning-listnodes.7.md @@ -4,7 +4,7 @@ lightning-listnodes -- Command to get the list of nodes in the known network. SYNOPSIS -------- -**listnodes** \[*id*\] +**listnodes** [*id*] DESCRIPTION ----------- diff --git a/doc/lightning-listoffers.7.md b/doc/lightning-listoffers.7.md index baca636d2..7a5b76965 100644 --- a/doc/lightning-listoffers.7.md +++ b/doc/lightning-listoffers.7.md @@ -5,7 +5,7 @@ SYNOPSIS -------- **(WARNING: experimental-offers only)** -**listoffers** \[*offer_id*\] \[*active_only*\] +**listoffers** [*offer_id*] [*active_only*] DESCRIPTION ----------- diff --git a/doc/lightning-listpays.7.md b/doc/lightning-listpays.7.md index 0a0805784..f4c2edf82 100644 --- a/doc/lightning-listpays.7.md +++ b/doc/lightning-listpays.7.md @@ -4,7 +4,7 @@ lightning-listpays -- Command for querying payment status SYNOPSIS -------- -**listpays** \[*bolt11*\] \[*payment_hash*\] \[*status*\] +**listpays** [*bolt11*] [*payment_hash*] [*status*] DESCRIPTION ----------- diff --git a/doc/lightning-listpeers.7.md b/doc/lightning-listpeers.7.md index fc37753e2..8e4862b1e 100644 --- a/doc/lightning-listpeers.7.md +++ b/doc/lightning-listpeers.7.md @@ -4,7 +4,7 @@ lightning-listpeers -- Command returning data on connected lightning nodes SYNOPSIS -------- -**listpeers** \[*id*\] \[*level*\] +**listpeers** [*id*] [*level*] DESCRIPTION ----------- diff --git a/doc/lightning-listsendpays.7.md b/doc/lightning-listsendpays.7.md index 941078994..9cd0034cb 100644 --- a/doc/lightning-listsendpays.7.md +++ b/doc/lightning-listsendpays.7.md @@ -4,7 +4,7 @@ lightning-listsendpays -- Low-level command for querying sendpay status SYNOPSIS -------- -**listsendpays** \[*bolt11*\] \[*payment\_hash*\] \[*status*\] +**listsendpays** [*bolt11*] [*payment\_hash*] [*status*] DESCRIPTION ----------- diff --git a/doc/lightning-multifundchannel.7.md b/doc/lightning-multifundchannel.7.md index e42b0a228..d61fceac5 100644 --- a/doc/lightning-multifundchannel.7.md +++ b/doc/lightning-multifundchannel.7.md @@ -4,7 +4,7 @@ lightning-multifundchannel -- Command for establishing many lightning channels SYNOPSIS -------- -**multifundchannel** *destinations* \[*feerate*\] \[*minconf*\] \[*utxos*\] \[*minchannels*\] \[*commitment_feerate*\] +**multifundchannel** *destinations* [*feerate*] [*minconf*] [*utxos*] [*minchannels*] [*commitment_feerate*] DESCRIPTION ----------- diff --git a/doc/lightning-multiwithdraw.7.md b/doc/lightning-multiwithdraw.7.md index 52b5379d8..28be3855b 100644 --- a/doc/lightning-multiwithdraw.7.md +++ b/doc/lightning-multiwithdraw.7.md @@ -4,7 +4,7 @@ lightning-multiwithdraw -- Command for withdrawing to multiple addresses SYNOPSIS -------- -**multiwithdraw** *outputs* \[*feerate*\] \[*minconf*\] \[*utxos*\] +**multiwithdraw** *outputs* [*feerate*] [*minconf*] [*utxos*] DESCRIPTION ----------- diff --git a/doc/lightning-newaddr.7.md b/doc/lightning-newaddr.7.md index e2dda2a4c..9d0a95532 100644 --- a/doc/lightning-newaddr.7.md +++ b/doc/lightning-newaddr.7.md @@ -4,7 +4,7 @@ lightning-newaddr -- Command for generating a new address to be used by c-lightn SYNOPSIS -------- -**newaddr** \[ *addresstype* \] +**newaddr** [ *addresstype* ] DESCRIPTION ----------- diff --git a/doc/lightning-offer.7.md b/doc/lightning-offer.7.md index 0fa3a4218..22b903efb 100644 --- a/doc/lightning-offer.7.md +++ b/doc/lightning-offer.7.md @@ -6,7 +6,7 @@ SYNOPSIS **(WARNING: experimental-offers only)** -**offer** *amount* *description* \[*issuer*\] \[*label*\] \[*quantity_min*\] \[*quantity_max*\] \[*absolute_expiry*\] \[*recurrence*\] \[*recurrence_base*\] \[*recurrence_paywindow*\] \[*recurrence_limit*\] \[*single_use*\] +**offer** *amount* *description* [*issuer*] [*label*] [*quantity_min*] [*quantity_max*] [*absolute_expiry*] [*recurrence*] [*recurrence_base*] [*recurrence_paywindow*] [*recurrence_limit*] [*single_use*] DESCRIPTION ----------- @@ -69,7 +69,7 @@ period. This is encoded in the offer. e.g. "@1609459200" indicates you must start paying on the 1st January 2021. *recurrence_paywindow* is an optional argument of form -'-time+time\[%\]'. The first time is the number of seconds before the +'-time+time[%]'. The first time is the number of seconds before the start of a period in which an invoice and payment is valid, the second time is the number of seconds after the start of the period. For example *-604800+86400* means you can fetch an pay the invoice 4 weeks diff --git a/doc/lightning-offerout.7.md b/doc/lightning-offerout.7.md index a70db8707..e74589c02 100644 --- a/doc/lightning-offerout.7.md +++ b/doc/lightning-offerout.7.md @@ -7,7 +7,7 @@ SYNOPSIS **(WARNING: experimental-offers only)** -**offerout** *amount* *description* \[*issuer*\] \[*label*\] \[*absolute_expiry*\] \[*refund_for*\] +**offerout** *amount* *description* [*issuer*] [*label*] [*absolute_expiry*] [*refund_for*] DESCRIPTION ----------- diff --git a/doc/lightning-openchannel_bump.7.md b/doc/lightning-openchannel_bump.7.md index 2eb748c4c..a863eb0fc 100644 --- a/doc/lightning-openchannel_bump.7.md +++ b/doc/lightning-openchannel_bump.7.md @@ -4,7 +4,7 @@ lightning-openchannel\_bump -- Command to initiate a channel RBF SYNOPSIS -------- -**openchannel_bump** *channel_id* *amount* *initalpsbt* \[*funding_feerate*\] +**openchannel_bump** *channel_id* *amount* *initalpsbt* [*funding_feerate*] DESCRIPTION ----------- diff --git a/doc/lightning-openchannel_init.7.md b/doc/lightning-openchannel_init.7.md index bd043a91c..e67a14150 100644 --- a/doc/lightning-openchannel_init.7.md +++ b/doc/lightning-openchannel_init.7.md @@ -4,7 +4,7 @@ lightning-openchannel\_init -- Command to initiate a channel to a peer SYNOPSIS -------- -**openchannel_init** *id* *amount* *initalpsbt* \[*commitment_feerate*\] \[*funding_feerate*\] \[*announce*\] \[*close_to*\] \[*request_amt*\] \[*compact_lease*\] +**openchannel_init** *id* *amount* *initalpsbt* [*commitment_feerate*] [*funding_feerate*] [*announce*] [*close_to*] [*request_amt*] [*compact_lease*] DESCRIPTION ----------- diff --git a/doc/lightning-pay.7.md b/doc/lightning-pay.7.md index 988a3cce9..ed8156015 100644 --- a/doc/lightning-pay.7.md +++ b/doc/lightning-pay.7.md @@ -4,9 +4,9 @@ lightning-pay -- Command for sending a payment to a BOLT11 invoice SYNOPSIS -------- -**pay** *bolt11* \[*msatoshi*\] \[*label*\] \[*riskfactor*\] -\[*maxfeepercent*\] \[*retry\_for*\] \[*maxdelay*\] \[*exemptfee*\] -\[*exclude*\] +**pay** *bolt11* [*msatoshi*] [*label*] [*riskfactor*] +[*maxfeepercent*] [*retry\_for*] [*maxdelay*] [*exemptfee*] +[*exclude*] DESCRIPTION ----------- @@ -41,8 +41,8 @@ finding routes and retrying the payment. However, a payment may be delayed for up to `maxdelay` blocks by another node; clients should be prepared for this worst case. -*exclude* is a JSON array of short-channel-id/direction (e.g. \[ -"564334x877x1/0", "564195x1292x0/1" \]) or node-id which should be excluded +*exclude* is a JSON array of short-channel-id/direction (e.g. [ +"564334x877x1/0", "564195x1292x0/1" ]) or node-id which should be excluded from consideration for routing. The default is not to exclude any channels or nodes. diff --git a/doc/lightning-ping.7.md b/doc/lightning-ping.7.md index 7d0918598..0088748d9 100644 --- a/doc/lightning-ping.7.md +++ b/doc/lightning-ping.7.md @@ -4,7 +4,7 @@ lightning-ping -- Command to check if a node is up. SYNOPSIS -------- -**ping** *id* \[*len*\] \[*pongbytes*\] +**ping** *id* [*len*] [*pongbytes*] DESCRIPTION ----------- diff --git a/doc/lightning-plugin.7.md b/doc/lightning-plugin.7.md index 88003f1c0..7c3032075 100644 --- a/doc/lightning-plugin.7.md +++ b/doc/lightning-plugin.7.md @@ -4,7 +4,7 @@ lightning-plugin -- Manage plugins with RPC SYNOPSIS -------- -**plugin** command \[*parameter*\] \[*second\_parameter*\] +**plugin** command [*parameter*] [*second\_parameter*] DESCRIPTION ----------- diff --git a/doc/lightning-reserveinputs.7.md b/doc/lightning-reserveinputs.7.md index 1b2f4768c..2cdc30649 100644 --- a/doc/lightning-reserveinputs.7.md +++ b/doc/lightning-reserveinputs.7.md @@ -4,7 +4,7 @@ lightning-reserveinputs -- Construct a transaction and reserve the UTXOs it spen SYNOPSIS -------- -**reserveinputs** *psbt* \[*exclusive*\] \[*reserve*\] +**reserveinputs** *psbt* [*exclusive*] [*reserve*] DESCRIPTION ----------- diff --git a/doc/lightning-sendinvoice.7.md b/doc/lightning-sendinvoice.7.md index 6ca11f5dc..5fc675ed1 100644 --- a/doc/lightning-sendinvoice.7.md +++ b/doc/lightning-sendinvoice.7.md @@ -6,7 +6,7 @@ SYNOPSIS **(WARNING: experimental-offers only)** -**sendinvoice** *offer* *label* \[*msatoshi*\] \[*timeout*\] \[*quantity*\] +**sendinvoice** *offer* *label* [*msatoshi*] [*timeout*] [*quantity*] DESCRIPTION ----------- diff --git a/doc/lightning-sendonion.7.md b/doc/lightning-sendonion.7.md index ad88418c6..927e779a6 100644 --- a/doc/lightning-sendonion.7.md +++ b/doc/lightning-sendonion.7.md @@ -4,8 +4,8 @@ lightning-sendonion -- Send a payment with a custom onion packet SYNOPSIS -------- -**sendonion** *onion* *first_hop* *payment_hash* \[*label*\] \[*shared_secrets*\] \[*partid*\] \[*bolt11*\] -\[*msatoshi*\] \[*destination*\] +**sendonion** *onion* *first_hop* *payment_hash* [*label*] [*shared_secrets*] [*partid*] [*bolt11*] +[*msatoshi*] [*destination*] DESCRIPTION ----------- diff --git a/doc/lightning-sendonionmessage.7.md b/doc/lightning-sendonionmessage.7.md index 03627a56a..13a04af7c 100644 --- a/doc/lightning-sendonionmessage.7.md +++ b/doc/lightning-sendonionmessage.7.md @@ -6,7 +6,7 @@ SYNOPSIS **(WARNING: experimental-onion-messages only)** -**sendonionmessage** *hops* \[*reply_path*\] +**sendonionmessage** *hops* [*reply_path*] DESCRIPTION ----------- diff --git a/doc/lightning-sendpay.7.md b/doc/lightning-sendpay.7.md index 41e4ec2c3..c8d782154 100644 --- a/doc/lightning-sendpay.7.md +++ b/doc/lightning-sendpay.7.md @@ -4,8 +4,8 @@ lightning-sendpay -- Low-level command for sending a payment via a route SYNOPSIS -------- -**sendpay** *route* *payment\_hash* \[*label*\] \[*msatoshi*\] -\[*bolt11*\] \[*payment_secret*\] \[*partid*\] +**sendpay** *route* *payment\_hash* [*label*] [*msatoshi*] +[*bolt11*] [*payment_secret*] [*partid*] DESCRIPTION ----------- diff --git a/doc/lightning-sendpsbt.7.md b/doc/lightning-sendpsbt.7.md index 056e68e62..fd150b9d3 100644 --- a/doc/lightning-sendpsbt.7.md +++ b/doc/lightning-sendpsbt.7.md @@ -4,7 +4,7 @@ lightning-sendpsbt -- Command to finalize, extract and send a partially signed b SYNOPSIS -------- -**sendpsbt** *psbt* \[*reserve*\] +**sendpsbt** *psbt* [*reserve*] DESCRIPTION ----------- diff --git a/doc/lightning-setchannelfee.7.md b/doc/lightning-setchannelfee.7.md index cefcf6f4d..7f94d4872 100644 --- a/doc/lightning-setchannelfee.7.md +++ b/doc/lightning-setchannelfee.7.md @@ -4,7 +4,7 @@ lightning-setchannelfee -- Command for setting specific routing fees on a lightn SYNOPSIS -------- -**setchannelfee** *id* \[*base*\] \[*ppm*\] \[*enforcedelay*\] +**setchannelfee** *id* [*base*] [*ppm*] [*enforcedelay*] DESCRIPTION ----------- diff --git a/doc/lightning-signpsbt.7.md b/doc/lightning-signpsbt.7.md index 883f9120c..cef87f311 100644 --- a/doc/lightning-signpsbt.7.md +++ b/doc/lightning-signpsbt.7.md @@ -4,7 +4,7 @@ lightning-signpsbt -- Command to sign a wallet's inputs on a provided bitcoin tr SYNOPSIS -------- -**signpsbt** *psbt* \[*signonly*\] +**signpsbt** *psbt* [*signonly*] DESCRIPTION ----------- diff --git a/doc/lightning-txprepare.7.md b/doc/lightning-txprepare.7.md index dcc46344a..83efc7186 100644 --- a/doc/lightning-txprepare.7.md +++ b/doc/lightning-txprepare.7.md @@ -4,7 +4,7 @@ lightning-txprepare -- Command to prepare to withdraw funds from the internal wa SYNOPSIS -------- -**txprepare** *outputs* \[*feerate*\] \[*minconf*\] \[*utxos*\] +**txprepare** *outputs* [*feerate*] [*minconf*] [*utxos*] DESCRIPTION ----------- @@ -15,9 +15,9 @@ in *outputs*. The *outputs* is the array of output that include *destination* and *amount*(\{*destination*: *amount*\}). Its format is like: -\[\{address1: amount1\}, \{address2: amount2\}\] +[\{address1: amount1\}, \{address2: amount2\}] or -\[\{address: *all*\}\]. +[\{address: *all*\}]. It supports any number of **confirmed** outputs. The *destination* of output is the address which can be of any Bitcoin accepted diff --git a/doc/lightning-unreserveinputs.7.md b/doc/lightning-unreserveinputs.7.md index e84b8f6a0..869adbb3f 100644 --- a/doc/lightning-unreserveinputs.7.md +++ b/doc/lightning-unreserveinputs.7.md @@ -4,7 +4,7 @@ lightning-unreserveinputs -- Release reserved UTXOs SYNOPSIS -------- -**unreserveinputs** *psbt* \[*reserve*\] +**unreserveinputs** *psbt* [*reserve*] DESCRIPTION ----------- diff --git a/doc/lightning-utxopsbt.7.md b/doc/lightning-utxopsbt.7.md index 01db6aede..090d66961 100644 --- a/doc/lightning-utxopsbt.7.md +++ b/doc/lightning-utxopsbt.7.md @@ -4,7 +4,7 @@ lightning-utxopsbt -- Command to populate PSBT inputs from given UTXOs SYNOPSIS -------- -**utxopsbt** *satoshi* *feerate* *startweight* *utxos* \[*reserve*\] \[*reservedok*\] \[*locktime*\] \[*min_witness_weight*\] \[*excess_as_change*\] +**utxopsbt** *satoshi* *feerate* *startweight* *utxos* [*reserve*] [*reservedok*] [*locktime*] [*min_witness_weight*] [*excess_as_change*] DESCRIPTION ----------- diff --git a/doc/lightning-waitanyinvoice.7.md b/doc/lightning-waitanyinvoice.7.md index 6dafab1ad..725068fad 100644 --- a/doc/lightning-waitanyinvoice.7.md +++ b/doc/lightning-waitanyinvoice.7.md @@ -4,7 +4,7 @@ lightning-waitanyinvoice -- Command for waiting for payments SYNOPSIS -------- -**waitanyinvoice** \[*lastpay\_index*\] \[*timeout*\] +**waitanyinvoice** [*lastpay\_index*] [*timeout*] DESCRIPTION ----------- diff --git a/doc/lightning-waitblockheight.7.md b/doc/lightning-waitblockheight.7.md index a84561bac..7eae32216 100644 --- a/doc/lightning-waitblockheight.7.md +++ b/doc/lightning-waitblockheight.7.md @@ -4,7 +4,7 @@ lightning-waitblockheight -- Command for waiting for blocks on the blockchain SYNOPSIS -------- -**waitblockheight** *blockheight* \[*timeout*\] +**waitblockheight** *blockheight* [*timeout*] DESCRIPTION ----------- diff --git a/doc/lightning-waitsendpay.7.md b/doc/lightning-waitsendpay.7.md index abca8ea0e..ff87bea3e 100644 --- a/doc/lightning-waitsendpay.7.md +++ b/doc/lightning-waitsendpay.7.md @@ -4,7 +4,7 @@ lightning-waitsendpay -- Command for sending a payment via a route SYNOPSIS -------- -**waitsendpay** *payment\_hash* \[*timeout*\] \[*partid*\] +**waitsendpay** *payment\_hash* [*timeout*] [*partid*] DESCRIPTION ----------- diff --git a/doc/lightning-withdraw.7.md b/doc/lightning-withdraw.7.md index 204f2131c..007a361f5 100644 --- a/doc/lightning-withdraw.7.md +++ b/doc/lightning-withdraw.7.md @@ -4,7 +4,7 @@ lightning-withdraw -- Command for withdrawing funds from the internal wallet SYNOPSIS -------- -**withdraw** *destination* *satoshi* \[*feerate*\] \[*minconf*\] \[*utxos*\] +**withdraw** *destination* *satoshi* [*feerate*] [*minconf*] [*utxos*] DESCRIPTION -----------