1 files changed, 94 insertions, 0 deletions
diff --git a/doc/commands.txt b/doc/commands.txt
new file mode 100644
index 0000000..85a32f7
--- /dev/null
+++ b/doc/commands.txt
@@ -0,0 +1,94 @@
+Anything starting with a / is a command, unless it starts with
+*two* / in which case the first one is removed and the rest is
+sent as channel/query text.
+
+Example: someone asks you where the password file is on UNIX. If you
+reply "/etc/passwd", that would be considered a command. You type
+"//etc/passwd" and the string "/etc/passwd" gets sent to the channel.
+
+Anything that starts with / that isn't listed here gets sent to the
+IRC server as-is, minus the /. That's why /nick, /who, /whois aren't
+listed here, for instance.
+
+/j <channel>
+/join <channel>
+Joins a channel, creates a new screen if possible. If a screen can't
+be created, channel text will be sent to the [server] screen, and
+"/m #channel" must be used, to send to the channel.
+
+/j1 <channel>
+/join1 <channel>
+Joins a channel without creating a new screen. Channel test will be
+sent to the [server] screen. Use "/m #channel" to send to the channel.
+
+/m <nick|channel> <text>
+/msg <nick|channel> <text>
+PRIVMSG to nick or channel.
+
+/q <nick> [<msg>]
+/query <nick> [<msg>]
+Creates a screen for PMs to/from <nick> if possible. If <msg> is
+given, sends it to the <nick>. <nick> can also be a channel, which
+creates a channel screen for a channel that doesn't already have
+its own screen.
+
+/quit [<msg>]
+Quits IRC with optional quit message.
+
+/p [#chan] [<msg>]
+/part [#chan] [<msg>]
+Parts (leaves) a channel. If no #chan is given, the current screen's
+channel is parted (if you're in a channel screen). If there's a screen
+for the channel, it gets closed.
+
+/names [<channel>]
+Shows the list of users in a channel. Uses the current screen's channel,
+if no <channel> given. On most networks, it's not very useful to use
+/names on a channel you haven't joined.
+
+/topic [<channel>]
+Shows the channel topic and its creator. With no <channel>, uses the
+current screen's channel.
+
+/ping [<nick>]
+With no argument: ping the server. With arg: CTCP ping the nick.
+The contents of RTCLOK are sent as the ping data, so when the
+PONG response is received, the round-trip time can be shown, with
+up to 1/60 (NTSC) or 1/50 (PAL) second accuracy.
+TODO: not implemented yet.
+
+/me <action>
+CTCP ACTION. Only works in a channel or query screen (eventually
+it'll work in [server] and [private] too)
+
+/ver <nick>
+CTCP VERSION.
+
+/info [<nick>]
+With <nick>, CTCP CLIENTINFO. Without <nick>, INFO command for the
+server.
+
+/ctcp <nick> <command> [<text>]
+Send arbitrary CTCP commands.
+
+/list <arg(s)>
+This command will be sent to the server as-is. The only reason it's a
+local command is so the argument can be required: sending LIST without
+any arguments lists every channel on the server, which isn't useful.
+
+/color <bg> [<fg>] [<status-active>] [<status-highlight>]
+Set colors. This should be on a per-screen basis, eventually.
+TODO: this only takes bg and fg arguments, currently.
+
+/chans
+List all channels we've joined. This will actually be limited to
+something like 20 (who joins more than 20 channels anyway?)
+TODO: not implemented yet.
+
+/quote <cmd>
+Send raw IRC protocol to the server. This bypasses local command
+parsing.
+
+/alert <number>
+Set the type of alert that happens when you're PMed or highlighted
+in a channel. 0 = none, 1 = beep, 2 = flash, 3 = beep and flash.