Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_TELNETOPTIONS.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_TELNETOPTIONS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_TELNETOPTIONS \- custom telnet options
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TELNETOPTIONS,
30                           struct curl_slist *cmds);
31 .SH DESCRIPTION
32 Provide a pointer to a curl_slist with variables to pass to the telnet
33 negotiations. The variables should be in the format <option=value>. libcurl
34 supports the options 'TTYPE', 'XDISPLOC' and 'NEW_ENV'. See the TELNET
35 standard for details.
36 .SH DEFAULT
37 NULL
38 .SH PROTOCOLS
39 TELNET
40 .SH EXAMPLE
41 TODO
42 .SH AVAILABILITY
43 Along with TELNET
44 .SH RETURN VALUE
45 Returns CURLE_OK if TELNET is supported, and CURLE_UNKNOWN_OPTION if not.
46 .SH "SEE ALSO"
47 .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_QUOTE "(3), "