curl/docs/libcurl/opts/CURLOPT_CRLF.md
Daniel Stenberg e3fe020089
docs/libcurl: generate PROTOCOLS from meta-data
Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175
2024-03-23 18:13:03 +01:00

1.0 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLOPT_CRLF 3 libcurl
CURLOPT_CONV_FROM_NETWORK_FUNCTION (3)
CURLOPT_CONV_TO_NETWORK_FUNCTION (3)
All

NAME

CURLOPT_CRLF - CRLF conversion

SYNOPSIS

#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

EXAMPLE

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