From: Steve Holme <steve_holme@hotmail.com>
Date: Fri, 15 Aug 2014 21:04:08 +0000 (+0100)
Subject: CURLOPT_USERNAME.3: Added Kerberos V5 and NTLM domain information
X-Git-Tag: curl-7_38_0~84
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=97f6049bc28d248a5a127fc6811f8f1dcd4ab2da;p=curl

CURLOPT_USERNAME.3: Added Kerberos V5 and NTLM domain information

This repeats what has already been documented in both the curl manpage
and CURLOPT_USERPWD documentation but is provided here for completeness
as someone may not especially read the latter when using libcurl.
---

diff --git a/docs/libcurl/opts/CURLOPT_USERNAME.3 b/docs/libcurl/opts/CURLOPT_USERNAME.3
index 07892111d..4cec5e93c 100644
--- a/docs/libcurl/opts/CURLOPT_USERNAME.3
+++ b/docs/libcurl/opts/CURLOPT_USERNAME.3
@@ -37,6 +37,22 @@ user name to use for the transfer.
 authentication. You should not use this option together with the (older)
 \fICURLOPT_USERPWD(3)\fP option.
 
+When using Kerberos V5 authentication with a Windows based server, you should
+include the domain name in order for the server to successfully obtain a
+Kerberos Ticket. If you don't then the initial part of the authentication
+handshake may fail.
+
+When using NTLM, the user name can be specified simply as the user name
+without the domain name should the server be part of a single domain and
+forest.
+
+To include the domain name use either Down-Level Logon Name or UPN (User
+Principal Name) formats. For example, EXAMPLE\user and user@example.com
+respectively.
+
+Some HTTP servers (on Windows) support inclusion of the domain for Basic
+authentication as well.
+
 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