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 "10 Dec 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] [\-s <socket>] [[\-P <pinentry_path>] [\-D <display>] [\-T
  25 <tty>] [\-N <term>] [\-t <seconds>] | \-p <password>] [\-S] [\-d <fd>]
  26 [\-I <fd>] [filename]
  27
  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.
  35
  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 "\-t <seconds>"
  65 When opening a file and a password is required,
  66 .BR pinentry (1)
  67 will timeout after the specified amount of seconds. When saving a file and a
  68 password is required, no timeout will be used even if specified.
  69 .TP
  70 .I "\-p <password>"
  71 Use the specified password.
  72 .TP
  73 .I "\-S"
  74 Send the SAVE command before exiting.
  75 .TP
  76 .I "\-d <descriptor>"
  77 Writes the results of successful commands to the specified file descriptor.
  78 This may be needed if your using pinentry to retrieve a password but
  79 redirecting command results.
  80 .I "\-I <descriptor>"
  81 Reads INQUIRE data from the specified file descriptor. Use this rather than
  82 piping large amounts of data to save memory.
  83 .TP
  84 .I "\-v"
  85 Version information.
  86 .TP
  87 .I "\-h"
  88 Help text.
  89
  90 .SH EXAMPLES
  91 To list the available accounts and use
  92 .BR pinentry (1)
  93 to get the password:
  94 .RS
  95 echo list | pwmc filename
  96 .RE
  97 .P
  98 To store an element path and save the file afterwards:
  99 .RS
 100 echo -e 'store isp\\tsmtp\\thostname\\tsomehost.com' | pwmc -S filename
 101 .RE
 102 .P
 103 Store a large file:
 104 .RS
 105 echo -en 'store blah\\tstuff\\t' | pwmc -S -I 3 filename 3<data_file
 106 .P
 107 Then to get the content:
 108 .P
 109 echo -e 'get blah\\tstuff' | pwmc filename
 110 .RE
 111 .P
 112 Clear the file cache for a single file:
 113 .RS
 114 echo 'clearcache filename' | pwmc
 115 .RE
 116
 117 .SH FILES
 118 .TP
 119 .B ~/.pwmd/socket
 120 Default socket to connect to.
 121
 122 .SH AUTHOR
 123 Ben Kibbey <bjk@luxsci.net>
 124 .br
 125 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
 126
 127 .SH "SEE ALSO"
 128 .BR pwmd (1),
 129 .BR pinentry (1),
 130 .BR openssl (1),
 131 .BR libpwmd (3)