CURLOPT_EGDSOCKET.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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.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_EGDSOCKET 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_EGDSOCKET \- set EGD socket path
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EGDSOCKET, char *path);
  29. .SH DESCRIPTION
  30. Pass a char * to the null-terminated path name to the Entropy Gathering Daemon
  31. socket. It will be used to seed the random engine for SSL.
  32. The application does not have to keep the string around after setting this
  33. option.
  34. .SH DEFAULT
  35. NULL
  36. .SH PROTOCOLS
  37. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  43. curl_easy_setopt(curl, CURLOPT_EGDSOCKET, "/var/egd.socket");
  44. ret = curl_easy_perform(curl);
  45. curl_easy_cleanup(curl);
  46. }
  47. .fi
  48. .SH AVAILABILITY
  49. If built TLS enabled. Only the OpenSSL and GnuTLS backends will use this.
  50. .SH RETURN VALUE
  51. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  52. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  53. .SH "SEE ALSO"
  54. .BR CURLOPT_RANDOM_FILE "(3), "