From df22ed50f46ddaca800bf9166c274e832929ca6b Mon Sep 17 00:00:00 2001 From: Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com> Date: Fri, 15 Mar 2024 10:43:55 +0100 Subject: [PATCH] Tweak README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e006aa..e1345ce 100644 --- a/README.md +++ b/README.md @@ -102,12 +102,12 @@ binary when at least one of the following conditions holds true: * binary output is forced using the `-B` or `--binary` flag -When Mapiproxy is in `--messages` mode, it collects all bytes of whole message +When Mapiproxy is in `--messages` mode, it collects all bytes of a whole message and prints them as a single frame, skipping the block headers. In `--blocks` mode, it collects whole blocks and prints one block per frame, also without the block header. -Because of the above rules it may happen in `--blocks` modr that a +Because of the above rules it may happen in `--blocks` mode that a multi-byte character spans across a block boundary. In that case both blocks are considered to be not valid UTF-8 encoded text so they will be displayed in binary even though other blocks in the message are @@ -136,6 +136,15 @@ Mapiproxy output contains some non-ASCII Unicode characters. This cannot current be disabled. While this is typically not problem on Linux and MacOS, users on Windows platforms may encounter issues. Please share you experiences. +This is a list of the non-ASCII characters used by Mapiproxy: + +| Character | Meaning | When | +| ---------- | ------------------------------------- | ------------ | +| ‣, ┌, └, │ | Frame boundary | always | +| ↵, → | newline and tab | always | +| ⟨, ⟩ | block header markers | raw mode | +| ·, ░, ▒ | space, NUL byte, any unprintable byte | hexdump only | + When writing to a terminal or when explicitly enabled with `--color=always`, Mapiproxy uses VT-100/ANSI color escape sequences for enhanced readability, especially of the hex dumps. This behavior can be disabled by passing the flag