aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemsen2012-12-16 22:20:34 +0100
committerGravatar Tom Willemsen2012-12-16 22:20:34 +0100
commit5a231647d824978a9640791fbbb6aad95c204841 (patch)
tree9a8512f778703228b30befca8138cdd14c4f3cab
parent58216d78b5a75592c2de291ba030870d853bde13 (diff)
downloaddispass.el-5a231647d824978a9640791fbbb6aad95c204841.tar.gz
dispass.el-5a231647d824978a9640791fbbb6aad95c204841.zip
Update README.org
There were some things left unexplained in it.
-rw-r--r--README.org79
1 files changed, 57 insertions, 22 deletions
diff --git a/README.org b/README.org
index 156fa0d..f55d3b5 100644
--- a/README.org
+++ b/README.org
@@ -21,36 +21,71 @@
(require 'dispass)
#+end_src
- /Or/ if you have ~package.el~ you could use ~package-install-file~.
+ /Or/ if you have ~package.el~ with the Marmalade and/or MELPA
+ repositories set-up you could use ~package-install-file~.
** Customization
- ~dispass.el~ only offers customization of the ~dispass-executable~
- variable for the moment. This is the location where the DisPass
- executable is located.
+ ~dispass.el~ offers a few customizable settings, all of these can be
+ changed using the Emacs customization interface, or of course your
+ Emacs init file:
+
+ - =dispass-default-length= :: The default length of passprases
+ generated by DisPass, when no length has been specified in
+ the labels file for a given label.
+
+ - =dispass-executable= :: The place where the ~dispass~ executable
+ script is located.
+
+ - =dispass-labels-executable= :: The place where the ~dispass-labels~
+ executable script is located.
+
+ - ~dispass-file~ :: The location of your DisPass label file.
** Usage
- Using dispass.el is simple, once installed. Either call =dispass= to
- recall a previously generated password or call =dispass-create= to
- generate a new password.
+ Using dispass.el is simple, once installed.
+
+*** Creating and regenerating passphrases
+
+ To create a new passphrase use the command ~dispass-create~, to
+ regenerate a previously stored one use ~dispass~.[fn:1]
+
+ When a numeric argument is used when calling either =dispass-create=
+ or =dispass=, that argument is sent to the dispass program along
+ with the ~-l~ switch. This cuts the length of the password to that
+ many characters. For example:
+
+ #+begin_example
+ C-5 M-x dispass<RET> test<RET> test<RET>
+ #+end_example
+
+ will generate a passphrase of 5 characters for label "test" and
+ password "test".
+
+ Once a passphrase has been generated it is inserted into the kill
+ ring and the system's clipboard so it can be easily inserted into
+ any password field, unfortunately this also makes the generated
+ passphrase easy to see in plaintext in the =kill-ring= variable,
+ though.
+
+*** Listing/managing labels
- The only real difference between the two is that =dispass-create=
- asks to confirm the password. Both will ask for a label.
+ With the command ~dispass-list-labels~ you can get an overview of
+ the labels you have stored in your labels file, along with their
+ stored meta-data.
- When a numeric argument is used when calling either =dispass-create=
- or =dispass=, that argument is sent to the dispass program along with
- the ~-l~ switch. This cuts the length of the password to that many
- characters. For example:
+ Some label management functions are available in this mode,
+ namely adding and removing labels. See the mode description for
+ a list of keybindings.
- #+begin_example
- C-5 M-x dispass<RET> test<RET> test<RET>
- #+end_example
+ Apart from the keybindings available in the list buffer there are
+ also the commands ~dispass-add-label~ and ~dispass-remove-label~
+ which add and remove a label respectively.
- will generate a password of 5 characters for label "test" and
- password "test".
+* Footnotes
- Once a password has been generated it is inserted into the kill
- ring and the system's clipboard so it can be easily inserted into
- password field, this makes the generated password easy to see in
- plaintext in the =kill-ring= variable, though.
+ [fn:1] There is no requirement to first call ~dispass-create~ before
+ using ~dispass~, but the former asks for confirmation of the password
+ and newer version of DisPass will automatically store the label and
+ its meta-data (such as length) in your labels file.