CURLOPT_TELNETOPTIONS.3 2.3 KB

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