pwmc.1.in

   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
  16 ..
  17 .if \n[.g] .mso www.tmac
  18 .TH PWMD 1 "22 Nov 2007" "Password Manager Client" "Password Manager Client"
  19 .SH NAME
  20
  21 pwmc \- send commands to pwmd
  22 .SH SYNOPSIS
  23 .B pwmc
  24 [\-hvX] [\-E] [\-s <socket>] [\-a [\-P <pinentry_path>] [\-D <display>] [\-T
  25 <tty>] [\-N <term>] [\-t <seconds>] | \-p <password>] [\-S] [\-d <descriptor>]
  26 [filename]
  27
  28 .SH DESCRIPTION
  29 .B pwmc
  30 is a
  31 .BR libpwmd (3)
  32 client for \fBpwmd\fR. Commands are read line-by-line from stdin until an EOF
  33 occurs. Element content or value set with the STORE command that contains
  34 either newline or tab characters should be base64 encoded. The
  35 .BR openssl (1)
  36 utility can do this and can make the base64 encoded string on one line
  37 with the 'base64 -A' switch.
  38
  39 .SH OPTIONS
  40 .TP
  41 .I "\-X"
  42 Disable showing of status messages from the server. By default they are
  43 printed to stderr.
  44 .TP
  45 .I "\-E"
  46 Exit after a command failure.
  47 .TP
  48 .I "\-s <socket>"
  49 Connect to the specified socket. The default is \fB~/.pwmd/socket\fR.
  50 .TP
  51 .I "\-a"
  52 Use
  53 .BR pinentry (1)
  54 for password retrieval.
  55 .TP
  56 .I "\-P <path>"
  57 The full path of the
  58 .BR pinentry (1)
  59 program. \fBlibpwmd\fP defaults to \fI@pinentry_path@\fP.
  60 .TP
  61 .I "\-D <display>"
  62 The pinentry display to use.
  63 .TP
  64 .I "\-T <tty>"
  65 The full path of the tty for pinentry to use.
  66 .TP
  67 .I "\-N <term>"
  68 The terminal type for pinentry to use. This is required when using
  69 .B -T
  70 if the invoking
  71 .B pwmc
  72 isn't attached to a terminal.
  73 .TP
  74 .I "\-t <seconds>"
  75 When opening a file and a password is required,
  76 .BR pinentry (1)
  77 will timeout after the specified amount of seconds. When saving a file and a
  78 password is required, no timeout will be used even if specified.
  79 .TP
  80 .I "\-p <password>"
  81 Use the specified password.
  82 .TP
  83 .I "\-S"
  84 Send the SAVE command after EOF.
  85 .TP
  86 .I "\-d <descriptor>"
  87 Writes the results of successful commands to the specified file descriptor.
  88 This may be needed if your using pinentry to retrieve a password but
  89 redirecting command results.
  90 .TP
  91 .I "\-v"
  92 Version information.
  93 .TP
  94 .I "\-h"
  95 Help text.
  96
  97 .SH EXAMPLES
  98 To list the available accounts and use
  99 .BR pinentry (1)
 100 to get the password:
 101 .RS
 102 echo list | pwmc -a filename
 103 .RE
 104 .P
 105 To store an element path and save the file afterwards:
 106 .RS
 107 echo -e 'store isp\\tsmtp\\thostname\\tsomehost.com' | pwmc -S filename
 108 .RE
 109 .P
 110 Clear the file cache for a single file:
 111 .RS
 112 echo 'clearcache filename' | pwmc
 113 .RE
 114 .P
 115 Multiple commands in one instance:
 116 .RS
 117 echo -e 'get isp\\tsmtp\\thostname\\nget isp\\tusername' | pwmc filename
 118 .RE
 119 .P
 120 Base 64 encoded content:
 121 .RS
 122 echo -e 'store blah\\tstuff\\t'`cat file | openssl base64 -A` | pwmc filename
 123 .P
 124 Then to get the content:
 125 .P
 126 echo -e 'get blah\\tstuff' | pwmc filename | openssl base64 -d -A
 127 .RE
 128
 129 .SH FILES
 130 .TP
 131 .B ~/.pwmd/socket
 132 Default socket to connect to.
 133 .TP
 134 .B @pinentry_path@
 135 Default location of the pinentry binary.
 136
 137
 138 .SH AUTHOR
 139 Ben Kibbey <bjk@luxsci.net>
 140 .br
 141 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
 142
 143 .SH "SEE ALSO"
 144 .BR pwmd (1),
 145 .BR pinentry (1),
 146 .BR openssl (1),
 147 .BR libpwmd (3)