mirror of
https://github.com/curl/curl.git
synced 2024-12-15 06:40:09 +08:00
230bb3e278
Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
62 lines
2.2 KiB
Groff
62 lines
2.2 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2021, 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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.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 '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), "
|