aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_CRLF.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_CRLF.md')
-rw-r--r--docs/libcurl/opts/CURLOPT_CRLF.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_CRLF.md b/docs/libcurl/opts/CURLOPT_CRLF.md
new file mode 100644
index 000000000..1766c3312
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_CRLF.md
@@ -0,0 +1,62 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLOPT_CRLF
+Section: 3
+Source: libcurl
+See-also:
+ - CURLOPT_CONV_FROM_NETWORK_FUNCTION (3)
+ - CURLOPT_CONV_TO_NETWORK_FUNCTION (3)
+---
+
+# NAME
+
+CURLOPT_CRLF - CRLF conversion
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLF, long conv);
+~~~
+
+# DESCRIPTION
+
+Pass a long. If the value is set to 1 (one), libcurl converts Unix newlines to
+CRLF newlines on transfers. Disable this option again by setting the value to
+0 (zero).
+
+This is a legacy option of questionable use.
+
+# DEFAULT
+
+0
+
+# PROTOCOLS
+
+All
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+ CURL *curl = curl_easy_init();
+ if(curl) {
+ CURLcode ret;
+ curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/");
+ curl_easy_setopt(curl, CURLOPT_CRLF, 1L);
+ ret = curl_easy_perform(curl);
+ curl_easy_cleanup(curl);
+ }
+}
+~~~
+
+# AVAILABILITY
+
+SMTP since 7.40.0, other protocols since they were introduced
+
+# RETURN VALUE
+
+Returns CURLE_OK