irssi/docs/help/in/network.in
Benjamin Denhartog df5132394f
rephrase documentation to be abstract to any given network
IRSSI is an IRC client and should not advertise nor be beholden to any
particular IRC network. This patch is inspired by both of the following
commits, and aims to remove references to any particular network in the
documentation, in an effort to avoid potential conflict amongst team and
community members:

- a4486c236a
- 1ba48840a1

Based on a (as of this writing) draft blog post [0], and the discussion
that has occurred regarding the blog post, it doesn't appear as if the
IRSSI development team is interested in being transparent about the
reasoning behind its aversion to removing the Freenode network,
specifically related to the comments about "potential legal
consequences". By removing references to any given network in the
documentation, this project moves forward without taking a political
stance, but in a way that avoids recommending any given network to
users.

[0]: https://github.com/irssi/irssi.github.io/pull/79
2021-05-27 09:39:41 -06:00

69 lines
3.1 KiB
Text

%9Syntax:%9
@SYNTAX:network@
%9Parameters:%9
LIST: Displays the list of configured networks.
ADD: Adds a network to your configuration.
MODIFY: Modifies a network in your configuration.
REMOVE: Removes a network from your configuration.
-nick: Specifies the nickname to use.
-alternate_nick Specifies the alternate nickname to use.
-user: Specifies the user identity to use.
-realname: Specifies the real name to use.
-host: Specifies the hostname to use.
-usermode: Specifies the user modes to set on yourself.
-autosendcmd: Specifies the commands, separated by the ';' character,
and enclosed within two "'" characters, to perform after
connecting.
-querychans: Specifies the maximum number of channels to put in one MODE
or WHO command when synchronizing.
-whois: Specifies the maximum number of nicknames in one WHOIS
command.
-msgs: Specifies the maximum number of nicknames in one PRIVMSG
command.
-kicks: Specifies the maximum number of nicknames in one KICK
command.
-modes: Specifies the maximum number of nicknames in one MODE
command.
-cmdspeed: Specifies the minimum amount of time, expressed in
milliseconds, that the client must wait before sending
additional commands to the server.
-cmdmax: Specifies the maximum number of commands to perform before
starting the internal flood protection.
-sasl_mechanism Specifies the mechanism to use for the SASL authentication.
At the moment irssi only supports the 'plain' and the
'external' mechanisms.
Use '' to disable the authentication.
-sasl_username Specifies the username to use during the SASL authentication.
-sasl_password Specifies the password to use during the SASL authentication.
The name of the network to add, edit or remove; if no parameter is given,
the list of networks will be displayed.
%9Description:%9
Displays, adds, modifies or removes the network configuration of IRC
networks.
When using the ADD parameter on a network that already exists, the
configuration will be merged with each other.
We recommend using 'WAIT 2000' between the automated commands in order to
prevent you from being kicked from the network due to flooding commands.
%9Examples:%9
/NETWORK ADD -usermode +giw EFnet
/NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host <url> <network>
/NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' <network>
/NETWORK ADD -autosendcmd '^MSG Q@CServe.quakenet.org AUTH mike WzerT8zq; WAIT 2000; OPER mike WzerT8zq; WAIT 2000; MODE mike +kXP' Quakenet
/NETWORK MODIFY -usermode +gi EFnet
/NETWORK REMOVE <network>
%9See also:%9 CHANNEL, CONNECT, SERVER