summaryrefslogtreecommitdiff
path: root/docs/help/in/channel.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 17:41:15 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-03 17:41:15 +0200
commit3f79c8553c8087a79b9c37216ac72eb3e03584d5 (patch)
tree304cac682c3f370812aa209fc7b113a29939328d /docs/help/in/channel.in
parentfd3676e40783e7a24ace7cb652dea72411737fdd (diff)
downloadirssi-3f79c8553c8087a79b9c37216ac72eb3e03584d5.zip
Syntax documentation rewrite for C-commands
Rewrote the syntax documentation for all the commands starting with the letter C.
Diffstat (limited to 'docs/help/in/channel.in')
-rw-r--r--docs/help/in/channel.in48
1 files changed, 26 insertions, 22 deletions
diff --git a/docs/help/in/channel.in b/docs/help/in/channel.in
index eb4154b4..32ac6620 100644
--- a/docs/help/in/channel.in
+++ b/docs/help/in/channel.in
@@ -1,35 +1,39 @@
+Syntax:
+
@SYNTAX:channel@
-Irssi can automatically join to specified channels in specified
-IRC networks. It can also automatically send the password when
-manually joining to channel without specifying the password.
+Parameters:
-/CHANNEL ADD [-auto | -noauto] [-bots <masks>] [-botcmd <command>]
- <channel> <network> [<password>]
+ LIST: Displays the list of configured channels.
+ ADD: Adds a channel to your configuration.
+ REMOVE: Removes a channel from your configuration.
-With -bots and -botcmd arguments you can automatically send
-commands to someone in channel. This is useful for automatically
-getting ops for channels, for example
+ -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.
-/CHANNEL ADD -auto -bots "*!bot@bothost.org bot*!*@host2.org"
- -botcmd "msg $0 op mypass" #channel ircnet
+ The channel and network to add to the configuration; you can optionally
+ specify the password of a channel.
-You can also use the -botcmd without -bots argument. The command is
-then sent whenever you join the channel.
+ If no parameters are given, the list of channels you have joined will be
+ displayed.
+
+Description:
-If you want to remove some settings from existing channel record,
-for example bots, just give the -bots "" parameters to it. Password
-can be removed by setting it to - (or actually, "" works too).
+ Adds, removes or displays the configuration of channels; this method is
+ used to automate and simplify your workflow.
-You can remove the channels with
-/CHANNEL REMOVE <channel> <network>
+Examples:
-/CHANNEL LIST displays list of channels with settings.
+ /CHANNEL ADD -auto #irssi Freenode
+ /CHANNEL ADD -auto -bots "*!@*.meow.net *!basement@cat.org" -botcmd "msg $0 op myPassword" #hideout Freenode
+ /CHANNEL ADD -auto -bots "Q!TheQBot@CServe.quakenet.org" -botcmd "^MSG Q op #irssi" #irssi Quakenet
-/CHANNEL without any arguments displays list of channels you have
-joined. You can also use /CHANNEL to join to channels just as with
-/JOIN, like /CHANNEL #a.
+ /CHANNEL
+ /CHANNEL LIST
+ /CHANNEL REMOVE #hideout Freenode
-See also: TS, JOIN
+See also: JOIN, TS