Skip to content

Commit

Permalink
docs: update man pages (#5672)
Browse files Browse the repository at this point in the history
## Issue being fixed or feature implemented

## What was done?
`./contrib/devtools/gen-manpages.sh` and drop `rc2` and `dirty` suffixes

## How Has This Been Tested?
n/a

## Breaking Changes
n/a

## Checklist:
- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added or updated relevant unit/integration/functional/e2e
tests
- [ ] I have made corresponding changes to the documentation
- [x] I have assigned this pull request to a milestone _(for repository
code-owners and collaborators only)_
  • Loading branch information
UdjinM6 committed Nov 7, 2023
1 parent c293593 commit ab56dcf
Show file tree
Hide file tree
Showing 5 changed files with 319 additions and 184 deletions.
56 changes: 36 additions & 20 deletions doc/man/dash-cli.1
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH DASH-CLI "1" "June 2023" "dash-cli v19.2.0" "User Commands"
.TH DASH-CLI "1" "November 2023" "dash-cli v20.0.0" "User Commands"
.SH NAME
dash-cli \- manual page for dash-cli v19.2.0
dash-cli \- manual page for dash-cli v20.0.0
.SH SYNOPSIS
.B dash-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Dash Core\/\fR
Expand All @@ -15,7 +15,7 @@ dash-cli \- manual page for dash-cli v19.2.0
.B dash-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
Dash Core RPC client version v19.2.0
Dash Core RPC client version v20.0.0
.SH OPTIONS
.HP
\-?
Expand All @@ -31,6 +31,15 @@ location. (default: dash.conf)
.IP
Specify data directory
.HP
\fB\-generate\fR
.IP
Generate blocks immediately, equivalent to RPC generatenewaddress
followed by RPC generatetoaddress. Optional positional integer
arguments are number of blocks to generate (default: 1) and
maximum iterations to try (default: 1000000), equivalent to RPC
generatetoaddress nblocks and maxtries arguments. Example:
dash\-cli \fB\-generate\fR 4 1000
.HP
\fB\-getinfo\fR
.IP
Get general information from the remote server. Note that unlike
Expand All @@ -43,6 +52,13 @@ be as of a different block from the chain state reported)
.IP
Pass named instead of positional arguments (default: false)
.HP
\fB\-netinfo\fR
.IP
Get network peer connection information from the remote server. An
optional integer argument from 0 to 4 can be passed for different
peers listings (default: 0). Pass "help" for detailed help
documentation.
.HP
\fB\-rpcclienttimeout=\fR<n>
.IP
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
Expand Down Expand Up @@ -107,6 +123,11 @@ Print version and exit
.PP
Chain selection options:
.HP
\fB\-chain=\fR<chain>
.IP
Use the chain <chain> (default: main). Allowed values: main, test,
regtest
.HP
\fB\-devnet=\fR<name>
.IP
Use devnet chain with provided name
Expand All @@ -124,7 +145,8 @@ highsubsidyblocks window of a chain (default: 1, devnet\-only)
\fB\-llmqchainlocks=\fR<quorum name>
.IP
Override the default LLMQ type used for ChainLocks. Allows using
ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet\-only)
ChainLocks with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqdevnetparams=\fR<size>:<threshold>
.IP
Expand All @@ -134,19 +156,24 @@ devnet\-only)
\fB\-llmqinstantsend=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_50_60,
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqinstantsenddip0024=\fR<quorum name>
.IP
Override the default LLMQ type used for InstantSendDIP0024. (default:
llmq_60_75, devnet\-only)
llmq_devnet_dip0024, devnet\-only)
.HP
\fB\-llmqplatform=\fR<quorum name>
\fB\-llmqmnhf=\fR<quorum name>
.IP
Override the default LLMQ type used for Platform. (default: llmq_100_67,
Override the default LLMQ type used for EHF. (default: llmq_devnet,
devnet\-only)
.HP
\fB\-llmqplatform=\fR<quorum name>
.IP
Override the default LLMQ type used for Platform. (default:
llmq_devnet_platform, devnet\-only)
.HP
\fB\-minimumdifficultyblocks=\fR<n>
.IP
The number of blocks that can be mined with the minimum difficulty at
Expand All @@ -159,15 +186,4 @@ minutes, devnet\-only)
.HP
\fB\-testnet\fR
.IP
Use the test chain
.SH COPYRIGHT
Copyright (C) 2014-2023 The Dash Core developers
Copyright (C) 2009-2023 The Bitcoin Core developers

Please contribute if you find Dash Core useful. Visit <https://dash.org> for
further information about the software.
The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR

0 comments on commit ab56dcf

Please sign in to comment.