add exit status info to man pages

[monkeysphere.git] / man / man1 / monkeysphere.1

diff --git a/man/man1/monkeysphere.1 b/man/man1/monkeysphere.1
index 30e35bba3a5fc7732b52bae70ee3b5935ba77ff6..9cdf0fc3542307cfffe4ba098a0e5aa5e5ed3793 100644 (file)
--- a/man/man1/monkeysphere.1
+++ b/man/man1/monkeysphere.1
@@ -10,10 +10,10 @@ monkeysphere \- MonkeySphere client user interface
 
 .SH DESCRIPTION
 
 
 .SH DESCRIPTION
 

-MonkeySphere is a system to leverage the OpenPGP Web of Trust for ssh
-authentication and encryption.  OpenPGP keys are tracked via GnuPG,
-and added to the ssh authorized_keys and known_hosts files to be used
-for authentication of ssh connections.
+\fBMonkeySphere\fP is a system to leverage the OpenPGP Web of Trust
+for ssh authentication.  OpenPGP keys are tracked via GnuPG, and added
+to the ssh authorized_keys and known_hosts files to be used for
+authentication of ssh connections.

 
 \fBmonkeysphere\fP is the MonkeySphere client utility.
 
 
 \fBmonkeysphere\fP is the MonkeySphere client utility.
 


@@ -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


@@ -57,7 +63,7 @@ Output a brief usage summary.  `h' or `?' may be used in place of
 .SH HOST URIs
 
 Host OpenPGP keys have associated user IDs that use the ssh URI
 .SH HOST URIs
 
 Host OpenPGP keys have associated user IDs that use the ssh URI

-specification for the host, ie. "ssh://host.full.domain".
+specification for the host, ie. "ssh://host.full.domain[:port]".

 
 .SH KEY ACCEPTABILITY
 
 
 .SH KEY ACCEPTABILITY
 


@@ -67,7 +73,8 @@ GPG keys are considered acceptable if the following criteria are met:
 The key must have the "authentication" ("a") usage flag set.
 .TP
 .B validity
 The key must have the "authentication" ("a") usage flag set.
 .TP
 .B validity

-The key must be "fully" valid, and must not be expired or revoked.
+The key must be "fully" valid (ie. signed by a trusted certifier), and
+must not be expired or revoked.

 
 .SH FILES
 
 
 .SH FILES