FL-552: documentation for --confhost

funtoo · Jun 28, 2014 · 6c5b237 · 6c5b237
1 parent e4754b3
commit 6c5b237
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/keychain.pod b/keychain.pod
@@ -4,7 +4,7 @@ keychain - re-use ssh-agent and/or gpg-agent between logins
 
 =head1 SYNOPSIS
 
-S<keychain [ -hkQqV ] [ --clear --help --ignore-missing --noask>
+S<keychain [ -hkQqV ] [ --clear --confhost --help --ignore-missing --noask>
 S<--nocolor --nogui --nolock --quick --quiet --version ]>
 S<[ --agents I<list> ] [ --attempts I<num> ] [ --dir I<dirname> ]>
 S<[ --host I<name> ] [ --lockwait I<seconds> ]>
@@ -58,6 +58,13 @@ that you are an intruder until proven otherwise.  However, while this
 option increases security, it still allows your cron jobs to use your
 ssh keys when you're logged out.
 
+=item B<--confhost>
+
+By default, keychain will look for key pairs in the ~/.ssh/ directory.
+The --confhost option will inform keychain to look in ~/.ssh/config
+for IdentityFile settings defined for particular hosts, and use these
+paths to locate keys.
+
 =item B<--confirm>
 
 Keys are subject to interactive confirmation by the SSH_ASKPASS