curl_easy_setopt.3: clarify the SSH KEYFILE options usage

The internal defaults are important info
This commit is contained in:
Daniel Stenberg
2011-05-02 23:31:38 +02:00
parent d4ebf3c6b0
commit 365db94e0a

View 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) option is only for SCP and SFTP transfers. (Added in 7.17.1)
.IP CURLOPT_SSH_PUBLIC_KEYFILE .IP CURLOPT_SSH_PUBLIC_KEYFILE
Pass a char * pointing to a file name for your public key. If not used, 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. libcurl defaults to \fB$HOME/.ssh/id_dsa.pub\fP if the HOME environment
(Added in 7.16.1) 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 .IP CURLOPT_SSH_PRIVATE_KEYFILE
Pass a char * pointing to a file name for your private key. If not used, 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 libcurl defaults to \fB$HOME/.ssh/id_dsa\fP if the HOME environment variable
password-protected, set the password with \fICURLOPT_KEYPASSWD\fP. (Added in is set, and just "id_dsa" in the current directory if HOME is not set. If the
7.16.1) file is password-protected, set the password with
\fICURLOPT_KEYPASSWD\fP. (Added in 7.16.1)
.IP CURLOPT_SSH_KNOWNHOSTS .IP CURLOPT_SSH_KNOWNHOSTS
Pass a pointer to a zero terminated string holding the file name of the 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 known_host file to use. The known_hosts file should use the OpenSSH file