doc/manpages: replace asciidoc by markdown

Author: darosior

doc/lightning-autocleaninvoice.7.md

@@ -0,0 +1,48 @@
+LIGHTNING-AUTOCLEANINVOICE(7) Manual Page
+=========================================
+lightning-autocleaninvoice - Set up auto-delete of expired invoice
+
+SYNOPSIS
+--------
+
+**autocleaninvoice** \[*cycle\_seconds*\] \[*expired\_by*\]
+
+DESCRIPTION
+-----------
+
+The **autocleaninvoice** RPC command sets up automatic cleaning of
+expired invoices.
+
+Autoclean will be done every *cycle\_seconds* seconds. Setting
+*cycle\_seconds* to 0 disables autoclean. If not specified, this
+defaults to 3600 (one hour).
+
+Every autoclean cycle, expired invoices, which have already been expired
+for at least *expired\_by* seconds, will be deleted. If *expired\_by* is
+not specified, this defaults to 86400 (one day).
+
+On startup of the daemon, no autoclean is set up.
+
+RETURN VALUE
+------------
+
+On success, an empty object is returned.
+
+AUTHOR
+------
+
+ZmnSCPxj <<[email protected]>> is mainly responsible.
+
+SEE ALSO
+--------
+
+lightning-delexpiredinvoice(7), lightning-delinvoice(7)
+
+RESOURCES
+---------
+
+Main web site: <https://github.com/ElementsProject/lightning>
+
+------------------------------------------------------------------------
+
+Last updated 2019-04-07 14:23:17 CEST

doc/lightning-autocleaninvoice.7.txt

@@ -0,0 +1,43 @@
+LIGHTNING-CHECK(7) Manual Page
+==============================
+lightning-check - Command for verifying parameters
+
+SYNOPSIS
+--------
+
+**check** *command\_to\_check* \[*parameters*\]
+
+DESCRIPTION
+-----------
+
+The **check** RPC command verifies another command’s parameters without
+running it.
+
+The *command\_to\_check* is the name of the relevant command.
+
+*parameters* is the command’s parameters.
+
+This does not guarantee successful execution of the command in all
+cases. For example, a call to lightning-getroute(7) may still fail to
+find a route even if checking the parameters succeeds.
+
+RETURN VALUE
+------------
+
+On success, the *command\_to\_check* is returned. On failure, the
+relevant RPC error is returned.
+
+AUTHOR
+------
+
+Mark Beckwith <<[email protected]>> and Rusty Russell
+<<[email protected]>> are mainly responsible.
+
+RESOURCES
+---------
+
+Main web site: <https://github.com/ElementsProject/lightning>
+
+------------------------------------------------------------------------
+
+Last updated 2019-04-30 17:12:10 CEST

doc/lightning-check.7.md

@@ -0,0 +1,97 @@
+LIGHTNING-CLI(1) Manual Page
+============================
+lightning-cli - Control lightning daemon
+
+SYNOPSIS
+--------
+
+**lightning-cli** \[*OPTIONS*\] *command*…
+
+DESCRIPTION
+-----------
+
+**lightning-cli** sends commands to the lightning daemon.
+
+OPTIONS
+-------
+
+ **--lightning-dir**=*DIR*
+Set the directory for the lightning daemon we’re talking to; defaults to
+*$HOME/.lightning*.
+
+ **--rpc-file**=*FILE*
+Named pipe to use to talk to lightning daemon: default is
+*lightning-rpc* in the lightning directory.
+
+ **--keywords**/**-k**
+Use format *key*=*value* for parameters in any order
+
+ **--order**/**-o**
+Follow strictly the order of parameters for the command
+
+ **--json**/**-J**
+Return result in JSON format (default unless *help* command)
+
+ **--raw**/**-R**
+Return raw JSON directly as lightningd replies
+
+ **--human-readable**/**-H**
+Return result in human-readable output (default for *help* command)
+
+ **--help**/**-h**
+Print summary of options to standard output and exit.
+
+ **--version**/**-V**
+Print version number to standard output and exit.
+
+COMMANDS
+--------
+
+*lightning-cli* simply uses the JSON RPC interface to talk to
+*lightningd*, and prints the results. Thus the commands available depend
+entirely on the lightning daemon itself.
+
+ARGUMENTS
+---------
+
+Arguments may be provided positionally or using *key*=*value* after the
+command name, based on either **-o** or **-k** option. Arguments may be
+integer numbers (composed entirely of digits), floating-point numbers
+(has a radix point but otherwise composed of digits), *true*, *false*,
+or *null*. Other arguments are treated as strings.
+
+Some commands have optional arguments. You may use *null* to skip
+optional arguments to provide later arguments.
+
+EXAMPLES
+--------
+
+Example 1. List commands
+
+lightning-cli help
+
+BUGS
+----
+
+This manpage documents how it should work, not how it does work. The
+pretty printing of results isn’t pretty.
+
+AUTHOR
+------
+
+Rusty Russell <<[email protected]>> is mainly to blame.
+
+RESOURCES
+---------
+
+Main web site: <https://github.com/ElementsProject/lightning>
+
+COPYING
+-------
+
+Note: the modules in the ccan/ directory have their own licenses, but
+the rest of the code is covered by the BSD-style MIT license.
+
+------------------------------------------------------------------------
+
+Last updated 2019-04-30 17:39:53 CEST