docs/libcurl/opts/CURLOPT_URL.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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_URL 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_URL \- provide the URL to use in the request
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_URL, char *URL);
  30 .SH DESCRIPTION
  31 Pass in a pointer to the \fIURL\fP to work with. The parameter should be a
  32 char * to a zero terminated string which must be URL-encoded in the following
  33 format:
  34
  35 scheme://host:port/path
  36
  37 For a greater explanation of the format please see RFC3986.
  38
  39 libcurl doesn't validate the syntax or use this variable until the transfer is
  40 issued. Even if you set a crazy value here, \fIcurl_easy_setopt(3)\fP will
  41 still return \fICURLE_OK\fP.
  42
  43 If the given URL lacks the scheme (such as "http://" or "ftp://" etc) then
  44 libcurl will attempt to resolve the protocol based on one of the following
  45 given host names: HTTP, FTP, DICT, LDAP, IMAP, POP3 or SMTP
  46
  47 Should the protocol, either that specified by the scheme or deduced by libcurl
  48 from the host name, not be supported by libcurl then
  49 \fICURLE_UNSUPPORTED_PROTOCOL\fP will be returned from either the
  50 \fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform(3)\fP functions when you
  51 call them. Use \fIcurl_version_info(3)\fP for detailed information of which
  52 protocols are supported by the build of libcurl you are using.
  53
  54 \fICURLOPT_PROTOCOLS(3)\fP can be used to limit what protocols libcurl will
  55 use for this transfer, independent of what libcurl has been compiled to
  56 support. That may be useful if you accept the URL from an external source and
  57 want to limit the accessibility.
  58
  59 \fICURLOPT_URL(3)\fP is the only option that \fBmust\fP be set before a
  60 transfer is started.
  61
  62 The host part of the URL contains the address of the server that you want to
  63 connect to. This can be the fully qualified domain name of the server, the
  64 local network name of the machine on your network or the IP address of the
  65 server or machine represented by either an IPv4 or IPv6 address. For example:
  66
  67 http://www.example.com/
  68
  69 http://hostname/
  70
  71 http://192.168.0.1/
  72
  73 http://[2001:1890:1112:1::20]/
  74
  75 It is also possible to specify the user name, password and any supported login
  76 options as part of the host, for the following protocols, when connecting to
  77 servers that require authentication:
  78
  79 http://user:password@www.example.com
  80
  81 ftp://user:password@ftp.example.com
  82
  83 smb://domain%2fuser:password@server.example.com
  84
  85 imap://user:password;options@mail.example.com
  86
  87 pop3://user:password;options@mail.example.com
  88
  89 smtp://user:password;options@mail.example.com
  90
  91 At present only IMAP, POP3 and SMTP support login options as part of the host.
  92 For more information about the login options in URL syntax please see RFC2384,
  93 RFC5092 and IETF draft draft-earhart-url-smtp-00.txt (Added in 7.31.0).
  94
  95 The port is optional and when not specified libcurl will use the default port
  96 based on the determined or specified protocol: 80 for HTTP, 21 for FTP and 25
  97 for SMTP, etc. The following examples show how to specify the port:
  98
  99 http://www.example.com:8080/ - This will connect to a web server using port
 100 8080 rather than 80.
 101
 102 smtp://mail.example.com:587/ - This will connect to a SMTP server on the
 103 alternative mail port.
 104
 105 The path part of the URL is protocol specific and whilst some examples are
 106 given below this list is not conclusive:
 107
 108 .IP HTTP
 109 The path part of a HTTP request specifies the file to retrieve and from what
 110 directory. If the directory is not specified then the web server's root
 111 directory is used. If the file is omitted then the default document will be
 112 retrieved for either the directory specified or the root directory. The exact
 113 resource returned for each URL is entirely dependent on the server's
 114 configuration.
 115
 116 http://www.example.com - This gets the main page from the web server.
 117
 118 http://www.example.com/index.html - This returns the main page by explicitly
 119 requesting it.
 120
 121 http://www.example.com/contactus/ - This returns the default document from
 122 the contactus directory.
 123
 124 .IP FTP
 125 The path part of an FTP request specifies the file to retrieve and from what
 126 directory. If the file part is omitted then libcurl downloads the directory
 127 listing for the directory specified. If the directory is omitted then
 128 the directory listing for the root / home directory will be returned.
 129
 130 ftp://ftp.example.com - This retrieves the directory listing for the root
 131 directory.
 132
 133 ftp://ftp.example.com/readme.txt - This downloads the file readme.txt from the
 134 root directory.
 135
 136 ftp://ftp.example.com/libcurl/readme.txt - This downloads readme.txt from the
 137 libcurl directory.
 138
 139 ftp://user:password@ftp.example.com/readme.txt - This retrieves the readme.txt
 140 file from the user's home directory. When a username and password is
 141 specified, everything that is specified in the path part is relative to the
 142 user's home directory. To retrieve files from the root directory or a
 143 directory underneath the root directory then the absolute path must be
 144 specified by prepending an additional forward slash to the beginning of the
 145 path.
 146
 147 ftp://user:password@ftp.example.com//readme.txt - This retrieves the readme.txt
 148 from the root directory when logging in as a specified user.
 149
 150 .IP SMTP
 151 The path part of a SMTP request specifies the host name to present during
 152 communication with the mail server. If the path is omitted then libcurl will
 153 attempt to resolve the local computer's host name. However, this may not
 154 return the fully qualified domain name that is required by some mail servers
 155 and specifying this path allows you to set an alternative name, such as
 156 your machine's fully qualified domain name, which you might have obtained
 157 from an external function such as gethostname or getaddrinfo.
 158
 159 smtp://mail.example.com - This connects to the mail server at example.com and
 160 sends your local computer's host name in the HELO / EHLO command.
 161
 162 smtp://mail.example.com/client.example.com - This will send client.example.com in
 163 the HELO / EHLO command to the mail server at example.com.
 164
 165 .IP POP3
 166 The path part of a POP3 request specifies the message ID to retrieve. If the
 167 ID is not specified then a list of waiting messages is returned instead.
 168
 169 pop3://user:password@mail.example.com - This lists the available messages for
 170 the user
 171
 172 pop3://user:password@mail.example.com/1 - This retrieves the first message for
 173 the user
 174
 175 .IP IMAP
 176 The path part of an IMAP request not only specifies the mailbox to list (Added
 177 in 7.30.0) or select, but can also be used to check the UIDVALIDITY of the
 178 mailbox, to specify the UID, SECTION (Added in 7.30.0) and PARTIAL octets
 179 (Added in 7.37.0) of the message to fetch and to specify what messages to
 180 search for (Added in 7.37.0).
 181
 182 imap://user:password@mail.example.com - Performs a top level folder list
 183
 184 imap://user:password@mail.example.com/INBOX - Performs a folder list on the
 185 user's inbox
 186
 187 imap://user:password@mail.example.com/INBOX/;UID=1 - Selects the user's inbox
 188 and fetches message 1
 189
 190 imap://user:password@mail.example.com/INBOX;UIDVALIDITY=50/;UID=2 - Selects
 191 the user's inbox, checks the UIDVALIDITY of the mailbox is 50 and fetches
 192 message 2 if it is
 193
 194 imap://user:password@mail.example.com/INBOX/;UID=3/;SECTION=TEXT - Selects the
 195 user's inbox and fetches the text portion of message 3
 196
 197 imap://user:password@mail.example.com/INBOX/;UID=4/;PARTIAL=0.1024 - Selects
 198 the user's inbox and fetches the first 1024 octets of message 4
 199
 200 imap://user:password@mail.example.com/INBOX?NEW - Selects the user's inbox and
 201 checks for NEW messages
 202
 203 imap://user:password@mail.example.com/INBOX?SUBJECT%20shadows - Selects the
 204 user's inbox and searches for messages containing "shadows" in the subject
 205 line
 206
 207 For more information about the individual components of an IMAP URL please
 208 see RFC5092.
 209
 210 .IP SCP
 211 The path part of a SCP request specifies the file to retrieve and from what
 212 directory. The file part may not be omitted. The file is taken as an absolute
 213 path from the root directory on the server. To specify a path relative to the
 214 user's home directory on the server, prepend ~/ to the path portion.  If the
 215 user name is not embedded in the URL, it can be set with the
 216 \fICURLOPT_USERPWD(3)\fP or \fICURLOPT_USERNAME(3)\fP option.
 217
 218 scp://user@example.com/etc/issue - This specifies the file /etc/issue
 219
 220 scp://example.com/~/my-file - This specifies the file my-file in the
 221 user's home directory on the server
 222
 223 .IP SFTP
 224 The path part of a SFTP request specifies the file to retrieve and from what
 225 directory. If the file part is omitted then libcurl downloads the directory
 226 listing for the directory specified.  If the path ends in a / then a directory
 227 listing is returned instead of a file.  If the path is omitted entirely then
 228 the directory listing for the root / home directory will be returned.  If the
 229 user name is not embedded in the URL, it can be set with the
 230 \fICURLOPT_USERPWD(3)\fP or \fICURLOPT_USERNAME(3)\fP option.
 231
 232 sftp://user:password@example.com/etc/issue - This specifies the file
 233 /etc/issue
 234
 235 sftp://user@example.com/~/my-file - This specifies the file my-file in the
 236 user's home directory
 237
 238 sftp://ssh.example.com/~/Documents/ - This requests a directory listing
 239 of the Documents directory under the user's home directory
 240
 241 .IP SMB
 242 The path part of a SMB request specifies the file to retrieve and from what
 243 share and directory or the share to upload to and as such, may not be omitted.
 244 If the user name is not embedded in the URL, it can be set with the
 245 \fICURLOPT_USERPWD(3)\fP or \fICURLOPT_USERNAME(3)\fP option. If the user name
 246 is embedded in the URL then it must contain the domain name and as such, the
 247 backslash must be URL encoded as %2f.
 248
 249 smb://server.example.com/files/issue - This specifies the file "issue" located
 250 in the root of the "files" share
 251
 252 smb://server.example.com/files/ -T issue - This specifies the file "issue" will
 253 be uploaded to the root of the "files" share.
 254
 255 .IP LDAP
 256 The path part of a LDAP request can be used to specify the: Distinguished
 257 Name, Attributes, Scope, Filter and Extension for a LDAP search. Each field
 258 is separated by a question mark and when that field is not required an empty
 259 string with the question mark separator should be included.
 260
 261 ldap://ldap.example.com/o=My%20Organisation - This will perform a LDAP search
 262 with the DN as My Organisation.
 263
 264 ldap://ldap.example.com/o=My%20Organisation?postalAddress - This will perform
 265 the same search but will only return postalAddress attributes.
 266
 267 ldap://ldap.example.com/?rootDomainNamingContext - This specifies an empty DN
 268 and requests information about the rootDomainNamingContext attribute for an
 269 Active Directory server.
 270
 271 For more information about the individual components of a LDAP URL please
 272 see RFC4516.
 273 .IP RTMP
 274 There's no official URL spec for RTMP so libcurl uses the URL syntax supported
 275 by the underlying librtmp library. It has a syntax where it wants a
 276 traditional URL, followed by a space and a series of space-separated
 277 name=value pairs.
 278
 279 While space is not typically a "legal" letter, libcurl accepts them. When a
 280 user wants to pass in a '#' (hash) character it will be treated as a fragment
 281 and get cut off by libcurl if provided literally. You will instead have to
 282 escape it by providing it as backslash and its ASCII value in hexadecimal:
 283 "\\23".
 284 .SH DEFAULT
 285 There is no default URL. If this option isn't set, no transfer can be
 286 performed.
 287 .SH PROTOCOLS
 288 All
 289 .SH EXAMPLE
 290 .nf
 291 CURL *curl = curl_easy_init();
 292 if(curl) {
 293   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
 294
 295   curl_easy_perform(curl);
 296 }
 297 .fi
 298 .SH AVAILABILITY
 299 POP3 and SMTP were added in 7.31.0
 300 .SH RETURN VALUE
 301 Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient
 302 heap space.
 303
 304 Note that \fIcurl_easy_setopt(3)\fP won't actually parse the given string so
 305 given a bad URL, it will not be detected until \fIcurl_easy_perform(3)\fP or
 306 similar is called.
 307 .SH "SEE ALSO"
 308 .BR CURLOPT_VERBOSE "(3), " CURLOPT_PROTOCOLS "(3), "
 309 .BR CURLOPT_FORBID_REUSE "(3), " CURLOPT_FRESH_CONNECT "(3), "
 310 .BR curl_easy_perform "(3)"