libcurl-env-dbg.3 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. .\" generated by cd2nroff 0.1 from libcurl-env-dbg.md
  2. .TH libcurl-env-dbg 3 "2025-01-17" libcurl
  3. .SH NAME
  4. libcurl\-env\-dbg \- environment variables libcurl DEBUGBUILD understands
  5. .SH DESCRIPTION
  6. This is a set of variables only recognized and used if libcurl was built
  7. \&"debug enabled", which should never be true for a library used in production.
  8. These variables are intended for internal use only, subject to change and have
  9. many effects on the behavior of libcurl. Refer to the source code to determine
  10. how exactly they are being used.
  11. .IP CURL_ALTSVC_HTTP
  12. Bypass the AltSvc HTTPS protocol restriction if this variable exists.
  13. .IP CURL_DBG_SOCK_RBLOCK
  14. The percentage of recv() calls that should be answered with a EAGAIN at random.
  15. For TCP/UNIX sockets.
  16. .IP CURL_DBG_SOCK_RMAX
  17. The maximum data that shall be received from the network in one recv() call.
  18. For TCP/UNIX sockets. This is applied to every recv.
  19. Example: \fBCURL_DBG_SOCK_RMAX=400\fP means recv buffer size is limited to a
  20. maximum of 400 bytes.
  21. .IP CURL_DBG_SOCK_WBLOCK
  22. The percentage of send() calls that should be answered with a EAGAIN at random.
  23. For TCP/UNIX sockets.
  24. .IP CURL_DBG_SOCK_WPARTIAL
  25. The percentage of data that shall be written to the network. For TCP/UNIX
  26. sockets. This is applied to every send.
  27. Example: \fBCURL_DBG_SOCK_WPARTIAL=80\fP means a send with 1000 bytes would
  28. only send 800.
  29. .IP CURL_DBG_QUIC_WBLOCK
  30. The percentage of send() calls that should be answered with EAGAIN at random.
  31. QUIC only.
  32. .IP CURL_DEBUG
  33. Trace logging behavior as an alternative to calling \fIcurl_global_trace(3)\fP.
  34. Example: \fBCURL_DEBUG=http/2\fP means trace details about HTTP/2 handling.
  35. .IP CURL_DEBUG_SIZE
  36. Fake the size returned by CURLINFO_HEADER_SIZE and CURLINFO_REQUEST_SIZE.
  37. .IP CURL_GETHOSTNAME
  38. Fake the local machine\(aqs unqualified hostname for NTLM and SMTP.
  39. .IP CURL_HSTS_HTTP
  40. Bypass the HSTS HTTPS protocol restriction if this variable exists.
  41. .IP CURL_FORCETIME
  42. A time of 0 is used for AWS signatures and NTLM if this variable exists.
  43. .IP CURL_ENTROPY
  44. A fixed faked value to use instead of a proper random number so that functions
  45. in libcurl that are otherwise getting random outputs can be tested for what
  46. they generate.
  47. .IP CURL_SMALLREQSEND
  48. An alternative size of HTTP data to be sent at a time only if smaller than the
  49. current.
  50. .IP CURL_SMALLSENDS
  51. An alternative size of socket data to be sent at a time only if smaller than
  52. the current.
  53. .IP CURL_TIME
  54. Fake unix timestamp to use for AltSvc, HSTS and CURLINFO variables that are
  55. time related.
  56. This variable can also be used to fake the data returned by some CURLINFO
  57. variables that are not time\-related (such as CURLINFO_LOCAL_PORT), and in that
  58. case the value is not a timestamp.
  59. .IP CURL_TRACE
  60. LDAP tracing is enabled if this variable exists and its value is 1 or greater.
  61. OpenLDAP tracing is separate. Refer to CURL_OPENLDAP_TRACE.
  62. .IP CURL_NTLM_WB_FILE
  63. Debug\-version of the \fIntlm\-wb\fP executable.
  64. .IP CURL_OPENLDAP_TRACE
  65. OpenLDAP tracing is enabled if this variable exists and its value is 1 or
  66. greater. There is a number of debug levels, refer to \fIopenldap.c\fP comments.
  67. .IP CURL_WS_CHUNK_SIZE
  68. Used to influence the buffer chunk size used for WebSocket encoding and
  69. decoding.
  70. .IP CURL_FORBID_REUSE
  71. Used to set the CURLOPT_FORBID_REUSE flag on each transfer initiated
  72. by the curl command line tool. The value of the environment variable
  73. does not matter.
  74. .IP CURL_GRACEFUL_SHUTDOWN
  75. Make a blocking, graceful shutdown of all remaining connections when
  76. a multi handle is destroyed. This implicitly triggers for easy handles
  77. that are run via easy_perform. The value of the environment variable
  78. gives the shutdown timeout in milliseconds.
  79. .SH SEE ALSO
  80. .BR libcurl-env (3)