From 86b9d4eaf56f5e694626b5bfc0d027e69a0e6953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Wei=C3=9Fl?= Date: Wed, 24 Jul 2013 00:12:08 +0200 Subject: Fix some errors in the inets documentation --- lib/inets/doc/src/httpc.xml | 6 +++--- lib/inets/doc/src/httpd.xml | 22 +++++++++++----------- lib/inets/doc/src/httpd_util.xml | 4 ++-- lib/inets/doc/src/mod_alias.xml | 4 ++-- lib/inets/doc/src/notes_history.xml | 2 +- 5 files changed, 19 insertions(+), 19 deletions(-) (limited to 'lib/inets/doc') diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml index 741f2abaef..d9a27e7d1e 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -300,11 +300,11 @@ filename() = string() process or to a file. When streaming to the calling process using the option self the following stream messages will be sent to that process: {http, {RequestId, - stream_start, Headers}, {http, {RequestId, stream, - BinBodyPart}, {http, {RequestId, stream_end, Headers}. When + stream_start, Headers}}, {http, {RequestId, stream, + BinBodyPart}}, {http, {RequestId, stream_end, Headers}}. When streaming to to the calling processes using the option {self, once} the first message will have an additional - element e.i. {http, {RequestId, stream_start, Headers, Pid}, + element e.i. {http, {RequestId, stream_start, Headers, Pid}}, this is the process id that should be used as an argument to http:stream_next/1 to trigger the next message to be sent to the calling process.

diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml index 8438961511..3c132d34fa 100644 --- a/lib/inets/doc/src/httpd.xml +++ b/lib/inets/doc/src/httpd.xml @@ -406,7 +406,7 @@ bytes begins with url-path is mapped to local files that begins with directory-filename, for example: - {alias, {"/image", "/ftp/pub/image"} + {alias, {"/image", "/ftp/pub/image"}} and an access to http://your.server.org/image/foo.gif would refer to the file /ftp/pub/image/foo.gif.

@@ -421,7 +421,7 @@ bytes by re:replace/3 to produce a path in the local filesystem. For example: - {re_write, {"^/[~]([^/]+)(.*)$", "/home/\\1/public\\2"} + {re_write, {"^/[~]([^/]+)(.*)$", "/home/\\1/public\\2"}} and an access to http://your.server.org/~bob/foo.gif would refer to the file /home/bob/public/foo.gif. @@ -468,7 +468,7 @@ bytes scripts. URLs with a path beginning with url-path are mapped to scripts beginning with directory-filename, for example: - {script_alias, {"/cgi-bin/", "/web/cgi-bin/"} + {script_alias, {"/cgi-bin/", "/web/cgi-bin/"}} and an access to http://your.server.org/cgi-bin/foo would cause the server to run the script /web/cgi-bin/foo.

@@ -483,7 +483,7 @@ bytes scripts. URLs with a path beginning with url-path are mapped to scripts beginning with directory-filename, for example: - {script_re_write, {"^/cgi-bin/(\\d+)/", "/web/\\1/cgi-bin/"} + {script_re_write, {"^/cgi-bin/(\\d+)/", "/web/\\1/cgi-bin/"}} and an access to http://your.server.org/cgi-bin/17/foo would cause the server to run the script /web/17/cgi-bin/foo.

@@ -517,7 +517,7 @@ bytes the standard CGI PATH_INFO and PATH_TRANSLATED environment variables. - {action, {"text/plain", "/cgi-bin/log_and_deliver_text"} + {action, {"text/plain", "/cgi-bin/log_and_deliver_text"}}

@@ -532,7 +532,7 @@ bytes the standard CGI PATH_INFO and PATH_TRANSLATED environment variables. - {script, {"PUT", "/cgi-bin/put"} + {script, {"PUT", "/cgi-bin/put"}}

@@ -549,7 +549,7 @@ bytes scheme scripts. A matching URL is mapped into a specific module and function. For example: - {erl_script_alias, {"/cgi-bin/example", [httpd_example]} + {erl_script_alias, {"/cgi-bin/example", [httpd_example]}} and a request to @@ -706,7 +706,7 @@ bytes For example: - {allow_from, ["123.34.56.11", "150.100.23"] + {allow_from, ["123.34.56.11", "150.100.23"]} The host 123.34.56.11 and all machines on the 150.100.23 subnet are allowed access.

@@ -719,7 +719,7 @@ bytes which should be denied access to a given directory. For example: - {deny_from, ["123.34.56.11", "150.100.23"] + {deny_from, ["123.34.56.11", "150.100.23"]} The host 123.34.56.11 and all machines on the 150.100.23 subnet are not allowed access.

@@ -835,7 +835,7 @@ bytes

Security properties - requires mod_security

-

{security_directory, {path(), [{property(), term()}]}

+

{security_directory, {path(), [{property(), term()}]}}

Here follows the valid properties for security directories

@@ -1067,7 +1067,7 @@ bytes Called for each request to the Web server. OldData = list() - NewData = [{response,{StatusCode,Body}}] | [{response,{response,Head,Body}}] | [{response,{already_sent,Statuscode,Size}] + NewData = [{response,{StatusCode,Body}}] | [{response,{response,Head,Body}}] | [{response,{already_sent,Statuscode,Size}}] StausCode = integer() Body = io_list() | nobody | {Fun, Arg} Head = [HeaderOption] diff --git a/lib/inets/doc/src/httpd_util.xml b/lib/inets/doc/src/httpd_util.xml index 9f290084d2..9218ee91e2 100644 --- a/lib/inets/doc/src/httpd_util.xml +++ b/lib/inets/doc/src/httpd_util.xml @@ -337,10 +337,10 @@ rfc1123_date() -> RFC1123Date - rfc1123_date({{YYYY,MM,DD},{Hour,Min,Sec}}}) -> RFC1123Date + rfc1123_date({{YYYY,MM,DD},{Hour,Min,Sec}}) -> RFC1123Date Return the current date in RFC 1123 format. - YYYY = MM = DD = Hour = Min =Sec = integer() + YYYY = MM = DD = Hour = Min = Sec = integer() RFC1123Date = string() diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml index 265a1b8e76..b38be5db28 100644 --- a/lib/inets/doc/src/mod_alias.xml +++ b/lib/inets/doc/src/mod_alias.xml @@ -118,7 +118,7 @@ - real_script_name(ConfigDB,RequestURI,ScriptAliases) -> Ret + real_script_name(ConfigDB, RequestURI, ScriptAliases) -> Ret Expand a request uri using ScriptAlias config directives. ConfigDB = config_db() @@ -129,7 +129,7 @@ -

real_name/3 traverses ScriptAliases, +

real_script_name/3 traverses ScriptAliases, typically extracted from ConfigDB, and matches each FakeName with RequestURI. If a match is found FakeName is replaced with RealName in the diff --git a/lib/inets/doc/src/notes_history.xml b/lib/inets/doc/src/notes_history.xml index bd59c1ba47..4162ab97bb 100644 --- a/lib/inets/doc/src/notes_history.xml +++ b/lib/inets/doc/src/notes_history.xml @@ -834,7 +834,7 @@

[ftp, client] - A new option {progress, {CBmodule, - CBFunction, InitProgressTerm} has been added to allow + CBFunction, InitProgressTerm}} has been added to allow users to create things such as progress bars in there GUI's. The option affects ftp:send/[3,4] and ftp:recv/[3,4].

-- cgit v1.2.3