CURLOPT_SERVICE_NAME.3 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, 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_SERVICE_NAME 3 "17 Jun 2015" "libcurl 7.43.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SERVICE_NAME \- authentication service name
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SERVICE_NAME, char *name);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a char * as parameter to a string holding the \fIname\fP of the service
  33. for DIGEST-MD5, SPNEGO and Kerberos 5 authentication mechanisms. The default
  34. service names are "ftp", "HTTP", "imap", "ldap", "pop" and "smtp". This option
  35. allows you to change them.
  36. The application does not have to keep the string around after setting this
  37. option.
  38. .SH DEFAULT
  39. See above
  40. .SH PROTOCOLS
  41. HTTP, FTP, IMAP, LDAP, POP3 and SMTP
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. CURLcode ret;
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  48. curl_easy_setopt(curl, CURLOPT_SERVICE_NAME, "custom");
  49. ret = curl_easy_perform(curl);
  50. }
  51. .fi
  52. .SH AVAILABILITY
  53. Added in 7.43.0 for HTTP, 7.49.0 for FTP, IMAP, POP3 and SMTP,
  54. 7.82.0 for OpenLDAP.
  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_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "