source: doc/user-guide/quickstart.xml @ fc0cf92

Last change on this file since fc0cf92 was 30ce1ce, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-12-12T23:30:51Z

Killed the <server> parameter to "account add" and changed the default
server for OSCAR to what both login.icq.com and login.oscar.aol.com resolve
to these days. There's no need to specify a server anymore so why bother.
And cleaned up the docs (removed all references to those OSCAR servers).

  • Property mode set to 100644
File size: 6.7 KB
Line 
1<chapter id="quickstart">
2<title>Quickstart</title>
3
4<para>
5Welcome to BitlBee, your IRC gateway to ICQ, MSN, AOL, Jabber and Yahoo Instant Messaging Systems.
6</para>
7
8<para>
9The center of BitlBee is the control channel, <emphasis>&amp;bitlbee</emphasis>. Two users will always be there, <emphasis>you</emphasis> (where "you" is the nickname you are using) and the system user, <emphasis>root</emphasis>.
10</para>
11
12<para>
13You need register so that all your IM settings (passwords, contacts, etc) can be saved on the BitlBee server. It's important that you pick a good password so no one else can access your account. Register with this password using the <emphasis>register</emphasis> command: <emphasis>register &lt;password&gt;</emphasis> (without the brackets!).
14</para>
15
16<para>
17Be sure to remember your password. The next time you connect to the BitlBee server you will need to <emphasis>identify &lt;password&gt;</emphasis> so that you will be recognised and logged in to all the IM services automatically.
18</para>
19
20<para>
21When finished, type <emphasis>help quickstart2</emphasis> to continue.
22</para>
23
24<sect1 id="quickstart2">
25<title>Add and Connect To your IM Account(s)</title>
26<!-- quickstart2 -->
27<para>
28<emphasis>Step Two: Add and Connect To your IM Account(s).</emphasis>
29</para>
30
31<para>
32To add an account to the account list you will need to use the <emphasis>account add</emphasis> command: <emphasis>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt; [&lt;server&gt;]</emphasis>.
33</para>
34
35<para>
36For instance, suppose you have an ICQ account with UIN <emphasis>72696705</emphasis> with password <emphasis>QuickStart</emphasis>, you would:
37</para>
38
39<ircexample>
40        <ircline nick="you">account add jabber bitlbee@jabber.org QuickStart</ircline>
41        <ircline nick="root">Account successfully added</ircline>
42</ircexample>
43
44<para>
45Other available IM protocols are msn, oscar, and yahoo. Oscar is the protocol used by ICQ and AOL.
46</para>
47
48<para>
49When you are finished adding your account(s) use the <emphasis>account on</emphasis> command to enable all your accounts, type <emphasis>help quickstart3</emphasis> to continue.
50</para>
51
52</sect1>
53
54<sect1 id="quickstart3">
55<title>Managing Contact Lists: Rename</title>
56
57<!--quickstart3-->
58<para>
59<emphasis>Step Three: Managing Contact Lists: Rename</emphasis>
60</para>
61
62<para>
63For most protocols (currently MSN, Jabber, Yahoo and AOL) BitlBee can download the contact list automatically from the IM server and all the on-line users should appear in the control channel when you log in.
64</para>
65
66<para>
67BitlBee will convert names into irc-friendly form (for instance: tux@example.com will be given the nickname tux). If you have more than one person who would have the same name by this logic (for instance: tux@example.com and tux@bitlbee.org) the second one to log on will be tux_. The same is true if you have a tux log on to AOL and a tux log on from Yahoo.
68</para>
69
70<para>
71It would be easy to get these two mixed up, so BitlBee has a <emphasis>rename</emphasis> command to change the nickname into something more suitable: <emphasis>rename &lt;oldnick&gt; &lt;newnick&gt;</emphasis>
72</para>
73
74<ircexample>
75        <ircline nick="you">rename tux_ bitlbeetux</ircline>
76        <ircaction nick="tux_">is now known as <emphasis>bitlbeetux</emphasis></ircaction>
77        <ircline nick="root">Nick successfully changed</ircline>
78</ircexample>
79
80<para>
81When finished, type <emphasis>help quickstart4</emphasis> to continue.
82</para>
83
84</sect1>
85
86<sect1 id="quickstart4">
87<title>Step Four: Managing Contact Lists: Add and Remove.</title>
88
89<para>
90<emphasis>Step Four: Managing Contact Lists: Add and Remove.</emphasis>
91</para>
92
93<para>
94Now you might want to add some contacts, to do this we will use the <emphasis>add</emphasis> command. It needs two arguments: a connection ID (which can be a number (try <emphasis>account list</emphasis>), protocol name or (part of) the screenname) and the user's handle. It is used in the following way: <emphasis>add &lt;connection&gt; &lt;handle&gt;</emphasis>
95</para>
96
97<ircexample>
98        <ircline nick="you">add 0 r2d2@example.com</ircline>
99        <ircaction nick="r2d2"> has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
100</ircexample>
101
102<para>
103In this case r2d2 is online, since he/she joins the channel immediately. If the user is not online you will not see them join until they log on.
104</para>
105
106<para>
107Lets say you accidentally added r2d3@example.com rather than r2d2@example.com, or maybe you just want to remove a user from your list because you never talk to them. To remove a name you will want to use the <emphasis>remove</emphasis> command: <emphasis>remove &lt;nick&gt;</emphasis>
108</para>
109
110<para>
111When finished, type <emphasis>help quickstart5</emphasis> to continue.
112</para>
113
114</sect1>
115
116<sect1 id="quickstart5">
117<title>Chatting</title>
118
119<para>
120<emphasis>Step Five: Chatting.</emphasis>
121</para>
122
123<para>
124First of all, a person must be on your contact list for you to chat with them (unless it's a group chat, <emphasis>help groupchats</emphasis> for more). If someone not on your contact list sends you a message, simply add them to the proper account with the <emphasis>add</emphasis> command. Once they are on your list and online, you can chat with them in &amp;bitlbee:
125</para>
126
127<ircexample>
128        <ircline nick="you">tux: hey, how's the weather down there?</ircline>
129        <ircline nick="tux"> you: a bit chilly!</ircline>
130</ircexample>
131
132<para>
133If you'd rather chat with them in a separate window use the <emphasis>/msg</emphasis> or <emphasis>/query</emphasis> command, just like you would for a private message in IRC.  If you want to have messages automatically come up in private messages rather than in the &amp;bitlbee channel, use the <emphasis>set private</emphasis> command: <emphasis>set private true</emphasis> (<emphasis>set private false</emphasis> to change back).
134</para>
135
136<para>
137You know the basics. If you want to get to know more about BitlBee, please type <emphasis>help quickstart6</emphasis>.
138</para>
139
140</sect1>
141
142<sect1 id="quickstart6">
143<title>Further Resources</title>
144
145<para>
146<emphasis>So you want more than just chatting? Or maybe you're just looking for a feature?</emphasis>
147</para>
148
149<para>
150You can type <emphasis>help set</emphasis> to learn more about the possible BitlBee user settings. Among these user settings you will find options for common issues, such as changing the charset, HTML stripping and automatic connecting (simply type <emphasis>set</emphasis> to see current user settings).
151</para>
152
153<para>
154For more subjects (like groupchats and away states), please type <emphasis>help index</emphasis>.
155</para>
156
157<para>
158If you're still looking for something, please visit us in #bitlbee on the OFTC network (you can connect via irc.bitlbee.org), or mail us your problem/suggestion. Good luck and enjoy the Bee!
159</para>
160
161</sect1>
162
163</chapter>
Note: See TracBrowser for help on using the repository browser.