2
0
mirror of https://codeberg.org/kiss-community/repo synced 2025-01-05 01:10:07 -07:00
repo/core/curl/files/CURLOPT_TELNETOPTIONS.3
2024-11-09 22:03:25 -06:00

52 lines
1.5 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_TELNETOPTIONS.md
.TH CURLOPT_TELNETOPTIONS 3 "2024-11-09" libcurl
.SH NAME
CURLOPT_TELNETOPTIONS \- set of telnet options
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TELNETOPTIONS,
struct curl_slist *cmds);
.fi
.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 \fBTTYPE\fP, \fBXDISPLOC\fP and \fBNEW_ENV\fP. See the TELNET
standard for details.
Using this option multiple times makes the last set list override the previous
ones. Set it to NULL to disable its use again.
libcurl does not copy the list, it needs to be kept around until after the
transfer has completed.
.SH DEFAULT
NULL
.SH PROTOCOLS
This functionality affects telnet only
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
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);
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
curl_slist_free_all(options);
}
}
.fi
.SH AVAILABILITY
Added in curl 7.7
.SH RETURN VALUE
Returns CURLE_OK if TELNET is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO
.BR CURLOPT_HTTPHEADER (3),
.BR CURLOPT_QUOTE (3)