| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * 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.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_TELNETOPTIONS 3 "November 04, 2020" "libcurl 7.78.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_TELNETOPTIONS \- custom telnet options |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TELNETOPTIONS, |
| struct curl_slist *cmds); |
| .SH DESCRIPTION |
| Provide a pointer to a curl_slist with variables to pass to the telnet |
| negotiations. The variables should be in the format <option=value>. libcurl |
| supports the options 'TTYPE', 'XDISPLOC' and 'NEW_ENV'. See the TELNET |
| standard for details. |
| .SH DEFAULT |
| NULL |
| .SH PROTOCOLS |
| TELNET |
| .SH EXAMPLE |
| .nf |
| CURL *curl = curl_easy_init(); |
| if(curl) { |
| struct curl_slist *options; |
| options = curl_slist_append(NULL, "TTTYPE=vt100"); |
| options = curl_slist_append(options, "USER=foobar"); |
| curl_easy_setopt(curl, CURLOPT_URL, "telnet://example.com/"); |
| curl_easy_setopt(curl, CURLOPT_TELNETOPTIONS, options); |
| ret = curl_easy_perform(curl); |
| curl_easy_cleanup(curl); |
| curl_slist_free_all(options); |
| } |
| .fi |
| .SH AVAILABILITY |
| Along with TELNET |
| .SH RETURN VALUE |
| Returns CURLE_OK if TELNET is supported, and CURLE_UNKNOWN_OPTION if not. |
| .SH "SEE ALSO" |
| .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_QUOTE "(3), " |