Updated and added some examples.
[libpwmd.git] / pwmc.1
blob11c7d91d1d15c6fb2a2f40ecdf33b3b3abc74ec3
1 .\" This program is free software; you can redistribute it and/or modify
2 .\" it under the terms of the GNU General Public License as published by
3 .\" the Free Software Foundation; either version 2 of the License, or
4 .\" (at your option) any later version.
5 .\" 
6 .\" This program is distributed in the hope that it will be useful,
7 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
8 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9 .\" GNU General Public License for more details.
10 .\" 
11 .\" You should have received a copy of the GNU General Public License
12 .\" along with this program; if not, write to the Free Software
13 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14 .de URL
15 \\$2 \(laURL: \\$1 \(ra\\$3
17 .if \n[.g] .mso www.tmac
18 .TH PWMD 1 "11 Jul 2007" "Password Manager Client" "Password Manager Client"
19 .SH NAME
21 pwmc \- send commands to pwmd
22 .SH SYNOPSIS
23 .B pwmc
24 [\-hv] [\-E] [\-s <socket>] [\-a [-P pinentry_path] | \-p <password>] [\-S] <filename>
26 .SH DESCRIPTION
27 .B pwmc
28 connects to \fBpwmd\fR and opens \fBfilename\fR. Commands are read
29 line-by-line from stdin until an EOF occurs. For element values that contain
30 newline or tab characters, they should be base64 encoded. The
31 .BR openssl (1)
32 utility can do this and make the base64 string on one line (base64 -A).
34 .SH OPTIONS
35 .TP
36 .I "\-E"
37 Exit after a command failure.
38 .TP
39 .I "\-s <socket>"
40 Connect to the specified socket. The default is \fB~/.pwmd/socket\fR.
41 .TP
42 .I "\-a"
43 Use 
44 .BR pinentry (1)
45 for password retrieval.
46 .TP
47 .I "\-P <path>"
48 The full path of the
49 .BR pinentry (1)
50 program. \fBlibpwmd\fP defaults to \fI/usr/bin/pinentry\fP.
51 .TP
52 .I "\-p <password>"
53 Use the specified password.
54 .TP
55 .I "\-S"
56 Send the SAVE command after EOF.
57 .TP
58 .I "\-v"
59 Version information.
60 .TP
61 .I "\-h"
62 Help text.
64 .SH EXAMPLES
65 To list the available accounts and use
66 .BR pinentry (1)
67 to get the password:
68 .RS
69 echo list | pwmc -a filename
70 .RE
72 To store an element path and save the file afterwards:
73 .RS
74 echo -e 'store isp\\tsmtp\\thostname\\tsomehost.com' | pwmc -S filename
75 .RE
77 Clear the file cache for a single file:
78 .RS
79 echo 'clearcache filename' | pwmc
80 .RE
82 Multiple commands in one instance:
83 .RS
84 echo -e 'get isp\\tsmtp\\thostname\\nget isp\\tusername' | pwmc filename
85 .RE
87 .SH FILES
88 .TP
89 .B ~/.pwmd/socket
90 Default socket to connect to.
93 .SH AUTHOR
94 Ben Kibbey <bjk@luxsci.net>
95 .br
96 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
98 .SH "SEE ALSO"
99 .BR pwmd (1),
100 .BR pinentry (1),
101 .BR openssl (1)