aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/MANUAL11
-rw-r--r--docs/curl.19
-rw-r--r--docs/libcurl/curl_easy_setopt.34
3 files changed, 20 insertions, 4 deletions
diff --git a/docs/MANUAL b/docs/MANUAL
index dd063911d..d087c3b22 100644
--- a/docs/MANUAL
+++ b/docs/MANUAL
@@ -7,7 +7,7 @@ LATEST VERSION
SIMPLE USAGE
- Get the main page from netscape's web-server:
+ Get the main page from Netscape's web-server:
curl http://www.netscape.com/
@@ -39,6 +39,15 @@ SIMPLE USAGE
curl --ftp-ssl ftp://files.are.secure.com/secrets.txt
+ Get a file from an SSH server using SFTP:
+
+ curl -u username sftp://shell.example.com/~/personal.txt
+
+ Get a file from an SSH server using SCP using a private key to authenticate:
+
+ curl -u username: --key ~/.ssh/id_dsa --pubkey ~/.ssh/id_dsa.pub \
+ scp://shell.example.com/~/personal.txt
+
DOWNLOAD TO A FILE
diff --git a/docs/curl.1 b/docs/curl.1
index a08432c0b..301461339 100644
--- a/docs/curl.1
+++ b/docs/curl.1
@@ -582,7 +582,7 @@ See this online resource for further details:
If this option is used twice, the second time will again disable it.
.IP "--key <key>"
-(SSL) Private key file name. Allows you to provide your private key in this
+(SSL/SSH) Private key file name. Allows you to provide your private key in this
separate file.
If this option is used several times, the last one will be used.
@@ -825,7 +825,7 @@ nothing else.
You may use this option as many times as you have number of URLs.
.IP "--pass <phrase>"
-(SSL) Pass phrase for the private key
+(SSL/SSH) Pass phrase for the private key
If this option is used several times, the last one will be used.
.IP "--proxy-anyauth"
@@ -860,6 +860,11 @@ CONNECT request and requires that the proxy allows direct connect to the
remote port number curl wants to tunnel through to.
If this option is used twice, the second will again disable proxy tunnel.
+.IP "--pubkey <key>"
+(SSH) Public key file name. Allows you to provide your public key in this
+separate file.
+
+If this option is used several times, the last one will be used.
.IP "-P/--ftp-port <address>"
(FTP) Reverses the initiator/listener roles when connecting with ftp. This
switch makes Curl use the PORT command instead of PASV. In practice, PORT
diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3
index ac26b7237..970600859 100644
--- a/docs/libcurl/curl_easy_setopt.3
+++ b/docs/libcurl/curl_easy_setopt.3
@@ -1217,7 +1217,8 @@ engine. You have to set the crypto engine with \fICURLOPT_SSLENGINE\fP.
\&"DER" format key file currently does not work because of a bug in OpenSSL.
.IP CURLOPT_SSLKEYPASSWD
Pass a pointer to a zero terminated string as parameter. It will be used as
-the password required to use the \fICURLOPT_SSLKEY\fP private key.
+the password required to use the \fICURLOPT_SSLKEY\fP or
+\fICURLOPT_SSH_PRIVATE_KEYFILE\fP private key.
.IP CURLOPT_SSLENGINE
Pass a pointer to a zero terminated string as parameter. It will be used as
the identifier for the crypto engine you want to use for your private
@@ -1372,6 +1373,7 @@ libcurl defaults to using \fB~/.ssh/id_dsa.pub\fP.
.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_SSLKEYPASSWD\fP.
.SH OTHER OPTIONS
.IP CURLOPT_PRIVATE
Pass a char * as parameter, pointing to data that should be associated with