Add bitcoin-cli man page #5809

pull Ciemon wants to merge 4 commits into bitcoin:master from Ciemon:master changing 2 files +48 −0
  1. Ciemon commented at 5:41 PM on February 20, 2015: contributor

    Initial man page for bitcoin-cli

  2. Add bitcoin-cli man page 571b82b60d
  3. in contrib/debian/manpages/bitcoin-cli.1:None in 571b82b60d outdated 
      45 | +This help message
  46 | +
  47 | +.SH "SEE ALSO"
  48 | +bitcoind.d(1), bitcoin.conf(5)
  49 | +.SH AUTHOR
  50 | +This manual page was written by Ciemon Dunville. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation.
    laanwj commented at 5:57 PM on February 20, 2015:

    Thanks for adding a manpage for bitcoin-cli! However, can you please license it under the same license as the rest of the repository? (which is the MIT license, see COPYING)

    Ciemon commented at 7:49 AM on February 21, 2015:

    I could, but I've used the same license as the other Debian man pages, and as I'm sure you know master/contrib/debian/copyright is fairly big already; arguably it doesn't need me dropping more lines into it?

    On 20 February 2015 at 17:57, Wladimir J. van der Laan < notifications@github.com> wrote:

    In contrib/debian/manpages/bitcoin-cli.1 #5809 (review):

    +.TP +\fB-rpcconnect=\fR<ip> +Send commands to node running on <ip> (default: 127.0.0.1) +.PP +SSL options: (see the Bitcoin Wiki for SSL setup instructions) +.TP +\fB-rpcssl\fR=\fI1\fR +Use OpenSSL (https) for JSON-RPC connections +.TP +-? +This help message + +.SH "SEE ALSO" +bitcoind.d(1), bitcoin.conf(5) +.SH AUTHOR +This manual page was written by Ciemon Dunville. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation.

    Thanks for adding a manpage for bitcoin-cli! However, can you please license it under the same license as the rest of the repository? (which is the MIT license, see COPYING)

    — Reply to this email directly or view it on GitHub https://github.com/bitcoin/bitcoin/pull/5809/files#r25088467.

  4. luke-jr commented at 8:03 PM on February 20, 2015: member

    Will this man page get installed as part of a Debian package at least? I would expect some other file needs updating for that... but I could be wrong.

  5. in contrib/debian/manpages/bitcoin-cli.1:None in 2857a4dbde outdated 
       6 | +.TP
   7 | +bitcoin-cli [options] help \- List Bitcoin Core commands.
   8 | +.TP
   9 | +bitcoin [options] help <command> \- Get help for a command.
  10 | +.SH DESCRIPTION
  11 | +This manual page documents the bitcoin-cli program. bitcoin-cli is the RPC client used to send commands to Bitcoin Core.
    sipa commented at 9:12 AM on February 22, 2015:

    I would say: "Is an RPC client" or even "Is a minimal RPC client". Using "the" seems to imply it's only one.

  6. in contrib/debian/manpages/bitcoin-cli.1:None in 2857a4dbde outdated 
       0 | @@ -0,0 +1,52 @@
   1 | +.TH BITCOIN-CLI "1" "February 2015" "bitcoin-cli 0.10" 
   2 | +.SH NAME
   3 | +bitcoin-cli \- the remote procedure call client for bitcoin core. 
   4 | +.SH SYNOPSIS
   5 | +bitcoin-cli [options] <command> [params] \- Send command to Bitcoin Core. 
   6 | +.TP
   7 | +bitcoin-cli [options] help \- List Bitcoin Core commands.
    sipa commented at 9:12 AM on February 22, 2015:

    Maybe: Ask Bitcoin Core for a list of supported commands (to indicate that the result of this command depends on the server, and not the client).

  7. in contrib/debian/manpages/bitcoin-cli.1:None in 2857a4dbde outdated 
       0 | @@ -0,0 +1,52 @@
   1 | +.TH BITCOIN-CLI "1" "February 2015" "bitcoin-cli 0.10" 
   2 | +.SH NAME
   3 | +bitcoin-cli \- the remote procedure call client for bitcoin core.
    sipa commented at 9:13 AM on February 22, 2015:

    Can you use consistent capitalization for Bitcoin Core?

  8. in contrib/debian/manpages/bitcoin-cli.1:None in 2857a4dbde outdated 
      17 | +.TP
  18 | +\fB\-datadir=\fR<dir>
  19 | +Specify data directory
  20 | +.TP
  21 | +\fB\-testnet\fR
  22 | +Use the test network
    sipa commented at 9:13 AM on February 22, 2015:

    Maybe: Connect to a Bitcoin Core instance running in testnet mode.

  9. in contrib/debian/manpages/bitcoin-cli.1:None in 2857a4dbde outdated 
      20 | +.TP
  21 | +\fB\-testnet\fR
  22 | +Use the test network
  23 | +.TP
  24 | +\fB\-regtest\fR
  25 | +Enter regression test mode, which uses a special chain in which blocks can be solved instantly. This is intended for regression testing tools and app development.
    sipa commented at 9:14 AM on February 22, 2015:

    Maybe: Connect to a Bitcoin Core instance running in regtest mode (see documentation for -regtest on bitcoind).

  10. Ciemon commented at 7:02 AM on February 25, 2015: contributor

    As comments have now died down and all changes have been made this man page is now complete.

  11. fanquake commented at 7:04 AM on February 25, 2015: member

    @Ciemon You'll just need to squash your commits.

  12. made some layout changes de4342379f
  13. final changes aee32ba509
  14. Ciemon commented at 7:14 PM on February 25, 2015: contributor

    Unfortunately I seem to have reached the limit of my capability with this. I'm unable to squash the commits; I can't work out how to do it.

  15. paveljanik commented at 9:11 PM on February 25, 2015: contributor

    Squashing is described e.g. here:

    http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html

    Do not hesitate to ask on IRC.

  16. ajweiss commented at 9:32 PM on February 25, 2015: contributor

    Is rpcwait being intentionally deprecated/hidden?

  17. Ciemon commented at 9:57 PM on February 25, 2015: contributor

    No Adam, thanks for noticing that I'd missed it, you can't beat a fresh set of eyes.

    On 25 February 2015 at 21:32, Adam Weiss notifications@github.com wrote:

    Is rpcwait being intentionally deprecated/hidden?

    — Reply to this email directly or view it on GitHub #5809 (comment).

  18. ajweiss commented at 10:05 PM on February 25, 2015: contributor

    Have a look at #5821.

    Some sort of note that advises that testing server connectivity with "-rpcwait" may lead to frustration (as it just silently waits for the server to appear, potentially forever) might be a good idea.

    --adam

    On Wed, Feb 25, 2015 at 4:58 PM, Ciemon notifications@github.com wrote:

    No Adam, thanks for noticing that I'd missed it, you can't beat a fresh set of eyes.

    On 25 February 2015 at 21:32, Adam Weiss notifications@github.com wrote:

    Is rpcwait being intentionally deprecated/hidden?

    — Reply to this email directly or view it on GitHub #5809 (comment).

    — Reply to this email directly or view it on GitHub #5809 (comment).

  19. Merge branch 'master' of https://github.com/Ciemon/bitcoin
    Conflicts:
	contrib/debian/manpages/bitcoin-cli.1
    9a9d2858fd
  20. laanwj commented at 10:03 AM on February 26, 2015: member

    I'll squash/rebase and merge this for you this time. I'd suggest to try practicing a bit with simple changes in git, without involving github.

  21. laanwj referenced this in commit 46bfbe7148 on Feb 26, 2015
  22. laanwj commented at 10:09 AM on February 26, 2015: member

    Merged via 96c19a3

  23. laanwj closed this on Feb 26, 2015
  24. bitcoin locked this on Sep 8, 2021
Contributors
Ciemonlaanwjluke-jrsipafanquakepaveljanikajweiss
Linked (view graph)
#5821 No error message for wrong command and endless loop
github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-05-20 06:55 UTC