aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_NETRC_FILE.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_NETRC_FILE.md')
-rw-r--r--docs/libcurl/opts/CURLOPT_NETRC_FILE.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_NETRC_FILE.md b/docs/libcurl/opts/CURLOPT_NETRC_FILE.md
new file mode 100644
index 000000000..62fe7a521
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_NETRC_FILE.md
@@ -0,0 +1,66 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLOPT_NETRC_FILE
+Section: 3
+Source: libcurl
+See-also:
+ - CURLOPT_NETRC (3)
+ - CURLOPT_PASSWORD (3)
+ - CURLOPT_USERNAME (3)
+---
+
+# NAME
+
+CURLOPT_NETRC_FILE - filename to read .netrc info from
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NETRC_FILE, char *file);
+~~~
+
+# DESCRIPTION
+
+Pass a char pointer as parameter, pointing to a null-terminated string
+containing 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 checks
+for 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
+
+~~~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_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.