| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * This software is licensed as described in the file COPYING, which
- .\" * you should have received as part of this distribution. The terms
- .\" * are also available at http://curl.haxx.se/docs/copyright.html.
- .\" *
- .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- .\" * copies of the Software, and permit persons to whom the Software is
- .\" * furnished to do so, under the terms of the COPYING file.
- .\" *
- .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- .\" * KIND, either express or implied.
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLOPT_NETRC 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_NETRC \- request that .netrc is used
- .SH SYNOPSIS
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NETRC, long level);
- .SH DESCRIPTION
- This parameter controls the preference \fIlevel\fP of libcurl between using
- user names and passwords from your \fI~/.netrc\fP file, relative to user names
- and passwords in the URL supplied with \fICURLOPT_URL(3)\fP.
- libcurl uses a user name (and supplied or prompted password) supplied with
- \fICURLOPT_USERPWD(3)\fP or \fICURLOPT_USERNAME(3)\fP in preference to any of
- the options controlled by this parameter.
- Only machine name, user name and password are taken into account (init macros
- and similar things aren't supported).
- libcurl does not verify that the file has the correct properties set (as the
- standard Unix ftp client does). It should only be readable by user.
- \fIlevel\fP should be set to one of the values described below.
- .IP CURL_NETRC_OPTIONAL
- The use of your \fI~/.netrc\fP file is optional, and information in the URL is
- to be preferred. The file will be scanned for the host and user name (to
- find the password only) or for the host only, to find the first user name and
- password after that \fImachine\fP, which ever information is not specified in
- the URL.
- Undefined values of the option will have this effect.
- .IP CURL_NETRC_IGNORED
- The library will ignore the file and use only the information in the URL.
- This is the default.
- .IP CURL_NETRC_REQUIRED
- This value tells the library that use of the file is required, to ignore the
- information in the URL, and to search the file for the host only.
- .SH DEFAULT
- CURL_NETRC_IGNORED
- .SH PROTOCOLS
- Most
- .SH EXAMPLE
- TODO
- .SH AVAILABILITY
- Always
- .SH RETURN VALUE
- Returns CURLE_OK
- .SH "SEE ALSO"
- .BR CURLOPT_USERPWD "(3), " CURLOPT_USERNAME "(3), "
|
