]> granicus.if.org Git - curl/commitdiff
curl.1: Added information about optional login options to --user in manpage
authorSteve Holme <steve_holme@hotmail.com>
Sat, 21 Sep 2013 21:05:12 +0000 (22:05 +0100)
committerSteve Holme <steve_holme@hotmail.com>
Sat, 21 Sep 2013 21:05:12 +0000 (22:05 +0100)
Added missing information, from curl 7.31.0, regarding the use of the
optional login options that may be specified as part of --user.

For example:

--user 'user:password;auth=NTLM' in IMAP, POP3 and SMTP protocols.

docs/curl.1

index 52714eadbfacab194efb4e1acd2f482806b7aa7f..f90bdabf34538ddf98865fb00f20f374044dd241 100644 (file)
@@ -1535,16 +1535,23 @@ If this option is used several times, the last one will be used.
 .IP "--trace-time"
 Prepends a time stamp to each trace or verbose line that curl displays.
 (Added in 7.14.0)
-.IP "-u, --user <user:password>"
-Specify the user name and password to use for server authentication. Overrides
-\fI-n, --netrc\fP and \fI--netrc-optional\fP.
-
-If you just give the user name (without entering a colon) curl will prompt for
-a password.
-
-If you use an SSPI-enabled curl binary and do NTLM authentication, you can
-force curl to pick up the user name and password from your environment by
-simply specifying a single colon with this option: "-u :".
+.IP "-u, --user <user:password;options>"
+Specify the user name, password and optional login options to use for server
+authentication. Overrides \fI-n, --netrc\fP and \fI--netrc-optional\fP.
+
+If you simply specify the user name, with or without the login options, curl
+will prompt for a password.
+
+If you use an SSPI-enabled curl binary and perform NTLM authentication, you
+can force curl to select the user name and password from your environment by
+simply specifying a single colon with this option: "-u :" or by specfying the
+login options on their own, for example "-u ;auth=NTLM".
+
+You can use the optional login options part to specify protocol specific
+options that may be used during authentication. At present only IMAP, POP3 and
+SMTP support login options as part of the user login information. For more
+information about the login options please see RFC 2384, RFC 5092 and IETF
+draft draft-earhart-url-smtp-00.txt (Added in 7.31.0). 
 
 If this option is used several times, the last one will be used.
 .IP "-U, --proxy-user <user:password>"