Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TELNETOPTIONS.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_TELNETOPTIONS \- custom telnet options
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TELNETOPTIONS,
                     31:                           struct curl_slist *cmds);
                     32: .SH DESCRIPTION
                     33: Provide a pointer to a curl_slist with variables to pass to the telnet
                     34: negotiations. The variables should be in the format <option=value>. libcurl
                     35: supports the options 'TTYPE', 'XDISPLOC' and 'NEW_ENV'. See the TELNET
                     36: standard for details.
                     37: .SH DEFAULT
                     38: NULL
                     39: .SH PROTOCOLS
                     40: TELNET
                     41: .SH EXAMPLE
                     42: .nf
                     43: CURL *curl = curl_easy_init();
                     44: if(curl) {
                     45:   struct curl_slist *options;
                     46:   options = curl_slist_append(NULL, "TTTYPE=vt100");
                     47:   options = curl_slist_append(options, "USER=foobar");
                     48:   curl_easy_setopt(curl, CURLOPT_URL, "telnet://example.com/");
                     49:   curl_easy_setopt(curl, CURLOPT_TELNETOPTIONS, options);
                     50:   ret = curl_easy_perform(curl);
                     51:   curl_easy_cleanup(curl);
                     52:   curl_slist_free_all(options);
                     53: }
                     54: .fi
                     55: .SH AVAILABILITY
                     56: Along with TELNET
                     57: .SH RETURN VALUE
                     58: Returns CURLE_OK if TELNET is supported, and CURLE_UNKNOWN_OPTION if not.
                     59: .SH "SEE ALSO"
                     60: .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_QUOTE "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>