manpages

[ZmnSCPxj]

As we already have manpages for many commands, we should go whole-hog and make manpages for all commands.

We even have manpages for obscure commands (autocleaninvoice) but some important commands are missing description!

• fundchannel doc: Added fundchannel man page. #1463
• connect documentation withdraw, connect, listfunds, newaddr #1427
• disconnect
• listpeers
• listchannels
• close peer_control: Make close wait for complete closure, with timeout. #1355
• withdraw documentation withdraw, connect, listfunds, newaddr #1427
• newaddr documentation withdraw, connect, listfunds, newaddr #1427
• listfunds documentation withdraw, connect, listfunds, newaddr #1427
• lightningd itself doc/lightningd.8.txt: Initial manpage for lightningd itself. #2899

[wythe]

Agreed, this is something I've had my eye on. I've wound down some of my other activities and plan to spend a lot more time on this project.

[fixone]

I've created PR #1406 that covers 2 of the 8 still needed manpages

[wythe]

As far as I can tell, the actual JSON RPC interface is not documented anywhere (I figured it out using printf). Maybe we could use a lightning-rpc manpage. Or, the yet to be written lightningd page will define it.

[ZmnSCPxj]

We are supposedly following this spec for JSON-RPC: http://www.jsonrpc.org/specification

Note however that we do not support batch command processing as far as I can tell.

[wythe]

That makes sense. Thanks. I knew I was missing something.

I'm happy to pick this one up and create man pages for the remaining.

Are you happy for me to open an issue for each page required and then track overall progress on here? I can see some taking less time that others and suspect that the page for lightningd could be quite in depth.