Table of Contents
This document provides information on the IRC URL scheme handled by the Textual IRC Client.
URL Scheme
The supported format is as follows:
<irc|ircs>://<server>:<port>/[#channel][,needssl]Explanation
There are two schemes that are supported: irc and ircs. irc represents a non-SSL connection while ircs is SSL based.
<server> can represent any standard, resolvable domain name as well as properly formatted IPv4 or IPv6 network addresses. If an IPv6 address is specified, then it must be encapsulated in square brackets similar to the HTTP URL scheme.
<port> is any number that is between 1 and 999,999. It is the port that the connection will occur on. The port is entirely optional and will default to 6667 if none is specified. <port> should proceed <server> and be separated by a colon (:).
<server> and either URL scheme are the only part of the URL that are actually required.
[#channel] which follows next does not require the # prefix and is limited to one channel. It is not a list. Only a single channel can follow the forward slash after the server address.
After [#channel], the token needssl can be defined. This token tells the irc scheme to default to SSL instead of using the ircs scheme. needssl cannot stand alone. It must be preceeded by a comma with [#channel] in front of it. If no channel is specified, then it will be interpreted as the channel #needssl.
Examples
irc://irc.example.com
irc://irc.example.com:6667
irc://irc.example.com/#channel - normal connection to #channel
ircs://irc.example.com:6697/#channel - SSL based connection to #channel
irc://irc.example.com:6697/#channel,needssl - SSL based connection to #channel