Return to CURLOPT_USERNAME.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_USERNAME.3, revision 1.1.1.1

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