From e73108d6da5b5f5b8a08751cefaa0a5bdf6bc106 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Fri, 15 Nov 2013 13:48:33 +0100 Subject: [PATCH] document http_rewrite, present_chunk, sd_remove MP-468 --- doc/Makefile.am | 25 ++++++---- doc/http_rewrite.xml | 133 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/present_chunk.xml | 66 ++++++++++++++++++++++++ doc/sd_remove.xml | 64 ++++++++++++++++++++++++ 4 files changed, 279 insertions(+), 9 deletions(-) create mode 100644 doc/http_rewrite.xml create mode 100644 doc/present_chunk.xml create mode 100644 doc/sd_remove.xml diff --git a/doc/Makefile.am b/doc/Makefile.am index 5cf88df..282122d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,7 +2,7 @@ SUBDIRS = common INKSCAPE=inkscape -SUFFIXES=.3mp .1 .pdf .tkl .esp .xml +SUFFIXES=.3mp .1 .pdf .tkl .esp .xml XMLFILES = book.xml manref.xml copyright.xml gpl-2.0.xml local.ent @@ -18,20 +18,23 @@ XMLMAN = metaproxy.xml \ frontend_net.xml \ http_client.xml \ http_file.xml \ + http_rewrite.xml \ limit.xml \ load_balance.xml \ log.xml \ multi.xml \ + present_chunk.xml \ query_rewrite.xml \ - record_transform.xml\ + record_transform.xml\ + sd_remove.xml \ session_shared.xml \ sort.xml \ sru_z3950.xml\ template.xml \ virt_db.xml \ z3950_client.xml \ - zoom.xml \ - zeerex_explain.xml + zeerex_explain.xml \ + zoom.xml MANFILES = metaproxy.1 \ metaproxy-config.1 \ @@ -43,11 +46,15 @@ MANFILES = metaproxy.1 \ frontend_net.3mp \ http_client.3mp \ http_file.3mp \ + http_rewrite.3mp \ limit.3mp \ load_balance.3mp \ log.3mp \ - multi.3mp query_rewrite.3mp \ - record_transform.3mp\ + multi.3mp + present_chunk.3mp \ + query_rewrite.3mp \ + record_transform.3mp \ + sd_remove.3mp \ session_shared.3mp \ sort.3mp \ sru_z3950.3mp \ @@ -55,11 +62,11 @@ MANFILES = metaproxy.1 \ virt_db.3mp \ z3950_client.3mp \ zeerex_explain.3mp \ - zoom.3mp + zoom.3mp HTMLFILES = index.html -# testing if this does the job of collecting up the unnamed '*.html' files +# testing if this does the job of collecting up the unnamed '*.html' files #UNLISTEDHTML = $(wildcard *.html) PNGFILES = multi.png @@ -67,7 +74,7 @@ PNGFILES = multi.png doc_DATA = $(HTMLFILES) $(PNGFILES) man_MANS = $(MANFILES) -EXTRA_DIST = $(XMLFILES) $(XMLMAN) $(doc_DATA) $(man_MANS) multi.svg +EXTRA_DIST = $(XMLFILES) $(XMLMAN) $(doc_DATA) $(man_MANS) multi.svg $(MANFILES): local.ent diff --git a/doc/http_rewrite.xml b/doc/http_rewrite.xml new file mode 100644 index 0000000..dbbcfc6 --- /dev/null +++ b/doc/http_rewrite.xml @@ -0,0 +1,133 @@ + + + %idcommon; +]> + + + http_rewrite + 3mp + Metaproxy Module + + + + http_rewrite + Module for rewriting HTTP content and headers + + + DESCRIPTION + + The primary purpose of this module is to rewrite links (URLs) for + proxying. The configuration is divided in two sections: + request and response for dealing with the HTTP request and response + respectively. + + + Each section consists of rule and content elements. Each rule must be + given a name (attribute "name") and these are referred to from + content elements. The content defines what rules are invoked. + + + Each rule consists of one or more rewrite elements. The rewrite + specifies a regular expression for matching content in the attribute + "from" and the corresponding attribute "from" specifies the result. + The "to" result may refer to named groups in any "from" pattern already + executed. For example, in the response section a rule may refer to both + groups in the response already executed and all rules exectuted in the + request section. + + + Each content section takes exactly one "type" attribute, which specifies + what area is inspected for rewriting. Type may be one of + "html" (for HTML content), "headers" for HTTP headers or + "quoted-literal" for Java Script type of content. + The content section takes one or more "within" elements. That specifies + where inside the content, each rule is being exectuted. All within + must have a "rule" attribtue that specifies the rule section to be + invoked (rule@name as mentioned earlier). + + + For "html" content, the within element takes also attributes "tag" + and "attr",that specifies tag and attributes to be inspected. + The attr attributes takes one or more attributes (comma separated). + If no "tag" is given, the rule is performed on all attributes + with the name given. + + + For "headers" content the within element takes "header" or "reqline" + + the "rule" attribute. For "header", the rule is performed on all + HTTP headers with the name in header. For "reqline", the + HTTP Request line is rewritten. + + + For "quoted-literal" content, the within element takes only a + "rule" attribute and the rule is performed on all content. + + + + SCHEMA + + + + + EXAMPLES + + Configuration: + + + + + + + + + + + + + + + + + + + + + + + + + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/present_chunk.xml b/doc/present_chunk.xml new file mode 100644 index 0000000..b57332d --- /dev/null +++ b/doc/present_chunk.xml @@ -0,0 +1,66 @@ + + + %idcommon; +]> + + + present_chunk + 3mp + Metaproxy Module + + + + present_chunk + Splits Z39.50 Present Request into chunks + + + DESCRIPTION + + This module converts a present requests to one or more present + requests (chunks). Some Z39.50 server software may crash or large + present requests (number of records requested). + This module tries to fix that. It takes a "chunk" element in + configuration that specifies the maximum number of records to fetch + in each chunk. + + + + SCHEMA + + + + + EXAMPLES + + Configuration: + + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/sd_remove.xml b/doc/sd_remove.xml new file mode 100644 index 0000000..b44b848 --- /dev/null +++ b/doc/sd_remove.xml @@ -0,0 +1,64 @@ + + + %idcommon; +]> + + + sd_remove + 3mp + Metaproxy Module + + + + sd_remove + Removes Surrogate Diagnostics + + + DESCRIPTION + + This filter removes surrogate-diagnostics from Z39.50 records. It + replaces the surrogate diagnostics records with SUTRS records. This + module has no general use. It was only implemented to avoid a particualr + Z39.50 from crashing. + + + + SCHEMA + + + + + EXAMPLES + + Configuration: + + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + -- 1.7.10.4