diff --git a/CHANGELOG.md b/CHANGELOG.md index 718b8fe..a6a31b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# [Sunset (v1.14.0)](https://github.com/vi/websocat/releases/tag/v1.14.0) - 11 Nov 2024 +# [Sunset (v1.14.0)](https://github.com/vi/websocat/releases/tag/v1.14.0) - 12 Nov 2024 * Attempt to priorize ping requests and replies over normal traffic * More options to supply password for basic auth: `--basic-auth-file` and `WEBSOCAT_BASIC_AUTH` diff --git a/Cargo.lock b/Cargo.lock index b414858..c222f91 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1885,7 +1885,7 @@ checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" [[package]] name = "websocat" -version = "1.13.0" +version = "1.14.0" dependencies = [ "anymap", "argon2", diff --git a/doc.md b/doc.md index 22f0f77..a7d1625 100644 --- a/doc.md +++ b/doc.md @@ -29,7 +29,7 @@ Some address types may be "aliases" to other address types or combinations of ov ``` -websocat 1.13.0 +websocat 1.14.0 Vitaly "_Vi" Shukela Command-line client for web sockets, like netcat/curl/socat for ws://. @@ -154,13 +154,16 @@ FLAGS: OPTIONS: --socks5 - Use specified address:port as a SOCKS5 proxy. Note that proxy authentication is not supported yet. Example: - --socks5 127.0.0.1:9050 + Use specified address:port as a SOCKS5 proxy. Example: --socks5 127.0.0.1:9050 + --autoreconnect-delay-millis [A] Delay before reconnect attempt for `autoreconnect:` overlay. [default: 20] --basic-auth - Add `Authorization: Basic` HTTP request header with this base64-encoded parameter + Add `Authorization: Basic` HTTP request header with this base64-encoded parameter. Also available as + `WEBSOCAT_BASIC_AUTH` environment variable + --basic-auth-file + Add `Authorization: Basic` HTTP request header base64-encoded content of the specified file --queue-len [A] Number of pending queued messages for broadcast reuser [default: 16] @@ -262,6 +265,9 @@ OPTIONS: --socks5-bind-script [A] Execute specified script in `socks5-bind:` mode when remote port number becomes known. + --socks5-user-pass + [A] Specify username:password for SOCKS5 proxy. If not specified, the default is to use no authentication. + --socks5-destination [A] Examples: 1.2.3.4:5678 2600:::80 hostname:5678 @@ -278,6 +284,9 @@ OPTIONS: [A] Index of network interface for IPv6 multicast. Has to be either not specified or specified the same number of times as multicast IPv6 addresses. Order matters. --udp-ttl [A] Set IP_TTL, also IP_MULTICAST_TTL if applicable + --ua + Set `User-Agent` request header to this value. Similar to setting it with `-H`. + --protocol Specify this Sec-WebSocket-Protocol: header when connecting @@ -1298,6 +1307,24 @@ Example: `(stty raw -echo; websocat -b exit_on_specific_byte:stdio tcp:127.0.0.1 +### `drop_on_backpressure:` + +Internal name for --dump-spec: DropOnBackpressure + + +[A] Prevent writing from ever blocking, drop writes instead. + +Does not affect reading part. +when terminal is set to raw mode. Works only bytes read from the overlay, not on the written bytes. + +Default byte is 1C which is typically triggered by Ctrl+\. + +Example (attachable log observer): + + some_program | websocat -b -u asyncstdio: drop_on_backpressure:autoreconnect:ws-l:127.0.0.1:1234 + + + ### `waitfordata:` Aliases: `wait-for-data:` diff --git a/src/main.rs b/src/main.rs index b80b6f5..0a79a98 100644 --- a/src/main.rs +++ b/src/main.rs @@ -365,7 +365,7 @@ struct Opt { #[structopt( long = "socks5", - help = "Use specified address:port as a SOCKS5 proxy. Note that proxy authentication is not supported yet. Example: --socks5 127.0.0.1:9050" + help = "Use specified address:port as a SOCKS5 proxy. Example: --socks5 127.0.0.1:9050" )] auto_socks5: Option,