clivepass.pod

   1 =head1 NAME
   2
   3 clivepass - the login password utility for clive
   4
   5 =head1 SYNOPSIS
   6
   7 clivepass [option]...
   8
   9 =head1 DESCRIPTION
  10
  11 clivepass is a replacement for stored plain-text website login passwords used
  12 with L<clive(1)>. It keeps website login passwords encrypted in a repository
  13 file that can be accessed with a global passphrase. Typically these login
  14 passwords are passed in plain-text form to L<clive(1)> on command line or
  15 from a config file.
  16
  17 Note that even though the passwords are encrypted on disk, they are passed
  18 in plain-text over the network. This means the passwords are still visible to
  19 anyone intercepting the network traffic.
  20
  21 Historically, a similar utility existed as part of clive 1.0 but was removed
  22 in clive 2.0 and later rewritten in Perl as part of the B<clive-utils> project
  23 which is a set of additional utilities for L<clive(1)>.
  24
  25 =head1 OPTIONS
  26
  27 =over 4
  28
  29 =item B<-h --help>
  30
  31 Show help and exit.
  32
  33 =item B<-v --version>
  34
  35 Show version and exit.
  36
  37 =item B<-c --create>
  38
  39 Create a new passwd file. See also L</FILES>.
  40
  41 =item B<-a --add=>I<username>
  42
  43 Add a new login for I<username>.
  44
  45 =item B<-e --edit=>I<username>
  46
  47 Change login password for I<username>.
  48
  49 =item B<-g --get=>I<username>
  50
  51 Dump I<username> decrypted login password to stdout.
  52
  53 =item B<-s --show>
  54
  55 Dump all saved login usernames to stdout.
  56
  57 =item B<-d --delete=>I<username>
  58
  59 Delete I<username> from passwd file.
  60
  61 =back
  62
  63 =head1 EXAMPLES
  64
  65 =over 4
  66
  67 =item Create new password repository file:
  68
  69 % clivepass -c
  70
  71 =item Add "myusername" to the repository:
  72
  73 % clivepass -a myusername
  74
  75 Note that "myusername" should be the login username for the website.
  76
  77 =item Get login password for "myusername":
  78
  79 % clivepass -g myusername
  80
  81 There is a more comprehensive example of L<clive(1)> using L<clivepass(1)>
  82 in the L<clive(1)> manual page.
  83
  84 =back
  85
  86 =head1 FILES
  87
  88 clivepass searches the ~/.config/clive-utils directory for the config file.
  89 You can override this by setting the B<CLIVEPASS_HOME> environment variable.
  90
  91 =over 4
  92
  93 =item ~/.config/clive-utils/passwd
  94
  95 Password file. Contains the salted passphrase hash and login usernames and
  96 encrypted passwords.
  97
  98 =back
  99
 100 =head1 SEE ALSO
 101
 102 L<clive(1)> L<clivescan(1)> L<clivefeed(1)>
 103
 104 =head1 OTHER
 105
 106 Project page:
 107   <http://googlecode.com/p/clive-utils/>
 108
 109 Development repository can be cloned with:
 110   % git clone git://repo.or.cz/clive-utils.git
 111
 112 For release announcements, subscribe to the project at:
 113   <http://freshmeat.net/projects/clive-utils/>
 114
 115 =head1 AUTHOR
 116
 117 Written by Toni Gundogdu <legatvs@gmail.com>
 118
 119 =cut