Skip to content

Commit c3a8a59

Browse files
committed
doc: re-generate docs after adding --resultsdir param
1 parent beef8a6 commit c3a8a59

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+206
-165
lines changed

doc/chantools.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ https://github.com/lightninglabs/chantools/.
1212
### Options
1313

1414
```
15-
-h, --help help for chantools
16-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
17-
-r, --regtest Indicates if regtest parameters should be used
18-
-s, --signet Indicates if the public signet parameters should be used
19-
-t, --testnet Indicates if testnet parameters should be used
15+
-h, --help help for chantools
16+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
17+
-r, --regtest Indicates if regtest parameters should be used
18+
--resultsdir string Directory where results should be stored (default "./results")
19+
-s, --signet Indicates if the public signet parameters should be used
20+
-t, --testnet Indicates if testnet parameters should be used
2021
```
2122

2223
### SEE ALSO

doc/chantools_chanbackup.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ chantools chanbackup \
3333
### Options inherited from parent commands
3434

3535
```
36-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
37-
-r, --regtest Indicates if regtest parameters should be used
38-
-s, --signet Indicates if the public signet parameters should be used
39-
-t, --testnet Indicates if testnet parameters should be used
36+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
37+
-r, --regtest Indicates if regtest parameters should be used
38+
--resultsdir string Directory where results should be stored (default "./results")
39+
-s, --signet Indicates if the public signet parameters should be used
40+
-t, --testnet Indicates if testnet parameters should be used
4041
```
4142

4243
### SEE ALSO

doc/chantools_closepoolaccount.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,11 @@ chantools closepoolaccount \
4848
### Options inherited from parent commands
4949

5050
```
51-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
52-
-r, --regtest Indicates if regtest parameters should be used
53-
-s, --signet Indicates if the public signet parameters should be used
54-
-t, --testnet Indicates if testnet parameters should be used
51+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
52+
-r, --regtest Indicates if regtest parameters should be used
53+
--resultsdir string Directory where results should be stored (default "./results")
54+
-s, --signet Indicates if the public signet parameters should be used
55+
-t, --testnet Indicates if testnet parameters should be used
5556
```
5657

5758
### SEE ALSO

doc/chantools_compactdb.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ chantools compactdb \
3131
### Options inherited from parent commands
3232

3333
```
34-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
35-
-r, --regtest Indicates if regtest parameters should be used
36-
-s, --signet Indicates if the public signet parameters should be used
37-
-t, --testnet Indicates if testnet parameters should be used
34+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
35+
-r, --regtest Indicates if regtest parameters should be used
36+
--resultsdir string Directory where results should be stored (default "./results")
37+
-s, --signet Indicates if the public signet parameters should be used
38+
-t, --testnet Indicates if testnet parameters should be used
3839
```
3940

4041
### SEE ALSO

doc/chantools_createwallet.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ chantools createwallet \
3333
### Options inherited from parent commands
3434

3535
```
36-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
37-
-r, --regtest Indicates if regtest parameters should be used
38-
-s, --signet Indicates if the public signet parameters should be used
39-
-t, --testnet Indicates if testnet parameters should be used
36+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
37+
-r, --regtest Indicates if regtest parameters should be used
38+
--resultsdir string Directory where results should be stored (default "./results")
39+
-s, --signet Indicates if the public signet parameters should be used
40+
-t, --testnet Indicates if testnet parameters should be used
4041
```
4142

4243
### SEE ALSO

doc/chantools_deletepayments.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,11 @@ chantools deletepayments --failedonly \
3434
### Options inherited from parent commands
3535

3636
```
37-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
38-
-r, --regtest Indicates if regtest parameters should be used
39-
-s, --signet Indicates if the public signet parameters should be used
40-
-t, --testnet Indicates if testnet parameters should be used
37+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
38+
-r, --regtest Indicates if regtest parameters should be used
39+
--resultsdir string Directory where results should be stored (default "./results")
40+
-s, --signet Indicates if the public signet parameters should be used
41+
-t, --testnet Indicates if testnet parameters should be used
4142
```
4243

4344
### SEE ALSO

doc/chantools_derivekey.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,11 @@ chantools derivekey --identity
3636
### Options inherited from parent commands
3737

3838
```
39-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
40-
-r, --regtest Indicates if regtest parameters should be used
41-
-s, --signet Indicates if the public signet parameters should be used
42-
-t, --testnet Indicates if testnet parameters should be used
39+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
40+
-r, --regtest Indicates if regtest parameters should be used
41+
--resultsdir string Directory where results should be stored (default "./results")
42+
-s, --signet Indicates if the public signet parameters should be used
43+
-t, --testnet Indicates if testnet parameters should be used
4344
```
4445

4546
### SEE ALSO

doc/chantools_doublespendinputs.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ chantools doublespendinputs \
4040
### Options inherited from parent commands
4141

4242
```
43-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
44-
-r, --regtest Indicates if regtest parameters should be used
45-
-s, --signet Indicates if the public signet parameters should be used
46-
-t, --testnet Indicates if testnet parameters should be used
43+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
44+
-r, --regtest Indicates if regtest parameters should be used
45+
--resultsdir string Directory where results should be stored (default "./results")
46+
-s, --signet Indicates if the public signet parameters should be used
47+
-t, --testnet Indicates if testnet parameters should be used
4748
```
4849

4950
### SEE ALSO

doc/chantools_dropchannelgraph.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,11 @@ chantools dropchannelgraph \
4444
### Options inherited from parent commands
4545

4646
```
47-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
48-
-r, --regtest Indicates if regtest parameters should be used
49-
-s, --signet Indicates if the public signet parameters should be used
50-
-t, --testnet Indicates if testnet parameters should be used
47+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
48+
-r, --regtest Indicates if regtest parameters should be used
49+
--resultsdir string Directory where results should be stored (default "./results")
50+
-s, --signet Indicates if the public signet parameters should be used
51+
-t, --testnet Indicates if testnet parameters should be used
5152
```
5253

5354
### SEE ALSO

doc/chantools_dropgraphzombies.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,11 @@ chantools dropgraphzombies \
3535
### Options inherited from parent commands
3636

3737
```
38-
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
39-
-r, --regtest Indicates if regtest parameters should be used
40-
-s, --signet Indicates if the public signet parameters should be used
41-
-t, --testnet Indicates if testnet parameters should be used
38+
--nologfile If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
39+
-r, --regtest Indicates if regtest parameters should be used
40+
--resultsdir string Directory where results should be stored (default "./results")
41+
-s, --signet Indicates if the public signet parameters should be used
42+
-t, --testnet Indicates if testnet parameters should be used
4243
```
4344

4445
### SEE ALSO

0 commit comments

Comments
 (0)