aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user-guide/Usage.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user-guide/Usage.xml')
-rw-r--r--doc/user-guide/Usage.xml58
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/user-guide/Usage.xml b/doc/user-guide/Usage.xml
new file mode 100644
index 00000000..167a74e0
--- /dev/null
+++ b/doc/user-guide/Usage.xml
@@ -0,0 +1,58 @@
+<chapter id="Usage">
+
+<title>Usage</title>
+
+<sect1>
+<title>Connecting to the server</title>
+<para>
+Since BitlBee acts just like any other irc daemon, you can connect to
+it with your favorite irc client. Launch it and connect to localhost port 6667
+(or whatever host/port you are running bitlbee on).
+</para>
+
+</sect1>
+
+<sect1>
+<title>The &amp;bitlbee control channel</title>
+
+<para>
+Once you are connected to the BitlBee server, you are automatically joined
+to &amp;bitlbee on that server. This channel acts like the 'buddy list' you have
+on the various other chat networks.
+</para>
+
+<para>
+The user 'root' always hangs around in &amp;bitlbee and acts as your interface
+to bitlbee. All commands you give on &amp;bitlbee are 'answered' by root.
+</para>
+
+<para>
+You might be slightly confused by the &amp; in the channel name. This is,
+however, completely allowed by the IRC standards. Just try it on a regular
+IRC server, it should work. The difference between the standard #channels
+and &amp;channels is that the #channels are distributed over all the servers
+on the IRC network, while &amp;channels are local to one server. Because
+the BitlBee control channel is local to one server (and in fact, to one person),
+this name seems more suitable. Also, with this name, it's harder to confuse
+the control channel with the #bitlbee channel on OFTC.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Talking to people</title>
+
+<para>
+You can talk to by starting a query with them. In most irc clients,
+this can be done with either <command>/msg &lt;nick&gt; &lt;text&gt;</command>
+or <command>/query &lt;nick&gt;</command>.
+</para>
+
+<para>
+To keep the number of open query windows limited, you can also talk to people
+in the control channel, like <command>&lt;nick&gt;: &lt;text&gt;</command>.
+</para>
+
+</sect1>
+
+</chapter>