ryuslash/dispass.el
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.org

Browse source 
There were some things left unexplained in it.
This commit is contained in:
Tom Willemsen 2012-12-16 22:20:34 +01:00
parent 58216d78b5
commit 5a231647d8
1 changed files with 57 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
README.org
View file

@ -21,36 +21,71 @@
(require 'dispass) (require 'dispass)
#+end_src #+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 ** Customization
~dispass.el~ only offers customization of the ~dispass-executable~ ~dispass.el~ offers a few customizable settings, all of these can be
variable for the moment. This is the location where the DisPass changed using the Emacs customization interface, or of course your
executable is located. 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 ** Usage
Using dispass.el is simple, once installed. Either call =dispass= to Using dispass.el is simple, once installed.
recall a previously generated password or call =dispass-create= to
generate a new password.
The only real difference between the two is that =dispass-create= *** Creating and regenerating passphrases
asks to confirm the password. Both will ask for a label.
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= When a numeric argument is used when calling either =dispass-create=
or =dispass=, that argument is sent to the dispass program along with or =dispass=, that argument is sent to the dispass program along
the ~-l~ switch. This cuts the length of the password to that many with the ~-l~ switch. This cuts the length of the password to that
characters. For example: many characters. For example:
#+begin_example #+begin_example
C-5 M-x dispass<RET> test<RET> test<RET> C-5 M-x dispass<RET> test<RET> test<RET>
#+end_example #+end_example
will generate a password of 5 characters for label "test" and will generate a passphrase of 5 characters for label "test" and
password "test". password "test".
Once a password has been generated it is inserted into the kill 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 ring and the system's clipboard so it can be easily inserted into
password field, this makes the generated password easy to see in any password field, unfortunately this also makes the generated
plaintext in the =kill-ring= variable, though. passphrase easy to see in plaintext in the =kill-ring= variable,
though.
*** Listing/managing labels
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.
Some label management functions are available in this mode,
namely adding and removing labels. See the mode description for
a list of keybindings.
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.
* Footnotes
[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.