Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_NETRC.3 @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_NETRC \- request that .netrc is used
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NETRC, long level);
30 .SH DESCRIPTION
31 This parameter controls the preference \fIlevel\fP of libcurl between using
32 user names and passwords from your \fI~/.netrc\fP file, relative to user names
33 and passwords in the URL supplied with \fICURLOPT_URL(3)\fP. On Windows,
34 libcurl will use the file as \fI%HOME%/_netrc\fP, but you can also tell
35 libcurl a different file name to use with \fICURLOPT_NETRC_FILE(3)\fP.
36
37 libcurl uses a user name (and supplied or prompted password) supplied with
38 \fICURLOPT_USERPWD(3)\fP or \fICURLOPT_USERNAME(3)\fP in preference to any of
39 the options controlled by this parameter.
40
41 Only machine name, user name and password are taken into account (init macros
42 and similar things aren't supported).
43
44 libcurl does not verify that the file has the correct properties set (as the
45 standard Unix ftp client does). It should only be readable by user.
46
47 \fIlevel\fP should be set to one of the values described below.
48
49 .IP CURL_NETRC_OPTIONAL
50 The use of the \fI~/.netrc\fP file is optional, and information in the URL is
51 to be preferred. The file will be scanned for the host and user name (to find
52 the password only) or for the host only, to find the first user name and
53 password after that \fImachine\fP, which ever information is not specified.
54
55 Undefined values of the option will have this effect.
56 .IP CURL_NETRC_IGNORED
57 The library will ignore the \fI~/.netrc\fP file.
58
59 This is the default.
60 .IP CURL_NETRC_REQUIRED
61 The use of the \fI~/.netrc\fP file is required, and information in the URL is
62 to be ignored. The file will be scanned for the host and user name (to find
63 the password only) or for the host only, to find the first user name and
64 password after that \fImachine\fP, which ever information is not specified.
65 .SH DEFAULT
66 CURL_NETRC_IGNORED
67 .SH PROTOCOLS
68 Most
69 .SH EXAMPLE
70 .nf
71 CURL *curl = curl_easy_init();
72 if(curl) {
73 CURLcode ret;
74 curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/");
75 curl_easy_setopt(curl, CURLOPT_NETRC, CURL_NETRC_OPTIONAL);
76 ret = curl_easy_perform(curl);
77 }
78 .fi
79 .SH AVAILABILITY
80 Always
81 .SH RETURN VALUE
82 Returns CURLE_OK
83 .SH "SEE ALSO"
84 .BR CURLOPT_USERPWD "(3), " CURLOPT_USERNAME "(3), " CURLOPT_NETRC_FILE "(3), "