diff options
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3 | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3 b/docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3 index 553d4085..9134a7cb 100644 --- a/docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3 +++ b/docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * 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 @@ -20,7 +20,8 @@ .\" * .\" ************************************************************************** .\" -.TH CURLOPT_CUSTOMREQUEST 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.TH CURLOPT_CUSTOMREQUEST 3 "June 21, 2017" "libcurl 7.55.0" "curl_easy_setopt options" + .SH NAME CURLOPT_CUSTOMREQUEST \- custom string for request .SH SYNOPSIS @@ -80,12 +81,27 @@ Normally a multiline response is returned which can be used, in conjunction with \fICURLOPT_MAIL_RCPT(3)\fP, to specify an EXPN request. If the \fICURLOPT_NOBODY(3)\fP option is specified then the request can be used to issue NOOP and RSET commands. + +The application does not have to keep the string around after setting this +option. .SH DEFAULT NULL .SH PROTOCOLS HTTP, FTP, IMAP, POP3 and SMTP .SH EXAMPLE -TODO +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin"); + + /* DELETE the given path */ + curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE"); + + ret = curl_easy_perform(curl); + + curl_easy_cleanup(curl); +} +.fi .SH AVAILABILITY IMAP is supported since 7.30.0, POP3 since 7.26.0 and SMTP since 7.34.0. .SH RETURN VALUE @@ -93,3 +109,4 @@ Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space. .SH "SEE ALSO" .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_NOBODY "(3), " +.BR CURLOPT_REQUEST_TARGET "(3), " |