Skip to content

Commit cb65a91

Browse files
committed
standardizes t/f syntax
Signed-off-by: m4sterbunny <[email protected]>
1 parent f1c3ac9 commit cb65a91

File tree

1 file changed

+38
-36
lines changed

1 file changed

+38
-36
lines changed

docs/public-networks/reference/cli/options.md

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ For [`eth_gasPrice`](../api/index.md#eth_gasprice), to return the:
187187
<TabItem value="Syntax" label="Syntax" default>
188188

189189
```bash
190-
--auto-log-bloom-caching-enabled[=<true|false>]
190+
--auto-log-bloom-caching-enabled=<true|false>
191191
```
192192

193193
</TabItem>
@@ -374,7 +374,7 @@ If you plan on querying historical blocks or state using the [JSON-RPC API](../a
374374
<TabItem value="Syntax" label="Syntax" default>
375375

376376
```bash
377-
--bonsai-limit-trie-logs-enabled=[=<true|false>]
377+
--bonsai-limit-trie-logs-enabled=<true|false>
378378
```
379379

380380
</TabItem>
@@ -556,7 +556,7 @@ The default is `0`.
556556
<TabItem value="Syntax" label="Syntax" default>
557557

558558
```bash
559-
--color-enabled[=<true|false>]
559+
--color-enabled=<true|false>
560560
```
561561

562562
</TabItem>
@@ -740,7 +740,7 @@ The `enrtree` URL of the DNS node list for [node discovery via DNS](https://eips
740740
<TabItem value="Syntax" label="Syntax" default>
741741

742742
```bash
743-
--discovery-enabled[=<true|false>]
743+
--discovery-enabled=<true|false>
744744
```
745745

746746
</TabItem>
@@ -832,7 +832,7 @@ To allow all hostnames, use `"*"`. We don't recommend allowing all hostnames in
832832
<TabItem value="Syntax" label="Syntax" default>
833833

834834
```bash
835-
--engine-jwt-disabled[=<true|false>]
835+
--engine-jwt-disabled=<true|false>
836836
```
837837

838838
</TabItem>
@@ -912,7 +912,7 @@ Shared secret used to authenticate [consensus clients](../../concepts/node-clien
912912
<TabItem value="Syntax" label="Syntax" default>
913913

914914
```bash
915-
--engine-rpc-enabled[=<true|false]>
915+
--engine-rpc-enabled=<true|false>
916916
```
917917

918918
</TabItem>
@@ -1335,7 +1335,7 @@ You can't use the [`--genesis-file`](#genesis-file) and [`--network`](#network)
13351335
<TabItem value="Syntax" label="Syntax" default>
13361336

13371337
```bash
1338-
--genesis-state-hash-cache-enabled=[=<true|false>]
1338+
--genesis-state-hash-cache-enabled=<true|false>
13391339
```
13401340

13411341
</TabItem>
@@ -1421,7 +1421,7 @@ A list of comma-separated origin domain URLs for CORS validation. The default is
14211421
<TabItem value="Syntax" label="Syntax" default>
14221422

14231423
```bash
1424-
--graphql-http-enabled[=<true|false>]
1424+
--graphql-http-enabled=<true|false>
14251425
```
14261426

14271427
</TabItem>
@@ -1548,7 +1548,7 @@ The port (TCP) on which GraphQL HTTP listens. The default is `8547`. Ports must
15481548
<TabItem value="Syntax">
15491549

15501550
```bash
1551-
--graphql-mtls-enabled[=<true|false>]
1551+
--graphql-mtls-enabled=<true|false>
15521552
```
15531553

15541554
</TabItem>
@@ -1588,7 +1588,7 @@ The default is `false`.
15881588
<TabItem value="Syntax">
15891589

15901590
```bash
1591-
--graphql-tls-enabled[=<true|false>]
1591+
--graphql-tls-enabled=<true|false>
15921592
```
15931593

15941594
</TabItem>
@@ -1792,7 +1792,7 @@ Show the help message and exit.
17921792
<TabItem value="Syntax" label="Syntax" default>
17931793

17941794
```bash
1795-
--history-expiry-prune[=<true|false>]
1795+
--history-expiry-prune=<true|false>
17961796
```
17971797
</TabItem>
17981798

@@ -1935,7 +1935,7 @@ If a name is not specified, the name section is not included in the client ID. F
19351935
<TabItem value="Syntax" label="Syntax" default>
19361936

19371937
```bash
1938-
--json-pretty-print-enabled[=<true|false>]
1938+
--json-pretty-print-enabled=<true|false>
19391939
```
19401940

19411941
</TabItem>
@@ -2179,7 +2179,7 @@ Other categories are `KVSTORE_ROCKSDB`, `KVSTORE_PRIVATE_ROCKSDB`, `KVSTORE_ROCK
21792179
<TabItem value="Syntax" label="Syntax" default>
21802180

21812181
```bash
2182-
--metrics-enabled[=<true|false>]
2182+
--metrics-enabled=<true|false>
21832183
```
21842184

21852185
</TabItem>
@@ -2377,6 +2377,7 @@ metrics-push-enabled=true
23772377
Enables or disables [push gateway integration].
23782378

23792379
You can't specify `--metrics-push-enabled` with [`--metrics-enabled`](#metrics-enabled). That is, you can enable either Prometheus polling or Prometheus push gateway support, but not both at once.
2380+
<!-- No default specified -->
23802381

23812382
### `metrics-push-host`
23822383

@@ -2751,7 +2752,7 @@ fee recipient, if the consensus layer client doesn't provide any.
27512752
<TabItem value="Syntax" label="Syntax" default>
27522753

27532754
```bash
2754-
--miner-enabled[=<true|false>]
2755+
--miner-enabled=<true|false>
27552756
```
27562757

27572758
</TabItem>
@@ -3081,7 +3082,7 @@ This option is ignored if [`--security-module`](#security-module) is set to a no
30813082
<TabItem value="Syntax" label="Syntax" default>
30823083

30833084
```bash
3084-
--p2p-enabled[=<true|false>]
3085+
--p2p-enabled=<true|false>
30853086
```
30863087

30873088
</TabItem>
@@ -3291,7 +3292,7 @@ The default is `50`: limiting plugins to up to 50% of the total block creation t
32913292
<TabItem value="Syntax">
32923293

32933294
```bash
3294-
--plugin-continue-on-error[=<true|false>]
3295+
--plugin-continue-on-error=<true|false>
32953296
```
32963297

32973298
</TabItem>
@@ -3435,7 +3436,7 @@ The default is `null`.
34353436
<TabItem value="Syntax" label="Syntax" default>
34363437

34373438
```bash
3438-
--random-peer-priority-enabled[=<true|false>]
3439+
--random-peer-priority-enabled=<true|false>
34393440
```
34403441

34413442
</TabItem>
@@ -3517,7 +3518,7 @@ The default is `false`.
35173518
<TabItem value="Syntax" label="Syntax" default>
35183519

35193520
```bash
3520-
--remote-connections-limit-enabled[=<true|false>]
3521+
--remote-connections-limit-enabled=<true|false>
35213522
```
35223523

35233524
</TabItem>
@@ -3689,7 +3690,7 @@ Requires a peer with the specified block number to have the specified hash when
36893690
<TabItem value="Syntax" label="Syntax" default>
36903691

36913692
```bash
3692-
--revert-reason-enabled[=<true|false>]
3693+
--revert-reason-enabled=<true|false>
36933694
```
36943695

36953696
</TabItem>
@@ -3941,7 +3942,8 @@ rpc-http-authentication-enabled=true
39413942

39423943
</Tabs>
39433944

3944-
Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service.
3945+
Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service.
3946+
<!-- No default specified -->
39453947

39463948
### `rpc-http-authentication-jwt-algorithm`
39473949

@@ -4091,7 +4093,7 @@ For testing and development purposes, use `"all"` or `"*"` to accept requests fr
40914093
<TabItem value="Syntax" label="Syntax" default>
40924094

40934095
```bash
4094-
--rpc-http-enabled[=<true|false>]
4096+
--rpc-http-enabled=<true|false>
40954097
```
40964098

40974099
</TabItem>
@@ -4343,7 +4345,7 @@ The port (TCP) on which JSON-RPC HTTP listens. The default is `8545`. You must [
43434345
<TabItem value="Syntax" label="Syntax" default>
43444346

43454347
```bash
4346-
--rpc-http-tls-ca-clients-enabled[=<true|false>]
4348+
--rpc-http-tls-ca-clients-enabled=<true|false>
43474349
```
43484350

43494351
</TabItem>
@@ -4389,7 +4391,7 @@ You must enable client authentication using the [`--rpc-http-tls-client-auth-ena
43894391
<TabItem value="Syntax" label="Syntax" default>
43904392

43914393
```bash
4392-
--rpc-http-tls-client-auth-enabled[=<true|false>]
4394+
--rpc-http-tls-client-auth-enabled=<true|false>
43934395
```
43944396

43954397
</TabItem>
@@ -4481,7 +4483,7 @@ The singular `--rpc-http-tls-cipher-suite` and plural `--rpc-http-tls-cipher-sui
44814483
<TabItem value="Syntax" label="Syntax" default>
44824484

44834485
```bash
4484-
--rpc-http-tls-enabled[=<true|false>]
4486+
--rpc-http-tls-enabled=<true|false>
44854487
```
44864488

44874489
</TabItem>
@@ -5083,7 +5085,7 @@ rpc-ws-authentication-enabled=true
50835085
</Tabs>
50845086

50855087
Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC WebSocket service.
5086-
5088+
<!-- No default specified -->
50875089
:::note
50885090

50895091
`wscat` doesn't support headers. [Authentication](../../how-to/use-besu-api/authenticate.md) requires you to pass an authentication token in the request header. To use authentication with WebSockets, you need an app that supports headers.
@@ -5180,7 +5182,7 @@ The [JWT provider's public key file] used for JSON-RPC WebSocket authentication
51805182
<TabItem value="Syntax" label="Syntax" default>
51815183

51825184
```bash
5183-
--rpc-ws-enabled[=<true|false>]
5185+
--rpc-ws-enabled=<true|false>
51845186
```
51855187

51865188
</TabItem>
@@ -5431,7 +5433,7 @@ Required if [`--rpc-ws-ssl-keystore-type`](#rpc-ws-ssl-keystore-type) is `PEM`.
54315433
<TabItem value="Syntax" label="Syntax" default>
54325434

54335435
```bash
5434-
--rpc-ws-ssl-client-auth-enabled[=<true|false>]
5436+
--rpc-ws-ssl-client-auth-enabled=<true|false>
54355437
```
54365438

54375439
</TabItem>
@@ -5481,7 +5483,7 @@ If using JKS or PKCS12, specify the truststore password using [`--rpc-ws-ssl-tru
54815483
<TabItem value="Syntax" label="Syntax" default>
54825484

54835485
```bash
5484-
--rpc-ws-ssl-enabled[=<true|false>]
5486+
--rpc-ws-ssl-enabled=<true|false>
54855487
```
54865488

54875489
</TabItem>
@@ -5994,7 +5996,7 @@ The default is the node's local private key file specified using [`--node-privat
59945996
<TabItem value="Syntax" label="Syntax" default>
59955997

59965998
```bash
5997-
--snapsync-server-enabled[=<true|false>]
5999+
--snapsync-server-enabled=<true|false>
59986000
```
59996001

60006002
</TabItem>
@@ -6032,7 +6034,7 @@ The default is `false`.
60326034
<TabItem value="Syntax" label="Syntax" default>
60336035

60346036
```bash
6035-
--snapsync-synchronizer-pre-checkpoint-headers-only-enabled[=<true|false>]
6037+
--snapsync-synchronizer-pre-checkpoint-headers-only-enabled=<true|false>
60366038
```
60376039
</TabItem>
60386040

@@ -6073,7 +6075,7 @@ Setting this option to `false` increases sync time and disk space usage.
60736075
<TabItem value="Syntax" label="Syntax" default>
60746076

60756077
```bash
6076-
--snapsync-synchronizer-transaction-indexing-enabled[=<true|false>]
6078+
--snapsync-synchronizer-transaction-indexing-enabled=<true|false>
60776079
```
60786080

60796081
</TabItem>
@@ -6159,7 +6161,7 @@ Static nodes JSON file containing the [static nodes](../../how-to/connect/static
61596161
<TabItem value="Syntax" label="Syntax" default>
61606162

61616163
```bash
6162-
--strict-tx-replay-protection-enabled[=<true|false>]
6164+
--strict-tx-replay-protection-enabled=<true|false>
61636165
```
61646166

61656167
</TabItem>
@@ -6429,7 +6431,7 @@ The default is `100`.
64296431
<TabItem value="Syntax" label="Syntax" default>
64306432

64316433
```bash
6432-
--tx-pool-enable-balance-check[=<true|false>]
6434+
--tx-pool-enable-balance-check=<true|false>
64336435
```
64346436

64356437
</TabItem>
@@ -6471,7 +6473,7 @@ The default is `false`.
64716473
<TabItem value="Syntax" label="Syntax" default>
64726474

64736475
```bash
6474-
--tx-pool-enable-save-restore[=<true|false>]
6476+
--tx-pool-enable-save-restore=<true|false>
64756477
```
64766478

64776479
</TabItem>
@@ -6886,7 +6888,7 @@ all other pending transactions.
68866888
<TabItem value="Syntax" label="Syntax" default>
68876889

68886890
```bash
6889-
--tx-pool-no-local-priority[=<true|false>]
6891+
--tx-pool-no-local-priority=<true|false>
68906892
```
68916893

68926894
</TabItem>
@@ -7120,7 +7122,7 @@ Prints version information and exits.
71207122
<TabItem value="Syntax">
71217123

71227124
```bash
7123-
--version-compatibility-protection[=<true|false>]
7125+
--version-compatibility-protection=<true|false>
71247126
```
71257127

71267128
</TabItem>

0 commit comments

Comments
 (0)