docs/libcurl/opts/CURLOPT_CRLF.3

   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.haxx.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_CRLF 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_CRLF \- enable/disable CRLF conversion
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLF, long conv);
  31 .SH DESCRIPTION
  32 Pass a long. If the value is set to 1 (one), libcurl converts Unix newlines to
  33 CRLF newlines on transfers. Disable this option again by setting the value to
  34 0 (zero).
  35
  36 This is a legacy option of questionable use.
  37 .SH DEFAULT
  38 0
  39 .SH PROTOCOLS
  40 All
  41 .SH EXAMPLE
  42 .nf
  43 CURL *curl = curl_easy_init();
  44 if(curl) {
  45   CURLcode ret;
  46   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/");
  47   curl_easy_setopt(curl, CURLOPT_CRLF, 1L);
  48   ret = curl_easy_perform(curl);
  49   curl_easy_cleanup(curl);
  50 }
  51 .fi
  52 .SH AVAILABILITY
  53 SMTP since 7.40.0, other protocols since they were introduced
  54 .SH RETURN VALUE
  55 Returns CURLE_OK
  56 .SH "SEE ALSO"
  57 .BR CURLOPT_CONV_FROM_NETWORK_FUNCTION "(3), " CURLOPT_CONV_TO_NETWORK_FUNCTION "(3), "