Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_USERNAME.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_USERNAME 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_USERNAME \- user name to use in authentication
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERNAME,
31 char *username);
32 .SH DESCRIPTION
33 Pass a char * as parameter, which should be pointing to the zero terminated
34 user name to use for the transfer.
35
36 \fICURLOPT_USERNAME(3)\fP sets the user name to be used in protocol
37 authentication. You should not use this option together with the (older)
38 \fICURLOPT_USERPWD(3)\fP option.
39
40 When using Kerberos V5 authentication with a Windows based server, you should
41 include the domain name in order for the server to successfully obtain a
42 Kerberos Ticket. If you don't then the initial part of the authentication
43 handshake may fail.
44
45 When using NTLM, the user name can be specified simply as the user name
46 without the domain name should the server be part of a single domain and
47 forest.
48
49 To include the domain name use either Down-Level Logon Name or UPN (User
50 Principal Name) formats. For example, EXAMPLE\\user and user@example.com
51 respectively.
52
53 Some HTTP servers (on Windows) support inclusion of the domain for Basic
54 authentication as well.
55
56 To specify the password and login options, along with the user name, use the
57 \fICURLOPT_PASSWORD(3)\fP and \fICURLOPT_LOGIN_OPTIONS(3)\fP options.
58
59 The application does not have to keep the string around after setting this
60 option.
61 .SH DEFAULT
62 blank
63 .SH PROTOCOLS
64 Most
65 .SH EXAMPLE
66 .nf
67 CURL *curl = curl_easy_init();
68 if(curl) {
69 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
70
71 curl_easy_setopt(curl, CURLOPT_USERNAME, "clark");
72
73 ret = curl_easy_perform(curl);
74
75 curl_easy_cleanup(curl);
76 }
77 .fi
78 .SH AVAILABILITY
79 Added in 7.19.1
80 .SH RETURN VALUE
81 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
82 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
83 .SH "SEE ALSO"
84 .BR CURLOPT_USERPWD "(3), " CURLOPT_PASSWORD "(3), "
85 .BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"