Added pwmd_socket_fd(). This will let applications use the file
[libpwmd.git] / pwmc.1.in
blobca582cf45c652faf436514a889b874333074f778
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 "1 Jan 2008" "Password Manager Client" "Password Manager Client"
19 .SH NAME
21 pwmc \- send commands to pwmd
22 .SH SYNOPSIS
23 .B pwmc
24 [\-hvX] [\-s <socket>] [[\-P <pinentry_path>] [\-D <display>] [\-T
25 <tty>] [\-N <term>] | \-p <password>] [\-c <name>] [\-S] [\-d <fd>]
26 [\-I <fd>] [filename]
28 .SH DESCRIPTION
29 .B pwmc
30 is a
31 .BR libpwmd (3)
32 client for
33 .BR pwmd (1) .
34 Commands are read from standard input.
36 .SH OPTIONS
37 .TP
38 .I "\-X"
39 Disable showing of status messages from the server. By default they are
40 printed to stderr.
41 .I "\-s <socket>"
42 Connect to the specified socket. The default is \fB~/.pwmd/socket\fR.
43 .TP
44 .I "\-P <path>"
45 The full path of the
46 .BR pinentry (1)
47 program. The default is specified at
48 .BR pwmd (1)
49 compile time.
50 .TP
51 .I "\-D <display>"
52 The pinentry display to use.
53 .TP
54 .I "\-T <tty>"
55 The full path of the tty for pinentry to use.
56 .TP
57 .I "\-N <term>"
58 The terminal type for pinentry to use. This is required when using 
59 .B -T
60 if the invoking
61 .B pwmc
62 isn't attached to a terminal.
63 .TP
64 .I "\-p <password>"
65 Use the specified password.
66 .TP
67 .I "\-S"
68 Send the SAVE command before exiting.
69 .TP
70 .I "\-d <descriptor>"
71 Writes the results of successful commands to the specified file descriptor.
72 This may be needed if your using pinentry to retrieve a password but
73 redirecting command results.
74 .I "\-I <descriptor>"
75 Reads INQUIRE data from the specified file descriptor. Use this rather than
76 piping large amounts of data to save memory.
77 .TP
78 .I "\-c <name>"
79 Sets the client name to the specified string which will show up in log
80 messages.
81 .TP
82 .I "\-v"
83 Version information.
84 .TP
85 .I "\-h"
86 Help text.
88 .SH EXAMPLES
89 To list the available accounts and use
90 .BR pinentry (1)
91 to get the password:
92 .RS
93 echo list | pwmc filename
94 .RE
96 To store an element path and save the file afterwards:
97 .RS
98 echo -e 'store isp\\tsmtp\\thostname\\tsomehost.com' | pwmc -S filename
99 .RE
101 Store a large file:
103 echo -en 'store blah\\tstuff\\t' | pwmc -S -I 3 filename 3<data_file
105 Then to get the content:
107 echo -e 'get blah\\tstuff' | pwmc filename
110 Clear the file cache for a single file:
112 echo 'clearcache filename' | pwmc
115 .SH FILES
117 .B ~/.pwmd/socket
118 Default socket to connect to.
120 .SH AUTHOR
121 Ben Kibbey <bjk@luxsci.net>
123 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
125 .SH "SEE ALSO"
126 .BR pwmd (1),
127 .BR pinentry (1),
128 .BR openssl (1),
129 .BR libpwmd (3)