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/CURLOPT_TLSAUTH_TYPE.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/CURLOPT_TLSAUTH_TYPE.3')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.3 | 65 |
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.3 b/docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.3 deleted file mode 100644 index df5fe682a..000000000 --- a/docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.3 +++ /dev/null @@ -1,65 +0,0 @@ -.\" ************************************************************************** -.\" * _ _ ____ _ -.\" * 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_TLSAUTH_TYPE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" -.SH NAME -CURLOPT_TLSAUTH_TYPE \- set TLS authentication methods -.SH SYNOPSIS -#include <gnurl/curl.h> - -CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_TYPE, char *type); -.SH DESCRIPTION -Pass a pointer to a zero terminated string as parameter. The string -should be the method of the TLS authentication. Supported method is "SRP". - -.IP SRP -TLS-SRP authentication. Secure Remote Password authentication for TLS is -defined in RFC5054 and provides mutual authentication if both sides have a -shared secret. To use TLS-SRP, you must also set the -\fICURLOPT_TLSAUTH_USERNAME(3)\fP and \fICURLOPT_TLSAUTH_PASSWORD(3)\fP -options. - -The application does not have to keep the string around after setting this -option. -.SH DEFAULT -blank -.SH PROTOCOLS -All TLS-based protocols -.SH EXAMPLE -.nf -CURL *curl = curl_easy_init(); -if(curl) { - curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); - curl_easy_setopt(curl, CURLOPT_TLSAUTH_TYPE, "SRP"); - curl_easy_setopt(curl, CURLOPT_TLSAUTH_USERNAME, "user"); - curl_easy_setopt(curl, CURLOPT_TLSAUTH_PASSWORD, "secret"); - ret = curl_easy_perform(curl); - curl_easy_cleanup(curl); -} -.fi -.SH AVAILABILITY -You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this -to work. Added in 7.21.4 -.SH RETURN VALUE -Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. -.SH "SEE ALSO" -.BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), " |