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