server_description
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | server_description [2007/02/02 23:17] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | # $EPIC: server_description.txt, | ||
+ | ======Special Topic: | ||
+ | A [[server description]] is the way you give the client enough information | ||
+ | about an irc server for it to be added to the server list and used. | ||
+ | |||
+ | Any place you are supposed to provide a " | ||
+ | a server refnum, or the server description. | ||
+ | |||
+ | ======About server descriptions: | ||
+ | A server description is a colon-separated list of several data items that | ||
+ | changes from time to time. | ||
+ | |||
+ | | hostname | The hostname or p-addr of the server | ||
+ | | port | The port the server is running on (default: 6667) | | ||
+ | | password | The irc PASSword (if necessary) to log on with (default: none) | | ||
+ | | nickname | The irc NICKname to log on with (default: global nickname) | ||
+ | | group | The server group this belongs to (default: no group) | ||
+ | | type | The protocol type to use, either IRC or IRC-SSL (default: IRC) | | ||
+ | | protocol | The socket protocol to use, either " | ||
+ | | vhost | The local address (virtual host) to use for the connection | ||
+ | |||
+ | Only the // | ||
+ | value in a field, you can leave it blank. | ||
+ | |||
+ | Because the server description is colon separated, IPv6 p-addrs have to be | ||
+ | surrounded in square brackets such as // | ||
+ | |||
+ | ======Server descriptions and skipping fields: | ||
+ | It can be confusing to keep track of which field you want to set, especially | ||
+ | when you want to skip some of the middle fields. | ||
+ | which you can see in the above table. | ||
+ | at any time by " | ||
+ | irc.foobar.com: | ||
+ | and you can abbreviate a field name as long as it's not ambiguous: | ||
+ | irc.foobar.com: | ||
+ | |||
+ | If you skip fields by doing an assignment, any following (unassigned) | ||
+ | fields are in the same natural order as in the above table: | ||
+ | irc.foobar.com: | ||
+ | (since ' | ||
+ | |||
+ | You don't have to skip fields in order, you can skip around and specify | ||
+ | them however you want. If you happen to specify a field multiple times, | ||
+ | the last one is the one that will be used. | ||
+ | |||
+ | ======About server refnums and the server list:====== | ||
+ | Any time you present a new server description to the client, it is added to | ||
+ | the server list and is assigned a unique reference number. | ||
+ | called a " | ||
+ | is used to map windows, channels, timers, and other things to the appropriate | ||
+ | server. | ||
+ | |||
+ | The // | ||
+ | list. Two servers that have the same hostname and port are considered to | ||
+ | be the same server. | ||
+ | |||
+ | ======Examples: | ||
+ | A server on irc.foobar.com, | ||
+ | irc.foobar.com::: | ||
+ | |||
+ | A server on irc.foo.com, | ||
+ | /server -add irc.foo.com: | ||
+ | |||
+ | A server on irc.foo.com, | ||
+ | / | ||
+ | |||
server_description.txt · Last modified: 2007/02/02 23:17 by 127.0.0.1