fixing return code error in openpgp2ssh, preparing for new release.

[monkeysphere.git] / man / man1 / monkeysphere-ssh-proxycommand.1

diff --git a/man/man1/monkeysphere-ssh-proxycommand.1 b/man/man1/monkeysphere-ssh-proxycommand.1
index 5fabb91af5dce22ac09e4601549eb63bcac561d1..a31a9d1598b7f671dce9dca6916be9faed6275b9 100644 (file)
--- a/man/man1/monkeysphere-ssh-proxycommand.1
+++ b/man/man1/monkeysphere-ssh-proxycommand.1
@@ -18,17 +18,38 @@ or by adding the following line to your ~/.ssh/config script:
 
 .B ProxyCommand monkeysphere-ssh-proxycommand %h %p
 
-The script is very simple, and can easily be incorporated into other
-ProxyCommand scripts.  It first tests to see if the host is in the
-known_hosts file.  If it's not, the CHECK_KEYSERVER variable is set to
-true and "update-known_hosts" is run for the host to check for a host
-key for that host.  If the host is found in the known_hosts file,
-CHECK_KEYSERVER is set to false and "update-known_hosts" is run to
-update from the local keychain.
+The script can easily be incorporated into other ProxyCommand scripts
+by calling it with the "--no-connect" option, i.e.:
 
-Run the following command for more info:
+.B monkeysphere-ssh-proxycommand --no-connect "$HOST" "$PORT"
 
-.B less $(which monkeysphere-ssh-proxycommand)
+This will run everything but will not exec netcat to make the tcp
+connection to the host.
+
+.SH KEYSERVER CHECKING
+
+The proxy command has a fairly nuanced policy for when keyservers are
+queried when processing host.  If the host userID is not found in
+either the user's keyring or in the known_hosts file, then the
+keyserver is queried for the host userID.  If the host userID is found
+in the user's keyring, then the keyserver is not checked.  This
+assumes that the keyring is kept up-to-date, in a cron job or the
+like, so that revocations are properly handled.  If the host userID is
+not found in the user's keyring, but the host is listed in the
+known_hosts file, then the keyserver is not checked.  This last policy
+might change in the future, possibly by adding a deferred check, so
+that hosts that go from non-monkeysphere-enabled to
+monkeysphere-enabled will be properly checked.
+
+.SH ENVIRONMENT VARIABLES
+
+All environment variables defined in monkeysphere(1) can also be used
+for the proxycommand, with one note:
+
+.TP
+MONKEYSPHERE_CHECK_KEYSERVER
+Setting this variable (to `true' or `false') will override the policy
+defined in KEYSERVER CHECKING above.
 
 .SH AUTHOR
 
@@ -36,6 +57,6 @@ Written by Jameson Rollins <jrollins@fifthhorseman.net>
 
 .SH SEE ALSO
 
-.BR monkeypshere (1),
+.BR monkeysphere (1),
 .BR ssh (1),
 .BR gpg (1)