Add method help docs

This commit is contained in:
ghubstan 2021-01-17 12:58:26 -03:00
parent 13d0d3e9f1
commit 44c11922a6
No known key found for this signature in database
GPG key ID: E35592D6800A861E
3 changed files with 65 additions and 0 deletions

View file

@ -0,0 +1,19 @@
removewalletpassword
NAME
----
removewalletpassword - remove a Bisq wallet's encryption password
SYNOPSIS
--------
removewalletpassword
--wallet-password=<wallet-password>
--timeout=<seconds>
DESCRIPTION
-----------
Remove an encryption password from an encrypted Bisq wallet.
EXAMPLES
--------
$ ./bisq-cli --password=xyz --port=9998 removewalletpassword --wallet-password=mypassword

View file

@ -0,0 +1,25 @@
setwalletpassword
NAME
----
setwalletpassword - set Bisq wallet password
SYNOPSIS
--------
setwalletpassword
--wallet-password=<wallet-password>
--new-wallet-password=<new-wallet-password>
DESCRIPTION
-----------
Encrypts a Bisq wallet with a password. If the optional new wallet password option is
present, a new wallet password replaces the existing password
EXAMPLES
--------
Encrypt an unencrypted Bisq wallet with a password:
$ ./bisq-cli --password=xyz --port=9998 setwalletpassword --wallet-password=mypassword
Set a new password on a Bisq wallet that is already encrypted:
$ ./bisq-cli --password=xyz --port=9998 setwalletpassword --wallet-password=myoldpassword \
--new-wallet-password=mynewpassword

View file

@ -0,0 +1,21 @@
unlockwallet
NAME
----
unlockwallet - unlock an encrypted Bisq wallet
SYNOPSIS
--------
unlockwallet
--wallet-password=<wallet-password>
--timeout=<seconds>
DESCRIPTION
-----------
Unlocks an encrypted Bisq wallet for a specified number of seconds.
The timeout can be manually overridden with the lockwallet command.
EXAMPLES
--------
Unlock a wallet encrypted with the wallet-password "mypassword" for 30 seconds:
$ ./bisq-cli --password=xyz --port=9998 unlockwallet --wallet-password=mypassword --timeout=30