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 "3 Mar 2008" "Password Manager Client" "Password Manager Client"
  19 .SH NAME
  20
  21 pwmc \- send a command 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 [\-i <iter>]] [\-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 A command is read from standard input and output is sent to either a file
  35 descriptor or standard output.
  36
  37 .SH OPTIONS
  38 .TP
  39 .I "\-X"
  40 Disable showing of status messages from the server. By default they are
  41 printed to stderr.
  42 .I "\-s <socket>"
  43 Connect to the specified socket. The default is \fB~/.pwmd/socket\fR.
  44 .TP
  45 .I "\-P <path>"
  46 The full path of the
  47 .BR pinentry (1)
  48 program. The default is specified at
  49 .BR pwmd (1)
  50 compile time.
  51 .TP
  52 .I "\-D <display>"
  53 The pinentry display to use.
  54 .TP
  55 .I "\-T <tty>"
  56 The full path of the tty for pinentry to use.
  57 .TP
  58 .I "\-N <term>"
  59 The terminal type for pinentry to use. This is required when using
  60 .B -T
  61 if the invoking
  62 .B pwmc
  63 isn't attached to a terminal.
  64 .TP
  65 .I "\-p <password>"
  66 Use the specified password. When not specified and the file is not cached,
  67 .BR pinentry (1)
  68 will be used.
  69 .TP
  70 .I "\-S"
  71 Send the SAVE command before exiting.
  72 .TP
  73 .I "\-i"
  74 Encrypt with the specified number of iterations when saving. Note that
  75 \fI-1\fP disables encryption and that \fI0\fP is really 1 iteration.
  76 .TP
  77 .I "\-d <descriptor>"
  78 Writes the result of a command to the specified file descriptor. This may be
  79 needed if your using pinentry to retrieve a password but redirecting standard
  80 output.
  81 .I "\-I <descriptor>"
  82 Reads INQUIRE data from the specified file descriptor. Use this rather than
  83 piping large amounts of data to save memory.
  84 .TP
  85 .I "\-c <name>"
  86 Sets the client name to the specified string which will show up in log
  87 messages.
  88 .TP
  89 .I "\-v"
  90 Version information.
  91 .TP
  92 .I "\-h"
  93 Help text.
  94
  95 .SH EXAMPLES
  96 To list the available accounts and use
  97 .BR pinentry (1)
  98 to get the password:
  99 .RS
 100 echo list | pwmc filename
 101 .RE
 102 .P
 103 To store an element path and save the file afterwards:
 104 .RS
 105 echo -ne 'store isp\\tsmtp\\thostname\\tsomehost.com' | pwmc -S filename
 106 .RE
 107 .P
 108 Store a large file:
 109 .RS
 110 echo -en 'store blah\\tstuff\\t' | pwmc -S -I 3 filename 3<data_file
 111 .P
 112 And then to get the content:
 113 .P
 114 echo -e 'get blah\\tstuff' | pwmc filename
 115 .RE
 116 .P
 117 Clear the file cache for a single file:
 118 .RS
 119 echo 'clearcache filename' | pwmc
 120 .RE
 121
 122 .SH FILES
 123 .TP
 124 .B ~/.pwmd/socket
 125 Default socket to connect to.
 126 .TP
 127 .B @pinentry@
 128 Default location of the
 129 .BR pinentry (1)
 130 binary.
 131
 132 .SH AUTHOR
 133 Ben Kibbey <bjk@luxsci.net>
 134 .br
 135 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
 136
 137 .SH "SEE ALSO"
 138 .BR pwmd (1),
 139 .BR pinentry (1),
 140 .BR libpwmd (3)