From 69ee0062d7bb1b1d61d25cd547d0881d7c3c3df2 Mon Sep 17 00:00:00 2001 From: Jakub Jelen Date: Fri, 8 Nov 2024 17:55:18 +0100 Subject: [PATCH] options: Clarify format of HOST option Signed-off-by: Jakub Jelen Reviewed-by: Andreas Schneider (cherry picked from commit 91e228b08b8e9b81790100d7eec92ae79621a8e9) --- src/options.c | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/options.c b/src/options.c index 015fe429..55c7be39 100644 --- a/src/options.c +++ b/src/options.c @@ -311,7 +311,14 @@ int ssh_options_set_algo(ssh_session session, * following: * * - SSH_OPTIONS_HOST: - * The hostname or ip address to connect to (const char *). + * The hostname or ip address to connect to. It can be also in + * the format of URI, containing also username, such as + * [username@]hostname. The IPv6 addresses can be enclosed + * within square braces, for example [::1]. The IPv4 address + * supports any format supported by OS. The hostname needs to be + * encoded to match RFC1035, so for IDN it needs to be encoded + * in punycode. + * (const char *). * * - SSH_OPTIONS_PORT: * The port to connect to (unsigned int).