moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-12-23 00:28:48 -05:00
Code Issues Releases Wiki Activity

DOCS: Changed domain names in various examples to example.com

Browse Source 
Updated various references of real domain names to example.com as per
RFC-2606.
This commit is contained in:
Steve Holme 2012-05-26 14:05:45 +01:00
parent 2839c059b1
commit 25c1b29226
1 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/libcurl/curl_easy_setopt.3
View File

@ -625,18 +625,18 @@ authentication.
For example the following types of authentication support this: For example the following types of authentication support this:
http://user:password@www.domain.com http://user:password@www.example.com
ftp://user:password@ftp.domain.com ftp://user:password@ftp.example.com
pop3://user:password@mail.domain.com pop3://user:password@mail.example.com
The port is optional and when not specified libcurl will use the default port The port is optional and when not specified libcurl will use the default port
based on the determined or specified protocol: 80 for http, 21 for ftp and 25 based on the determined or specified protocol: 80 for HTTP, 21 for FTP and 25
for smtp, etc. The following examples show how to specify the port: for SMTP, etc. The following examples show how to specify the port:
http://www.weirdserver.com:8080/ - This will connect to a web server using http://www.example.com:8080/ - This will connect to a web server using port
port 8080. 8080 rather than 80.
smtp://mail.domain.com:587/ - This will connect to a smtp server on the smtp://mail.example.com:587/ - This will connect to a SMTP server on the
alternative mail port. alternative mail port.
The path part of the URL is protocol specific and whilst some examples are The path part of the URL is protocol specific and whilst some examples are
@ -651,13 +651,12 @@ retrieved for either the directory specified or the root directory. The
exact resource returned for each URL is entirely dependent on the server's exact resource returned for each URL is entirely dependent on the server's
configuration. configuration.
http://www.netscape.com - This gets the main page (index.html in this http://www.example.com - This gets the main page from the web server.
example) from Netscape's web server.
http://www.netscape.com/index.html - This returns the main page from Netscape http://www.example.com/index.html - This returns the main page by explicitly
by specifying the page to get. requesting it.
http://www.netscape.com/contactus/ - This returns the default document from http://www.example.com/contactus/ - This returns the default document from
the contactus directory. the contactus directory.
.B FTP .B FTP
@ -667,15 +666,16 @@ directory. If the file part is omitted then libcurl downloads the directory
listing for the directory specified. If the directory is omitted then listing for the directory specified. If the directory is omitted then
the directory listing for the root / home directory will be returned. the directory listing for the root / home directory will be returned.
ftp://cool.haxx.se - This retrieves the directory listing for our FTP server. ftp://ftp.example.com - This retrieves the directory listing for the root
directory.
ftp://cool.haxx.se/readme.txt - This downloads the file readme.txt from the ftp://ftp.example.com/readme.txt - This downloads the file readme.txt from the
root directory. root directory.
ftp://cool.haxx.se/libcurl/readme.txt - This downloads readme.txt from the ftp://ftp.example.com/libcurl/readme.txt - This downloads readme.txt from the
libcurl directory. libcurl directory.
ftp://user:password@my.example.com/readme.txt - This retrieves the readme.txt ftp://user:password@ftp.example.com/readme.txt - This retrieves the readme.txt
file from the user's home directory. When a username and password is file from the user's home directory. When a username and password is
specified, everything that is specified in the path part is relative to the specified, everything that is specified in the path part is relative to the
user's home directory. To retrieve files from the root directory or a user's home directory. To retrieve files from the root directory or a
@ -683,7 +683,7 @@ directory underneath the root directory then the absolute path must be
specified by prepending an additional forward slash to the beginning of the specified by prepending an additional forward slash to the beginning of the
path. path.
ftp://user:password@my.example.com//readme.txt - This retrieves the readme.txt ftp://user:password@ftp.example.com//readme.txt - This retrieves the readme.txt
from the root directory when logging in as a specified user. from the root directory when logging in as a specified user.
.B SMTP .B SMTP
@ -696,11 +696,11 @@ and specifying this path allows you to set an alternative name, such as
your machine's fully qualified domain name, which you might have obtained your machine's fully qualified domain name, which you might have obtained
from an external function such as gethostname or getaddrinfo. from an external function such as gethostname or getaddrinfo.
smtp://mail.domain.com - This connects to the mail server at domain.com and smtp://mail.example.com - This connects to the mail server at example.com and
sends your local computer's host name in the HELO / EHLO command. sends your local computer's host name in the HELO / EHLO command.
smtp://mail.domain.com/client.domain.com - This will send client.domain.com in smtp://mail.example.com/client.example.com - This will send client.example.com in
the HELO / EHLO command to the mail server at domain.com. the HELO / EHLO command to the mail server at example.com.
.B POP3 .B POP3
@ -708,8 +708,8 @@ The path part of a POP3 request specifies the mailbox (message) to retrieve.
If the mailbox is not specified then a list of waiting messages is returned If the mailbox is not specified then a list of waiting messages is returned
instead. instead.
pop3://user:password@mail.domain.com - This lists the available messages pop3://user:password@mail.example.com - This lists the available messages
pop3://user:password@mail.domain.com/1 - This retrieves the first message pop3://user:password@mail.example.com/1 - This retrieves the first message
.B SCP .B SCP
@ -843,8 +843,9 @@ Pass a pointer to a zero terminated string. This should be a comma separated
list of hosts which do not use a proxy, if one is specified. The only list of hosts which do not use a proxy, if one is specified. The only
wildcard is a single * character, which matches all hosts, and effectively wildcard is a single * character, which matches all hosts, and effectively
disables the proxy. Each name in this list is matched as either a domain which disables the proxy. Each name in this list is matched as either a domain which
contains the hostname, or the hostname itself. For example, local.com would contains the hostname, or the hostname itself. For example, example.com
match local.com, local.com:80, and www.local.com, but not www.notlocal.com. would match example.com, example.com:80, and www.example.com, but not
www.notanexample.com.
(Added in 7.19.4) (Added in 7.19.4)
.IP CURLOPT_HTTPPROXYTUNNEL .IP CURLOPT_HTTPPROXYTUNNEL
Set the parameter to 1 to make the library tunnel all operations through a Set the parameter to 1 to make the library tunnel all operations through a