doc/pwmd.1

   1 .\" Copyright (C) 2006  Ben Kibbey <bjk@luxsci.net>
   2 .\"
   3 .\" This program is free software; you can redistribute it and/or modify
   4 .\" it under the terms of the GNU General Public License as published by
   5 .\" the Free Software Foundation; either version 2 of the License, or
   6 .\" (at your option) any later version.
   7 .\"
   8 .\" This program is distributed in the hope that it will be useful,
   9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 .\" GNU General Public License for more details.
  12 .\"
  13 .\" You should have received a copy of the GNU General Public License
  14 .\" along with this program; if not, write to the Free Software
  15 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  16 .de URL
  17 \\$2 \(laURL: \\$1 \(ra\\$3
  18 ..
  19 .if \n[.g] .mso www.tmac
  20 .TH PWMD 1 "31 Dec 2006" "Password Manager Daemon" "Password Manager Daemon"
  21 .SH NAME
  22
  23 pwmd \- serve clients sensitive data
  24 .SH SYNOPSIS
  25 .B pwmd
  26 [\-hv] [\-M] [\-l <log_file>] [\-C cache_size>] [\-s <socket_path>] [-d <data_directory>]
  27
  28 .SH DESCRIPTION
  29 .B pwmd
  30 is a daemon that listens for connections on a local socket. Clients connect to
  31 the server and can get or modify "account" data. The data is stored in an
  32 encrypted XML file on the local filesystem.
  33
  34 .SH OPTIONS
  35 .TP
  36 .I "\-s socket_path"
  37 Listen on the specified socket. The default is \fB~/.pwmd/socket\fR.
  38 .TP
  39 .I "\-d data_directory"
  40 Where
  41 .B pwmd
  42 should store and retrieve data files. The default is \fB~/.pwmd\fR.
  43 .TP
  44 .I "\-M"
  45 Disable calling
  46 .BR mlockall (2).
  47 If you have resource limits beyond your control and
  48 .B pwmd
  49 is taking to much physical memory then this option may help at the cost of
  50 security. The data may be swapped to virtual memory and later recovered.
  51 Reguardless of this option
  52 .BR mlock (2)
  53 will still be used for the file cache.
  54 .TP
  55 .I "\-C cache_size"
  56 Specfies the size of the file cache. Must be in multiples of your systems
  57 \fBPAGE_SIZE\fR. The default is one page which on Linux-x86 is 4096 or 113
  58 files.
  59 .TP
  60 .I "\-l log_file"
  61 Logs informational messages to the specified file.
  62 .TP
  63 .I "\-v"
  64 Version information.
  65 .TP
  66 .I "\-h"
  67 Help text.
  68
  69 .SH SIGNALS
  70 .TP
  71 .B SIGHUP
  72 Clears the entire file cache.
  73
  74 .SH FILES
  75 .TP
  76 .B ~/.pwmd
  77 Default data directory.
  78 .TP
  79 .B ~/.pwmd/socket
  80 Default listening socket.
  81 .TP
  82 .B /dev/shm/pwmd.<uid>
  83 On Linux, and maybe other systems, where the file cache is stored.
  84
  85 .SH AUTHOR
  86 Ben Kibbey <bjk@luxsci.net>
  87 .br
  88 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
  89
  90 .SH "SEE ALSO"
  91 .BR shm_open (2),
  92 .BR mlock (2),
  93 .BR mlockall (2),
  94 .BR libxml (3)