CURLOPT_EGDSOCKET.3 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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_EGDSOCKET 3 "17 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_EGDSOCKET \- EGD socket path
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EGDSOCKET, char *path);
  32. .fi
  33. .SH DESCRIPTION
  34. Deprecated option. It serves no purpose anymore.
  35. Pass a char * to the null-terminated path name to the Entropy Gathering Daemon
  36. socket. It will be used to seed the random engine for TLS.
  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. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  48. curl_easy_setopt(curl, CURLOPT_EGDSOCKET, "/var/egd.socket");
  49. ret = curl_easy_perform(curl);
  50. curl_easy_cleanup(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. If built with TLS enabled. Only the OpenSSL backend will use this, and only
  55. with OpenSSL versions before 1.1.0.
  56. This option was deprecated in 7.84.0.
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if TLS 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_RANDOM_FILE "(3), "