aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoursoir <chat@joursoir.net>2021-06-13 16:17:22 +0000
committerJoursoir <chat@joursoir.net>2021-06-13 16:17:22 +0000
commite91d24bd46e67a1b99bb7277eb00102ffb5ede7e (patch)
tree8ecb3b4fbd47efb0632c079af5c037243ee18b28
parent4397555dc22a77c6c2d227a4ae23d0ff144eeebb (diff)
downloadlock-password-e91d24bd46e67a1b99bb7277eb00102ffb5ede7e.tar.gz
lock-password-e91d24bd46e67a1b99bb7277eb00102ffb5ede7e.tar.bz2
lock-password-e91d24bd46e67a1b99bb7277eb00102ffb5ede7e.zip
update man and readme
-rw-r--r--README.md12
-rw-r--r--man/lpass.116
2 files changed, 18 insertions, 10 deletions
diff --git a/README.md b/README.md
index afe3b72..71d902f 100644
--- a/README.md
+++ b/README.md
@@ -16,13 +16,15 @@ sudo make install
```
## Synopsis:
-lpass [command] [options]
+**lpass** *command* [*options*]
## Commands:
### init *gpg-key*
Initialize the password manager using the passed *gpg-key* as the encryption key. This command must be run first before you start working with LockPassword.
### insert [**-e, --echo**] [**-c, --copy**] [**-f, --force**] *passname*
Add the specified *passname* to the password manager. The password will be read interactively using standard input, character display is hidden. The **-e, --echo** argument enable the show of characters when typing a password; **-c, --copy** write password to clipboard; **-f, --force** ignore exist of *passname*, overwrites it without prompt.
+### show [**-c, --copy**] [**-C, --no-color**] [*passname*]
+If no *passname* is specified, *passname* will assign root of password manager tree. If *passname* is directory, list names of passwords inside the at *passname*. Otherwise decrypt and print a password of *passname*. The **-c, --copy** write password to clipboard; **-C, --no-color** cancel colorize the output.
### edit *passname*
Open the specified *passname* in a text editor, waiting for changes. The text editor specified in the environment variable EDITOR or vi(1) is used. Temporary file for password editing locate in tmpfs / ramfs (we expect that it to be mounted at /dev/shm).
### generate [**-l, --length=pass-length**] [**-c, --copy**] [**-f, --force**] *passname*
@@ -57,7 +59,7 @@ Password added successfully for games/chess/user
* Print a list of exists password:
```
-$ lpass
+$ lpass show
Password Manager
|-- banks
| |-- abankpro
@@ -72,7 +74,7 @@ Password Manager
* Print a list of exists password in some directory:
```
-$ lpass banks
+$ lpass show banks
Password Manager/banks
|-- abankpro
| `-- phone_number
@@ -82,13 +84,13 @@ Password Manager/banks
* Show password:
```
-$ lpass games/iko/LordOfNight
+$ lpass show games/iko/LordOfNight
helloitismypassword123
```
* Copy password to clipboard:
```
-$ lpass -c games/iko/LordOfNight
+$ lpass show -c games/iko/LordOfNight
```
* Generate password:
diff --git a/man/lpass.1 b/man/lpass.1
index 23ab904..ade80b1 100644
--- a/man/lpass.1
+++ b/man/lpass.1
@@ -4,7 +4,7 @@
LockPassword - a password manager.
.SH "SYNOPSIS"
-\fBlpass\fR [command] [options]
+\fBlpass\fR \fIcommand\fR [\fIoptions\fR]
.SH "DESCRIPTION"
\fBlpass\fR - a simple terminal password manager, using GnuPG to encrypt passwords.
@@ -22,6 +22,12 @@ Add the specified \fIpassname\fR to the password manager. The password will be r
.RE
.PP
+\fBshow\fR [-c, --copy] [-C, --no-color] [\fIpassname\fR]
+.RS 4
+If no \fIpassname\fR is specified, \fIpassname\fR will assign root of password manager tree. If \fIpassname\fR is directory, list names of passwords inside the at \fIpassname\fR. Otherwise decrypt and print a password of \fIpassname\fR. The \fB-c, --copy\fR write password to clipboard; \fB-C, --no-color\fR cancel colorize the output.
+.RE
+.PP
+
\fBedit \fIpassname\fR
.RS 4
Open the specified \fIpassname\fR in a text editor, waiting for changes. The text editor specified in the environment variable EDITOR or \fBvi\fR(1) is used. Temporary file for password editing locate in tmpfs / ramfs (we expect that it to be mounted at /dev/shm).
@@ -82,7 +88,7 @@ Password added successfully for games/chess/user
Print a list of exists password:
.RS 4
-\fB$ lpass\fR
+\fB$ lpass show\fR
.br
Password Manager
.br
@@ -108,7 +114,7 @@ Password Manager
Print a list of exists password in some directory:
.RS 4
-\fB$ lpass banks\fR
+\fB$ lpass show banks\fR
.br
Password Manager/banks
.br
@@ -124,7 +130,7 @@ Password Manager/banks
Show password:
.RS 4
-\fB$ lpass games/iko/LordOfNight\fR
+\fB$ lpass show games/iko/LordOfNight\fR
.br
helloitismypassword123
.RE
@@ -132,7 +138,7 @@ helloitismypassword123
Copy password to clipboard:
.RS 4
-\fB$ lpass -c games/iko/LordOfNight
+\fB$ lpass show -c games/iko/LordOfNight
.RE
.PP