CURLOPT_FTP_ALTERNATIVE_TO_USER.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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_FTP_ALTERNATIVE_TO_USER 3 "19 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_FTP_ALTERNATIVE_TO_USER \- command to use instead of USER with FTP
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_ALTERNATIVE_TO_USER,
  32. char *cmd);
  33. .SH DESCRIPTION
  34. Pass a char * as parameter, pointing to a string which will be used to
  35. authenticate if the usual FTP "USER user" and "PASS password" negotiation
  36. fails. This is currently only known to be required when connecting to
  37. Tumbleweed's Secure Transport FTPS server using client certificates for
  38. authentication.
  39. The application does not have to keep the string around after setting this
  40. option.
  41. .SH DEFAULT
  42. NULL
  43. .SH PROTOCOLS
  44. FTP
  45. .SH EXAMPLE
  46. .nf
  47. CURL *curl = curl_easy_init();
  48. if(curl) {
  49. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
  50. curl_easy_setopt(curl, CURLOPT_FTP_ALTERNATIVE_TO_USER, "two users");
  51. ret = curl_easy_perform(curl);
  52. curl_easy_cleanup(curl);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Added in 7.15.5
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  59. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  60. .SH "SEE ALSO"
  61. .BR CURLOPT_FTP_SKIP_PASV_IP "(3), " CURLOPT_SERVER_RESPONSE_TIMEOUT "(3), "