aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2021-07-05 15:20:12 -0400
committerJesse Luehrs <doy@tozt.net>2021-07-05 15:20:12 -0400
commit0c35b70808b69f64da3dd1fa1f0e0f90c860d75d (patch)
tree48e322ee1cf17a2d15739715dce4953d578d3271
parent9ec889b9ec4ba5075be71bd5a379c4c75b823d61 (diff)
downloadrbw-0c35b70808b69f64da3dd1fa1f0e0f90c860d75d.tar.gz
rbw-0c35b70808b69f64da3dd1fa1f0e0f90c860d75d.zip
clarify usage information in the README
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 8e30f7f..5cb74e9 100644
--- a/README.md
+++ b/README.md
@@ -66,11 +66,17 @@ configuration options:
## Usage
Commands can generally be used directly, and will handle logging in or
-unlocking as necessary. For instance, running `rbw ls` will unlock the password
-database before generating the list of entries (but will not attempt to log in
-to the server), `rbw sync` will log in to the server before downloading the
-password database (but will not unlock the database), and `rbw generate` will
-do both.
+unlocking as necessary. For instance, running `rbw ls` will run `rbw unlock` to
+unlock the password database before generating the list of entries (but will
+not attempt to log in to the server), `rbw sync` will automatically run `rbw
+login` to log in to the server before downloading the password database (but
+will not unlock the database), and `rbw add` will do both.
+
+Logging into the server and unlocking the database will only be done as
+necessary, so running `rbw login` when you are already logged in will do
+nothing, and similarly for `rbw unlock`. If necessary, you can explicitly log
+out by running `rbw purge`, and you can explicitly lock the database by running
+`rbw lock` or `rbw stop-agent`.
`rbw help` can be used to get more information about the available
functionality.