Update TODO.
[clive-utils.git] / clivepass.1
blob3b6277a817137b7b2ade995f86a9b42e613746e8
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
134 .IX Title "clivepass 1"
135 .TH clivepass 1 "2009-05-15" "2.1.6" "clivepass manual"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
140 .SH "NAME"
141 clivepass \- the login password utility for clive
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 clivepass [option]...
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 clivepass is a replacement for stored plain-text website login passwords used
148 with \fIclive\fR\|(1). It keeps website login passwords encrypted in a repository
149 file that can be accessed with a global passphrase. Typically these login
150 passwords are passed in plain-text form to \fIclive\fR\|(1) on command line or
151 from a config file.
153 Note that even though the passwords are encrypted on disk, they are passed
154 in plain-text over the network. This means the passwords are still visible to
155 anyone intercepting the network traffic.
157 Historically, a similar utility existed as part of clive 1.0 but was removed
158 in clive 2.0 and later rewritten in Perl as part of the \fBclive-utils\fR project
159 which is a set of additional utilities for \fIclive\fR\|(1).
160 .SH "OPTIONS"
161 .IX Header "OPTIONS"
162 .IP "\fB\-h \-\-help\fR" 4
163 .IX Item "-h --help"
164 Show help and exit.
165 .IP "\fB\-v \-\-version\fR" 4
166 .IX Item "-v --version"
167 Show version and exit.
168 .IP "\fB\-c \-\-create\fR" 4
169 .IX Item "-c --create"
170 Create a new passwd file. See also \*(L"\s-1FILES\s0\*(R".
171 .IP "\fB\-a \-\-add=\fR\fIusername\fR" 4
172 .IX Item "-a --add=username"
173 Add a new login for \fIusername\fR.
174 .IP "\fB\-e \-\-edit=\fR\fIusername\fR" 4
175 .IX Item "-e --edit=username"
176 Change login password for \fIusername\fR.
177 .IP "\fB\-g \-\-get=\fR\fIusername\fR" 4
178 .IX Item "-g --get=username"
179 Dump \fIusername\fR decrypted login password to stdout.
180 .IP "\fB\-s \-\-show\fR" 4
181 .IX Item "-s --show"
182 Dump all saved login usernames to stdout.
183 .IP "\fB\-d \-\-delete=\fR\fIusername\fR" 4
184 .IX Item "-d --delete=username"
185 Delete \fIusername\fR from passwd file.
186 .SH "EXAMPLES"
187 .IX Header "EXAMPLES"
188 .IP "Create new password repository file:" 4
189 .IX Item "Create new password repository file:"
190 % clivepass \-c
191 .ie n .IP "Add ""myusername"" to the repository:" 4
192 .el .IP "Add ``myusername'' to the repository:" 4
193 .IX Item "Add myusername to the repository:"
194 % clivepass \-a myusername
196 Note that \*(L"myusername\*(R" should be the login username for the website.
197 .ie n .IP "Get login password for ""myusername"":" 4
198 .el .IP "Get login password for ``myusername'':" 4
199 .IX Item "Get login password for myusername:"
200 % clivepass \-g myusername
202 There is a more comprehensive example of \fIclive\fR\|(1) using \fIclivepass\fR\|(1)
203 in the \fIclive\fR\|(1) manual page.
204 .SH "FILES"
205 .IX Header "FILES"
206 clivepass searches the ~/.config/clive\-utils directory for the config file.
207 You can override this by setting the \fB\s-1CLIVEPASS_HOME\s0\fR environment variable.
208 .IP "~/.config/clive\-utils/passwd" 4
209 .IX Item "~/.config/clive-utils/passwd"
210 Password file. Contains the salted passphrase hash and login usernames and
211 encrypted passwords.
212 .SH "SEE ALSO"
213 .IX Header "SEE ALSO"
214 \&\fIclive\fR\|(1) \fIclivescan\fR\|(1) \fIclivefeed\fR\|(1)
215 .SH "OTHER"
216 .IX Header "OTHER"
217 Project page:
218   <http://googlecode.com/p/clive\-utils/>
220 Development repository can be cloned with:
221   % git clone git://repo.or.cz/clive\-utils.git
223 For release announcements, subscribe to the project at:
224   <http://freshmeat.net/projects/clive\-utils/>
225 .SH "AUTHOR"
226 .IX Header "AUTHOR"
227 Written by Toni Gundogdu <legatvs@gmail.com>