| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2014, 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 http://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_CONNECT_ONLY 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_CONNECT_ONLY \- stop when connected to target server
- .SH SYNOPSIS
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECT_ONLY, long only);
- .SH DESCRIPTION
- Pass a long. If the parameter equals 1, it tells the library to perform all
- the required proxy authentication and connection setup, but no data transfer,
- and then return. This option is implemented for HTTP, SMTP and POP3.
- The option can be used to simply test a connection to a server, but is more
- useful when used with the \fICURLINFO_LASTSOCKET\fP option to
- \fIcurl_easy_getinfo(3)\fP as the library can set up the connection and then
- the application can obtain the most recently used socket for special data
- transfers.
- .SH DEFAULT
- 0
- .SH PROTOCOLS
- HTTP, SMTP and POP3
- .SH EXAMPLE
- TODO
- .SH AVAILABILITY
- Added in 7.15.2
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH "SEE ALSO"
- .BR CURLOPT_VERBOSE "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "
|
