From 14472b4712fba73c1e3a3b70fb62f33c5afe7739 Mon Sep 17 00:00:00 2001
From: Jameson Graef Rollins <jrollins@phys.columbia.edu>
Date: Mon, 30 Jun 2008 08:36:11 -0400
Subject: add exit status info to man pages

---
 man/man1/monkeysphere.1 | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

(limited to 'man')

diff --git a/man/man1/monkeysphere.1 b/man/man1/monkeysphere.1
index eb085bf..9cdf0fc 100644
--- a/man/man1/monkeysphere.1
+++ b/man/man1/monkeysphere.1
@@ -30,7 +30,10 @@ from the user's known_hosts file.  If the found key is acceptable (see
 KEY ACCEPTABILITY), then the key will be updated and re-added to the
 known_hosts file.  If no gpg key is found for the host, then nothing
 is done.  If no hosts are specified, all hosts listed in the
-known_hosts file will be processed.  `k' may be used in place of
+known_hosts file will be processed.  This command will exit with a
+status of 0 if all host were found to be acceptable, 2 if all the
+hosts were found to be unacceptable (ie. with keys removed from the
+known_hosts file), and 1 otherwise.  `k' may be used in place of
 `update-known_hosts'.
 .TP
 .B update-authorized_keys
@@ -41,8 +44,11 @@ key is found, it will be converted to an ssh key, and any matching ssh
 keys will be removed from the user's authorized_keys file.  If the
 found key is acceptable (see KEY ACCEPTABILITY), then the key will be
 updated and re-added to the authorized_keys file.  If no gpg key is
-found for the user ID, then nothing is done.  `a' may be used in place
-of `update-authorized_keys'.
+found for the user ID, then nothing is done.  This command will exit
+with a status of 0 if all user IDs were found to be acceptable, 2 if
+all the user IDs were found to be unacceptable (ie. with keys removed
+from the authorized_keys file), and 1 otherwise.  `a' may be used in
+place of `update-authorized_keys'.
 .TP
 .B gen-subkey KEYID
 Generate an `a` capable subkey.  For the primary key with the
-- 
cgit v1.2.3