diff options
| author | Sébastien Helleu <flashcode@flashtux.org> | 2023-04-05 23:45:01 +0200 |
|---|---|---|
| committer | Sébastien Helleu <flashcode@flashtux.org> | 2023-04-12 17:17:13 +0200 |
| commit | 62171c5974bc805e91ae39845fe65432cf3b27fa (patch) | |
| tree | 51d71b610dea14fb92543905a8bf431376066686 /src/plugins/irc | |
| parent | e5c19459317a5155c0864a98d6081eb410e89f78 (diff) | |
| download | weechat-62171c5974bc805e91ae39845fe65432cf3b27fa.zip | |
irc: add more info in description of function irc_server_alloc_with_url (issue #1903)
Diffstat (limited to 'src/plugins/irc')
| -rw-r--r-- | src/plugins/irc/irc-server.c | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/src/plugins/irc/irc-server.c b/src/plugins/irc/irc-server.c index 2411208f0..25f2077e3 100644 --- a/src/plugins/irc/irc-server.c +++ b/src/plugins/irc/irc-server.c @@ -1695,7 +1695,20 @@ irc_server_alloc (const char *name) } /* - * Initializes a server with URL of this form: irc://nick:pass@irc.toto.org:6667 + * Initializes a server with URL, using this format: + * + * irc[6][s]://[[nick][:pass]@]server[:port][/#chan1[,#chan2...]] + * + * Fields: + * - "irc": protocol (mandatory) + * - "6": allow use of IPv6 (with fallback on IPv4) + * - "s": use SSL + * - "nick": nickname to use on the server + * - "pass": password for the server (can be used as nick password on most + * servers) + * - "server": server address + * - "port": port (default is 6667 without SSL and 6697 with SSL) + * - "#chan1": channel to auto-join * * Returns pointer to new server, NULL if error. */ |