Skip to content

Commit 08323c2

Browse files
author
Anand
committed
Updated README for issue #8
1 parent 441f361 commit 08323c2

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

README.md

+32-10
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Table of Contents
1111
* [Encryption and Security](#encryption-and-security)
1212
* [Databases](#databases)
1313
* [Listing and Searching](#listing-and-searching)
14+
* [Misc](#misc)
1415
* [Export](#export)
1516
* [Configuration](#configuration)
1617
* [License](#license)
@@ -67,6 +68,7 @@ Usage
6768

6869
$ varuh -h
6970

71+
7072
SYNOPSIS
7173

7274
varuh [options] [flags]
@@ -75,22 +77,26 @@ Usage
7577

7678
EDIT/CREATE ACTIONS:
7779

78-
-C --clone <id> Clone an entry
79-
-U --use-db <path> Set as active database
80-
-E --edit <id> Edit entry by id
8180
-A --add Add a new entry
8281
-I --init <path> Initialize a new database
83-
-d --decrypt <path> Decrypt password database
84-
-e --encrypt Encrypt the current database
8582
-R --remove <id> Remove an entry
83+
-e --encrypt Encrypt the current database
84+
-d --decrypt <path> Decrypt password database
85+
-C --clone <id> Clone an entry
86+
-U --use-db <path> Set as active database
87+
-E --edit <id> Edit entry by id
8688

8789
FIND/LIST ACTIONS:
8890

89-
-x --export <filename> Export all entries to <filename>
90-
-a --list-all List all entries in current database
91-
-p --path Show current database path
9291
-f --find <term> Search entries
9392
-l --list-entry <id> List entry by id
93+
-x --export <filename> Export all entries to <filename>
94+
-p --path Show current database path
95+
-a --list-all List all entries in current database
96+
97+
MISC ACTIONS:
98+
99+
-g --genpass <length> Generate password of given length
94100

95101
HELP ACTIONS:
96102

@@ -104,10 +110,10 @@ Usage
104110

105111

106112
AUTHORS
107-
Copyright (C) 2021 Anand B Pillai <[email protected]>
113+
Copyright (C) 2021 Anand B Pillai <[email protected]>
108114

109115

110-
The command line flags are grouped into `Edit/Create`, `Find/List` and `Help` actions. The first group of actions allows you to work with password databases and perform create/edit as well as encrypt/decrypt actions. The second set of actions allows you to work with an active decrypted database and view/search/list entries.
116+
The command line flags are grouped into `Edit/Create`, `Find/List`, `Misc` and `Help` actions. The first group of actions allows you to work with password databases and perform create/edit as well as encrypt/decrypt actions. The second set of actions allows you to work with an active decrypted database and view/search/list entries.
111117

112118
Encryption and Security
113119
=======================
@@ -439,6 +445,22 @@ If `pdftk` is installed, the PDF files will be encrypted with an (optional) pass
439445
Added password to passwds.pdf.
440446
Exported to passwds.pdf.
441447

448+
Misc
449+
====
450+
451+
The following miscellaneous actions are supported.
452+
453+
Generate a secure password of given length.
454+
455+
$ varuh -g
456+
7nhga7tkk9LNafz
457+
458+
By passing the `-c` option, the password is also copied to the clipboard.
459+
460+
$ varuh -g 15 -c
461+
yeXlLlk??IOsvL6
462+
Password copied to clipboard
463+
442464

443465
Configuration
444466
=============

0 commit comments

Comments
 (0)