| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * 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_USERNAME 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_USERNAME \- username to authenticate with
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERNAME,
- char *username);
- .SH DESCRIPTION
- Pass a char * as parameter, which should be pointing to the zero terminated
- user name to use for the transfer.
- \fBCURLOPT_USERNAME(3)\fP sets the user name to be used in protocol
- authentication. You should not use this option together with the (older)
- \fICURLOPT_USERPWD(3)\fP option.
- To specify the password and login options, along with the user name, use the
- \fICURLOPT_PASSWORD(3)\fP and \fICURLOPT_LOGIN_OPTIONS(3)\fP options.
- .SH DEFAULT
- blank
- .SH PROTOCOLS
- Most
- .SH EXAMPLE
- TODO
- .SH AVAILABILITY
- Added in 7.19.1
- .SH 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.
- .SH "SEE ALSO"
- .BR CURLOPT_USERPWD "(3), " CURLOPT_PASSWORD "(3), "
- .BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"
|
