Print Page - [PATCH] RPC: display existing extended-help descriptions

Several RPC commands have multi-line help descriptions, but they do not appear to be shown anywhere. The following patch implements a

Code:

help [command]

parameter that provides access to these extended descriptions.

Patch: http://pastebin.ca/1911586 (http://pastebin.ca/1911586)
Raw: http://pastebin.ca/raw/1911586 (http://pastebin.ca/raw/1911586)

Here is example output for the new "help listreceivedbyaddress" sub-command:

Code:

[jgarzik@bd ~]$ /garz/repo/bitcoin/bitcoind -datadir=/garz/bitcoin/data help listreceivedbyaddress

listreceivedbyaddress [minconf=1] [includeempty=false]
[minconf] is the minimum number of confirmations before payments are included.
[includeempty] whether to include addresses that haven't received any payments.
Returns an array of objects containing:
  "address" : receiving address
  "label" : the label of the receiving address
  "amount" : total amount received by the address
  "confirmations" : number of confirmations of the most recent transaction included

Bitcoin Forum

Bitcoin => Development & Technical Discussion => Topic started by: jgarzik on July 30, 2010, 06:24:12 AM