diff options
| author | Přemysl Eric Janouch <p@janouch.name> | 2022-09-16 03:52:28 +0200 |
|---|---|---|
| committer | Přemysl Eric Janouch <p@janouch.name> | 2022-09-16 03:52:49 +0200 |
| commit | b55bae50df96b3258057ad17e7a08083d08b4819 (patch) | |
| tree | a66f899920b5e1f9247acd653ae3fe4ea798fa37 | |
| parent | 430968e5d5fdf627ce7e1563bbee22bf2f9256b2 (diff) | |
| download | xK-b55bae50df96b3258057ad17e7a08083d08b4819.tar.gz xK-b55bae50df96b3258057ad17e7a08083d08b4819.tar.xz xK-b55bae50df96b3258057ad17e7a08083d08b4819.zip | |
Update some documentation
| -rw-r--r-- | README.adoc | 3 | ||||
| -rw-r--r-- | xC-gen-proto.awk | 10 |
2 files changed, 7 insertions, 6 deletions
diff --git a/README.adoc b/README.adoc index 10b18cd..23e45ab 100644 --- a/README.adoc +++ b/README.adoc @@ -130,7 +130,8 @@ example, that would be http://localhost:8080[]: $ ../xP 127.0.0.1:8080 127.0.0.1:9000 For remote use, it's recommended to put 'xP' behind a reverse proxy, with TLS, -and some form of HTTP authentication. +and some form of HTTP authentication. Pass the external URL of the WebSocket +endpoint as the third command line argument in this case. Client Certificates ------------------- diff --git a/xC-gen-proto.awk b/xC-gen-proto.awk index de8e9b8..ad375af 100644 --- a/xC-gen-proto.awk +++ b/xC-gen-proto.awk @@ -9,7 +9,7 @@ # Native types: bool, u{8,16,32,64}, i{8,16,32,64}, string # # Don't define any new types, unless you hate yourself, then it's okay to do so. -# Both backends are a pain in the arse, for different reasons. +# Backends tend to be a pain in the arse, for different reasons. # # All numbers are encoded in big-endian byte order. # Booleans are one byte each. @@ -18,11 +18,11 @@ # Enumeration values automatically start at 1, and are encoded as i8. # Any struct or union field may be a variable-length array. # -# Message framing is done externally, but also happens to prefix u32 lengths. +# Message framing is done externally, but also happens to prefix u32 lengths, +# unless this role is already filled by, e.g., WebSocket. # -# Usage: env LC_ALL=C awk -v prefix=Relay \ -# -f xC-gen-proto.awk < xC-proto \ -# -f xC-gen-proto-{c,go}.awk > xC-proto.{c,go} | {clang-format,gofmt} +# Usage: env LC_ALL=C awk -f xC-gen-proto.awk -f xC-gen-proto-{c,go,js}.awk \ +# xC-proto > xC-proto.{c,go,js} | {clang-format,gofmt,...} # --- Utilities ---------------------------------------------------------------- |