aboutsummaryrefslogtreecommitdiffstats
path: root/lib/inets/doc
diff options
context:
space:
mode:
authorIngela Anderton Andin <[email protected]>2015-09-02 14:32:33 +0200
committerIngela Anderton Andin <[email protected]>2015-09-08 11:30:39 +0200
commit4c9428db3de49f36bc9802c6026147d9b2e401bc (patch)
tree6c0a8eb85ce0b8c80b10a0fd99c81b6a266218be /lib/inets/doc
parent8e216b94beeed02e67f08d3bf9307c7c48e3b977 (diff)
downloadotp-4c9428db3de49f36bc9802c6026147d9b2e401bc.tar.gz
otp-4c9428db3de49f36bc9802c6026147d9b2e401bc.tar.bz2
otp-4c9428db3de49f36bc9802c6026147d9b2e401bc.zip
inets: httpd - Add links and small corrections
Diffstat (limited to 'lib/inets/doc')
-rw-r--r--lib/inets/doc/src/http_server.xml29
-rw-r--r--lib/inets/doc/src/httpd.xml31
2 files changed, 30 insertions, 30 deletions
diff --git a/lib/inets/doc/src/http_server.xml b/lib/inets/doc/src/http_server.xml
index efa5f7a8f5..ee9496d9ba 100644
--- a/lib/inets/doc/src/http_server.xml
+++ b/lib/inets/doc/src/http_server.xml
@@ -184,7 +184,7 @@
</section>
<section>
- <title>Htaccess - User Configurable Authentication.</title>
+ <title>Htaccess - User Configurable Authentication</title>
<marker id="htaccess"></marker>
<p>Web server users without server administrative privileges
that need to manage authentication of web pages that are local
@@ -356,7 +356,8 @@ UserName:Password</pre>
</taglist>
<section>
- <title>CGI Version 1.1, RFC 3875</title>
+ <title>CGI Version 1.1,
+ <url href="http://www.ietf.org/rfc/rfc3875.txt">RFC 3875</url></title>
<p>The module <c>mod_cgi</c> enables execution of CGI scripts
on the server. A file matching the definition of a
ScriptAlias config directive is treated as a CGI script. A CGI
@@ -453,15 +454,15 @@ http://your.server.org/eval?httpd_example:print(atom_to_list(apply(erlang,halt,[
<tag><em>remotehost</em></tag>
<item>Remote hostname.</item>
<tag><em>rfc931</em></tag>
- <item>The client remote username (RFC 931).</item>
+ <item>The client remote username (<url href="http://www.ietf.org/rfc/rfc931.txt">RFC 931</url>).</item>
<tag><em>authuser</em></tag>
<item>The username used for authentication.</item>
<tag><em>[date]</em></tag>
- <item>Date and time of the request (RFC 1123).</item>
+ <item>Date and time of the request (<url href="http://www.ietf.org/rfc/rfc1123.txt">RFC 1123</url>).</item>
<tag><em>"request"</em></tag>
- <item>The request line exactly as it came from the client (RFC 1945).</item>
+ <item>The request line exactly as it came from the client (<url href="http://www.ietf.org/rfc/rfc1945.txt">RFC 1945</url>).</item>
<tag><em>status</em></tag>
- <item>The HTTP status code returned to the client (RFC 1945).</item>
+ <item>The HTTP status code returned to the client (<url href="http://www.ietf.org/rfc/rfc1945.txt">RFC 1945</url>).</item>
<tag><em>bytes</em></tag>
<item>The content-length of the document transferred. </item>
</taglist>
@@ -546,7 +547,7 @@ http://your.server.org/eval?httpd_example:print(atom_to_list(apply(erlang,halt,[
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso>.</item>
</list>
<p>Exports the following Erlang Web Server API interaction data, if possible:
</p>
@@ -579,7 +580,7 @@ http://your.server.org/eval?httpd_example:print(atom_to_list(apply(erlang,halt,[
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
</list>
<p>Exports the following Erlang Web Server API interaction data:
</p>
@@ -667,7 +668,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
</list>
<p>Exports the following Erlang Web Server API interaction data:
</p>
@@ -715,7 +716,7 @@ start() ->
<p>Uses the following Erlang web server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
</list>
</section>
@@ -727,7 +728,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
</list>
</section>
@@ -738,7 +739,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
</list>
<p>Exports the following Erlang Web Server API interaction data:
</p>
@@ -769,7 +770,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
</list>
</section>
@@ -795,7 +796,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <c>mod_alias</c></item>
+ <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
</list>
<p>Exports the following Erlang Web Server API interaction data:
</p>
diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml
index b6d3c5d39b..4e3a875a7f 100644
--- a/lib/inets/doc/src/httpd.xml
+++ b/lib/inets/doc/src/httpd.xml
@@ -31,7 +31,7 @@
</header>
<module>httpd</module>
<modulesummary>An implementation of an HTTP
- 1.1 compliant web server, as defined in RFC 2616.
+ 1.1 compliant web server, as defined in <url href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</url>
</modulesummary>
<description>
<p>This module provides the HTTP server start options, some administrative
@@ -115,7 +115,7 @@
</item>
</taglist>
<note>
- <p>The properties <c>proplist_file</c> and <c>file</c> are mutually exclusive.</p>
+ <p>The properties <c>proplist_file</c> and <c>file</c> are mutually exclusive. Also newer properties may not be supported as Apache-like options, this is a legacy feature.</p>
</note>
<marker id="props_mand"></marker>
@@ -124,7 +124,7 @@
<marker id="prop_port"></marker>
<tag>{port, integer()} </tag>
<item>
- <p>The port that the HTTP server is to listen on.
+ <p>The port that the HTTP server listen to.
If zero is specified as port, an arbitrary available port
is picked and function <c>httpd:info/2</c> can be used to
determine which port was picked.</p>
@@ -378,15 +378,15 @@ text/plain asc txt</pre>
<tag><c>remotehost</c></tag>
<item>Remote.</item>
<tag><c>rfc931</c></tag>
- <item>The remote username of the client (RFC 931).</item>
+ <item>The remote username of the client (<url href="http://www.ietf.org/rfc/rfc931.txt">RFC 931</url>).</item>
<tag><c>authuser</c></tag>
<item>The username used for authentication.</item>
<tag><c>[date]</c></tag>
- <item>Date and time of the request (RFC 1123).</item>
+ <item>Date and time of the request (<url href="http://www.ietf.org/rfc/rfc1123.txt">RFC 1123</url>).</item>
<tag><c>"request"</c></tag>
- <item>The request line as it came from the client (RFC 1945).</item>
+ <item>The request line as it came from the client (<url href="http://www.ietf.org/rfc/rfc1945.txt">RFC 1945</url>).</item>
<tag><c>status</c></tag>
- <item>The HTTP status code returned to the client (RFC 1945).</item>
+ <item>The HTTP status code returned to the client (<url href="http://www.ietf.org/rfc/rfc1945.txt">RFC 1945</url>).</item>
<tag><c>bytes</c></tag>
<item>The content-length of the document transferred.</item>
</taglist>
@@ -564,7 +564,7 @@ text/plain asc txt</pre>
<p><c>Method = string()</c> and <c>CgiScript = string()</c>.
<c>script</c> adds an action activating a CGI script
whenever a file is requested using a certain HTTP method. The
- method is either GET or POST, as defined in RFC 1945. It
+ method is either GET or POST, as defined in <url href="http://www.ietf.org/rfc/rfc1945.txt">RFC 1945</url>. It
propagates the URL and file path of the requested document using
the standard CGI PATH_INFO and PATH_TRANSLATED environment
variables.</p>
@@ -1065,7 +1065,7 @@ text/plain asc txt</pre>
<c>"http://ServerName:Part/cgi-bin/find.pl?person=jocke"</c></p></item>
<tag><c>request_uri</c></tag>
<item><p>The <c>Request-URI</c> as defined
- in RFC 1945, for example, <c>"/cgi-bin/find.pl?person=jocke"</c>.</p>
+ in <url href="http://www.ietf.org/rfc/rfc1945.txt">RFC 1945</url>, for example, <c>"/cgi-bin/find.pl?person=jocke"</c>.</p>
</item>
<tag><c>http_version</c></tag>
<item><p>The <c>HTTP</c> version of the
@@ -1073,7 +1073,7 @@ text/plain asc txt</pre>
</item>
<tag><c>request_line</c></tag>
<item><p>The <c>Request-Line</c> as
- defined in RFC 1945, for example,
+ defined in<url href="http://www.ietf.org/rfc/rfc1945.txt">RFC 1945</url>, for example,
<c>"GET /cgi-bin/find.pl?person=jocke HTTP/1.0"</c>.</p>
</item>
<tag><c>parsed_header</c></tag>
@@ -1089,7 +1089,7 @@ text/plain asc txt</pre>
</item>
<tag><c>entity_body</c></tag>
<item><p>The <c>entity-Body</c> as defined
- in RFC 2616, for example, data sent from a CGI script using the
+ in <url href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</url>, for example, data sent from a CGI script using the
POST method.</p>
</item>
<tag><c>connection</c></tag>
@@ -1142,11 +1142,10 @@ text/plain asc txt</pre>
<url href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</url>
for the appropriate values.</p>
<p><c>Head</c> is a key value list of HTTP header fields. The
- server constructs an HTTP header from this data. See RFC
- 2616 for the appropriate value for each header field. If the
- client is an HTTP/1.0 client, the server filters the
- list so that only HTTP/1.0 header fields are sent back
- to the client.</p>
+ server constructs an HTTP header from this data. See <url href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</url> for the appropriate value for each header field. If the
+ client is an HTTP/1.0 client, the server filters the
+ list so that only HTTP/1.0 header fields are sent back
+ to the client.</p>
<p>If <c>Body</c> is returned and equal to <c>{Fun,Arg}</c>,
the web server tries <c>apply/2</c> on <c>Fun</c> with
<c>Arg</c> as argument. The web server expects that the fun either