irssi/docs/help/in/channel.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

48 lines
1.5 KiB
Text

%9Syntax:%9
@SYNTAX:channel@
%9Parameters:%9
LIST: Displays the list of configured channels.
ADD: Adds a channel to your configuration.
MODIFY: Modifies a channel in your configuration.
REMOVE: Removes a channel from your configuration.
-auto: Automatically join the channel.
-noauto: Don't join the channel automatically.
-bots: The list of hostnames send automated commands to.
-botcmd: The automated commands to perform.
The channel and network to add to the configuration; you can optionally
specify the password of a channel.
If no parameters are given, the list of channels you have joined will be
displayed.
%9Description:%9
Adds, removes or displays the configuration of channels; this method is
used to automate and simplify your workflow.
You can use the ADDALLCHANS command, which is a default alias, to add all
the channels you are present on into the configuration.
%9Examples:%9
/CHANNEL
/CHANNEL LIST
/CHANNEL ADD -auto #irssi <network>
/CHANNEL ADD -auto #basementcat Quakenet secret_lair
/CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout <network>
/CHANNEL ADD -auto -bots 'Q!TheQBot@CServe.quakenet.org' -botcmd '^MSG Q op #irssi' #irssi Quakenet
/CHANNEL MODIFY -noauto #irssi <network>
/CHANNEL REMOVE #hideout <network>
%9Special Example:%9
/ADDALLCHANS
%9See also:%9 JOIN, TS