add exit status info to man pages
authorJameson Graef Rollins <jrollins@phys.columbia.edu>
Mon, 30 Jun 2008 12:36:11 +0000 (08:36 -0400)
committerJameson Graef Rollins <jrollins@phys.columbia.edu>
Mon, 30 Jun 2008 12:36:11 +0000 (08:36 -0400)
man/man1/monkeysphere.1

index eb085bf6ae617da055f99de9b4272774ee166a1c..9cdf0fc3542307cfffe4ba098a0e5aa5e5ed3793 100644 (file)
@@ -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
 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
 `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
 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
 .TP
 .B gen-subkey KEYID
 Generate an `a` capable subkey.  For the primary key with the