]> granicus.if.org Git - curl/commitdiff
curl_easy_setopt.3: clarify the SSH KEYFILE options usage
authorDaniel Stenberg <daniel@haxx.se>
Mon, 2 May 2011 21:31:38 +0000 (23:31 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 2 May 2011 21:33:03 +0000 (23:33 +0200)
The internal defaults are important info

docs/libcurl/curl_easy_setopt.3

index 4522181b19000865f01fab0446515edff45d0f54..55b0db5baf1f0df839326758b7687bff1a0c98ca 100644 (file)
@@ -2103,13 +2103,15 @@ libcurl will reject the connection to the host unless the md5sums match. This
 option is only for SCP and SFTP transfers. (Added in 7.17.1)
 .IP CURLOPT_SSH_PUBLIC_KEYFILE
 Pass a char * pointing to a file name for your public key. If not used,
-libcurl defaults to using \fB~/.ssh/id_dsa.pub\fP.
-(Added in 7.16.1)
+libcurl defaults to \fB$HOME/.ssh/id_dsa.pub\fP if the HOME environment
+variable is set, and just "id_dsa.pub" in the current directory if HOME is not
+set.  (Added in 7.16.1)
 .IP CURLOPT_SSH_PRIVATE_KEYFILE
 Pass a char * pointing to a file name for your private key. If not used,
-libcurl defaults to using \fB~/.ssh/id_dsa\fP.  If the file is
-password-protected, set the password with \fICURLOPT_KEYPASSWD\fP. (Added in
-7.16.1)
+libcurl defaults to \fB$HOME/.ssh/id_dsa\fP if the HOME environment variable
+is set, and just "id_dsa" in the current directory if HOME is not set.  If the
+file is password-protected, set the password with
+\fICURLOPT_KEYPASSWD\fP. (Added in 7.16.1)
 .IP CURLOPT_SSH_KNOWNHOSTS
 Pass a pointer to a zero terminated string holding the file name of the
 known_host file to use.  The known_hosts file should use the OpenSSH file