CURLOPT_FTP_ALTERNATIVE_TO_USER.3 2.3 KB

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