From e47326ad4431a8cb9fa0136233cdef77782fe29f Mon Sep 17 00:00:00 2001 From: Samuel Creshal Date: Fri, 8 Apr 2016 15:32:47 +0200 Subject: [PATCH] Sync readme with current help text --- README.md | 55 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 33 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9867834..ea97166 100644 --- a/README.md +++ b/README.md @@ -10,34 +10,45 @@ See below for usage information and `HACKING.md` for architectural information. scrypt based password manager. - Actions: - new Prompts for title/description and generates a new password - with supplied entropy (default: 64 bit) - add Prompts for title, description and password - edit Edits an entry matching the query string - del Deletes the entry with the supplied ID - get Searches the DB for the supplied query string - Shows the whole database if no query is supplied, this can - take a while. - copy Same as 'get', uses `copy_command` on (selectable) query result. - Default: Calls xsel to copy the result to primary selection. - pwgen Generate a random password with supplied entropy and print it - (default: 64 bit) - import Imports passwords from a CSV file. - Column order is title, description, password - The format is the default Excel/Calc format (comma separation, - quoting optional). - migrate Re-syncs the database, migrating it to new database formats - and doing other maintenance if necessary. - This is also done automatically on all writing operations - (i.e., add/del/edit/new/import). +Actions: + new Prompts for title/description and generates a new password + with supplied entropy (default: 64 bit) + + add Prompts for title, description and password + + edit Edits an entry matching the query string + + del Deletes the entry with the supplied ID + + get Searches the DB for the supplied query string + Shows the whole database if no query is supplied, this can + take a while. + + list Same as get, but does not show passwords, only metadata. + + copy Same as 'get', uses `copy_command` on (selectable) query result. + Default: Calls xsel to copy the result to primary selection. + + pwgen Generate a random password with supplied entropy and print it + (default: 64 bit) + + import Imports passwords from a CSV file. + Column order is title, description, password + The format is the default Excel/Calc format (comma separation, + quoting optional). + + migrate Re-syncs the database, migrating it to new database formats + and doing other maintenance if necessary. + This is also done automatically on all writing operations + (i.e., add/del/edit/new/import). + Password generator options: x, xkcd Random word generator as per XKCD 936 a, alnum Random letters/numbers p, print Random characters (letters, digits, punctuation) - positional arguments: + Positional arguments: {migrate,new,add,edit,del,get,copy,pwgen,import} query Search string