diff options
author | ng0 <ng0@infotropique.org> | 2017-08-22 18:16:20 +0000 |
---|---|---|
committer | ng0 <ng0@infotropique.org> | 2017-08-22 18:16:20 +0000 |
commit | 25a03ee9c6133cfe1ce809a8ab1528ae7328fe35 (patch) | |
tree | 5ee3f3450604faedd1d4a9e53a3982c6ffcfe5fc /docs/libcurl/opts/GNURLOPT_SSH_AUTH_TYPES.3 | |
parent | 535a1e532345d3760d496b5b21052f23e8965f4c (diff) | |
download | gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.gz gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.bz2 gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.zip |
gnurl: Rename man3 files to avoid collisions.
This is necessary so that gnURL and cURL can co-exist on
the same system. However renaming most of the files is not logical.
Signed-off-by: ng0 <ng0@infotropique.org>
Diffstat (limited to 'docs/libcurl/opts/GNURLOPT_SSH_AUTH_TYPES.3')
-rw-r--r-- | docs/libcurl/opts/GNURLOPT_SSH_AUTH_TYPES.3 | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/libcurl/opts/GNURLOPT_SSH_AUTH_TYPES.3 b/docs/libcurl/opts/GNURLOPT_SSH_AUTH_TYPES.3 new file mode 100644 index 000000000..2911e2899 --- /dev/null +++ b/docs/libcurl/opts/GNURLOPT_SSH_AUTH_TYPES.3 @@ -0,0 +1,59 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_SSH_AUTH_TYPES 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_SSH_AUTH_TYPES \- set desired auth types for SFTP and SCP +.SH SYNOPSIS +#include <gnurl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_AUTH_TYPES, long bitmask); +.SH DESCRIPTION +Pass a long set to a bitmask consisting of one or more of +CURLSSH_AUTH_PUBLICKEY, CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST, +CURLSSH_AUTH_KEYBOARD and CURLSSH_AUTH_AGENT. + +Set \fICURLSSH_AUTH_ANY\fP to let libcurl pick a suitable one. Currently +CURLSSH_AUTH_HOST has no effect. If CURLSSH_AUTH_AGENT is used, libcurl +attempts to connect to ssh-agent or pageant and let the agent attempt the +authentication. +.SH DEFAULT +None +.SH PROTOCOLS +SFTP and SCP +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file"); + curl_easy_setopt(curl, CURLOPT_SSH_AUTH_TYPES, + CURLSSH_AUTH_PUBLICKEY | CURLSSH_AUTH_KEYBOARD); + ret = curl_easy_perform(curl); + curl_easy_cleanup(curl); +} +.fi +.SH AVAILABILITY +CURLSSH_AUTH_HOST was added in 7.16.1, CURLSSH_AUTH_AGENT was added in 7.28.0 +.SH RETURN VALUE +Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 "(3), " CURLOPT_SSH_PUBLIC_KEYFILE "(3), " |