From 1acda65187127ca0c72916349d87de94254e3018 Mon Sep 17 00:00:00 2001
From: Ben Kibbey <bjk@luxsci.net>
Date: Sun, 27 Jan 2008 08:34:32 -0500
Subject: [PATCH] Updated manual page.

---
 libpwmd.3.in | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/libpwmd.3.in b/libpwmd.3.in
index 87ed5f88..65cdc467 100644
--- a/libpwmd.3.in
+++ b/libpwmd.3.in
@@ -15,7 +15,7 @@
 \\$2 \(laURL: \\$1 \(ra\\$3
 ..
 .if \n[.g] .mso www.tmac
-.TH LIBPWMD 3 "22 Dec 2007" "Password Manager Daemon Library" "Password Manager Daemon Library"
+.TH LIBPWMD 3 "27 Jan 2008" "Password Manager Daemon Library" "Password Manager Daemon Library"
 .SH NAME
 
 libpwmd \- pwmd client interface library
@@ -29,12 +29,17 @@ libpwmd \- pwmd client interface library
 .BI "gpg_error_t pwmd_open(pwm_t *" pwm ", const char *" filename ");"
 .BI "int pwmd_open_nb(pwm_t *" pwm ", gpg_error_t *" error ", const char *" filename ", int " timeout ");"
 .BI "gpg_error_t pwmd_open_nb_finalize(pwm_t *" pwm ", pwmd_nb_status_t *" status ");"
+.BI "gpg_error_t pwmd_open_async(pwm_t *" pwm ", const char *" filename ");"
+.BI "int pwmd_open_nb(pwm_t *" pwm ", gpg_error_t *" error ", const char *" filename ", int " timeout ");"
 .BI "gpg_error_t pwmd_command(pwm_t *" pwm ", char **" result ", const char *" cmd ", " ... ");"
 .BI "void pwmd_free_result(void *" result ");"
 .BI "gpg_error_t pwmd_inquire(pwm_t *" pwm ", const char *" cmd ", pwmd_inquire_fn " func ", void *" data ");"
 .BI "gpg_error_t pwmd_save(pwm_t *" pwm ");"
 .BI "int pwmd_save_nb(pwm_t *" pwm ", gpg_error_t *" error ");"
 .BI "gpg_error_t pwmd_save_nb_finalize(pwm_t *" pwm ", pwmd_nb_status_t *" status ");"
+.BI "gpg_error_t pwmd_save_async(pwm_t *" pwm ");"
+.BI "pwmd_async_t pwmd_process(pwm_t *" pwm ", gpg_error_t *" error ");"
+.BI "gpg_error_t pwmd_finalize(pwm_t *" pwm ");"
 .BI "gpg_error_t pwmd_terminate_pinentry(pwm_t *" pwm ");"
 .BI "void pwmd_close(pwm_t *" pwm ");"
 .BI "const char *pwmd_strerror(gpg_error_t " error ");"
@@ -188,6 +193,14 @@ there was a protocol or
 error, an error code is returned. Otherwise \fB0\fP is returned.
 .P
 .TP
+.BI "gpg_error_t pwmd_open_async(pwm_t *" pwm ", const char *" filename ");"
+This is another method of opening a file in a non-blocking way. Instead of
+\fBlibpwmd\fP executing \fBpinentry\fP after a fork(),
+.BR pwmd (1)
+will use its \fBpinentry\fP method. When successful \fB0\fP is returned and
+\fBpwmd_process()\fP should be called until the command finishes.
+.P
+.TP
 .BI "gpg_error_t pwmd_command(pwm_t *" pwm ", char **" result ", const char *" cmd ", " ... ");"
 Sends a protocol command to the server. The function returns \fB0\fP
 when successful and stores the result of the command format string \fIcmd\fP
@@ -255,6 +268,28 @@ there was a protocol or
 error, an error code is returned. Otherwise \fB0\fP is returned.
 .P
 .TP
+.BI "gpg_error_t pwmd_save_async(pwm_t *" pwm ");"
+This is another method of saving a file in a non-blocking way. Instead of
+\fBlibpwmd\fP executing \fBpinentry\fP after a fork(),
+.BR pwmd (1)
+will use its \fBpinentry\fP method. When successful \fB0\fP is returned and
+\fBpwmd_process()\fP should be called until the command finishes.
+.P
+.TP
+.BI "pwmd_async_t pwmd_process(pwm_t *" pwm ", gpg_error_t *" error ");"
+For use with the asynchronous functions \fBpwmd_open_async()\fP and
+\fBpwmd_save_async\fP(). This function returns \fBASYNC_PROCESS\fP when the
+command is still running and should be called again until \fBASYNC_DONE\fP is
+returned. When \fBASYNC_DONE\fP is returned, \fIerror\fP should be tested and
+\fBpwmd_finalize()\fP should be called.
+.P
+.TP
+.BI "gpg_error_t pwmd_finalize(pwm_t *" pwm ");"
+After \fBpwmd_process()\fP returns \fBASYNC_DONE\fP, this function should be
+called even if an error occured to reset the \fIpwm\fP handle for the next
+asynchronous command.
+.P
+.TP
 .BI "gpg_error_t pwmd_terminate_pinentry(pwm_t *" pwm ");"
 Terminates a
 .BR pinentry (1)
-- 
2.11.4.GIT