Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_NETRC_FILE (3)

Name

CURLOPT_NETRC_FILE - file name to read .netrc info from

Synopsis

#include <curl/curl.h>

CURLcode   curl_easy_setopt(CURL   *handle,   CURLOPT_NETRC_FILE,  char
*file);

Description

CURLOPT_NETRC_FILE(3)      curl_easy_setopt options      CURLOPT_NETRC_FILE(3)



NAME
       CURLOPT_NETRC_FILE - file name to read .netrc info from

SYNOPSIS
       #include <curl/curl.h>

       CURLcode   curl_easy_setopt(CURL   *handle,   CURLOPT_NETRC_FILE,  char
       *file);

DESCRIPTION
       Pass a char * as parameter, pointing to a zero terminated  string  con-
       taining  the  full  path  name  to  the file you want libcurl to use as
       .netrc file. If this option is omitted, and  CURLOPT_NETRC(3)  is  set,
       libcurl  will  attempt to find a .netrc file in the current user's home
       directory.

       The application does not have to keep the string around  after  setting
       this option.

DEFAULT
       NULL

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         CURLcode ret;
         curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/");
         curl_easy_setopt(curl, CURLOPT_NETRC, CURL_NETRC_OPTIONAL);
         curl_easy_setopt(curl, CURLOPT_NETRC_FILE, "/tmp/magic-netrc");
         ret = curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.10.9

RETURN VALUE
       Returns  CURLE_OK  if  the option is supported, CURLE_UNKNOWN_OPTION if
       not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_NETRC(3), CURLOPT_USERNAME(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014            CURLOPT_NETRC_FILE(3)