docs/libcurl/opts/CURLOPT_NETRC_FILE.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_NETRC_FILE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_NETRC_FILE \- file name to read .netrc info from
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NETRC_FILE, char *file);
  31 .SH DESCRIPTION
  32 Pass a char * as parameter, pointing to a zero terminated string containing
  33 the full path name to the \fIfile\fP you want libcurl to use as .netrc
  34 file. If this option is omitted, and \fICURLOPT_NETRC(3)\fP is set, libcurl
  35 will attempt to find a .netrc file in the current user's home
  36 directory.
  37
  38 The application does not have to keep the string around after setting this
  39 option.
  40 .SH DEFAULT
  41 NULL
  42 .SH PROTOCOLS
  43 All
  44 .SH EXAMPLE
  45 .nf
  46 CURL *curl = curl_easy_init();
  47 if(curl) {
  48   CURLcode ret;
  49   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/");
  50   curl_easy_setopt(curl, CURLOPT_NETRC, CURL_NETRC_OPTIONAL);
  51   curl_easy_setopt(curl, CURLOPT_NETRC_FILE, "/tmp/magic-netrc");
  52   ret = curl_easy_perform(curl);
  53 }
  54 .fi
  55 .SH AVAILABILITY
  56 Added in 7.10.9
  57 .SH RETURN VALUE
  58 Returns CURLE_OK if the option 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_NETRC "(3), " CURLOPT_USERNAME "(3), "