Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some formatting inconsistencies #5018

Merged
merged 2 commits into from
Feb 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/lightning-autocleaninvoice.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-check.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-check -- Command for verifying parameters
SYNOPSIS
--------

**check** *command\_to\_check* \[*parameters*\]
**check** *command\_to\_check* [*parameters*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-checkmessage.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-close.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-connect.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-connect -- Command for connecting to another lightning node
SYNOPSIS
--------

**connect** *id* \[*host* *port*\]
**connect** *id* [*host*] [*port*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-createonion.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-decodepay.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-decodepay -- Command for decoding a bolt11 string (low-level)
SYNOPSIS
--------

**decodepay** *bolt11* \[*description*\]
**decodepay** *bolt11* [*description*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-delexpiredinvoice.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-delexpiredinvoice -- Command for removing expired invoices
SYNOPSIS
--------

**delexpiredinvoice** \[*maxexpirytime*\]
**delexpiredinvoice** [*maxexpirytime*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-disconnect.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-disconnect -- Command for disconnecting from another lightning node
SYNOPSIS
--------

**disconnect** *id* \[*force*\]
**disconnect** *id* [*force*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-fetchinvoice.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
4 changes: 2 additions & 2 deletions doc/lightning-fundchannel.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-fundchannel_start.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-funderupdate.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-fundpsbt.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-getlog.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-getlog -- Command to show logs.
SYNOPSIS
--------

**getlog** \[*level*\]
**getlog** [*level*]

DESCRIPTION
-----------
Expand Down
8 changes: 4 additions & 4 deletions doc/lightning-getroute.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-help.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-help -- Command to return all information about RPC commands.
SYNOPSIS
--------

**help** \[*command\*]
**help** [*command\*]

DESCRIPTION
-----------
Expand Down
4 changes: 2 additions & 2 deletions doc/lightning-invoice.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-keysend.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listchannels.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
4 changes: 2 additions & 2 deletions doc/lightning-listconfigs.7

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion doc/lightning-listconfigs.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-listconfigs -- Command to list all configuration options.
SYNOPSIS
--------

**listconfigs** \[config\]
**listconfigs** [*config*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listforwards.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listfunds.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-listfunds -- Command showing all funds currently managed by the c-ligh
SYNOPSIS
--------

**listfunds** \[*spent*\]
**listfunds** [*spent*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listinvoices.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listnodes.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-listnodes -- Command to get the list of nodes in the known network.
SYNOPSIS
--------

**listnodes** \[id\]
**listnodes** [*id*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listoffers.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ SYNOPSIS
--------
**(WARNING: experimental-offers only)**

**listoffers** \[*offer_id*\] \[*active_only*\]
**listoffers** [*offer_id*] [*active_only*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listpays.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-listpays -- Command for querying payment status
SYNOPSIS
--------

**listpays** \[bolt11\] \[payment_hash\] \[status\]
**listpays** [*bolt11*] [*payment_hash*] [*status*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listpeers.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-listpeers -- Command returning data on connected lightning nodes
SYNOPSIS
--------

**listpeers** \[*id*\] \[*level*\]
**listpeers** [*id*] [*level*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listsendpays.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-multifundchannel.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-multiwithdraw.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-multiwithdraw -- Command for withdrawing to multiple addresses
SYNOPSIS
--------

**multiwithdraw** *outputs* \[*feerate*\] \[*minconf*\] \[*utxos*\]
**multiwithdraw** *outputs* [*feerate*] [*minconf*] [*utxos*]

DESCRIPTION
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-newaddr.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-newaddr -- Command for generating a new address to be used by c-lightn
SYNOPSIS
--------

**newaddr** \[ *addresstype* \]
**newaddr** [ *addresstype* ]

DESCRIPTION
-----------
Expand Down
4 changes: 2 additions & 2 deletions doc/lightning-offer.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-offerout.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-openchannel_bump.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-openchannel_init.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
10 changes: 5 additions & 5 deletions doc/lightning-pay.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-ping.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-ping -- Command to check if a node is up.
SYNOPSIS
--------

**ping** *id* \[len\] \[pongbytes\]
**ping** *id* [*len*] [*pongbytes*]

DESCRIPTION
-----------
Expand Down
Loading