source: doc/user-guide/misc.xml @ 8b61469

<chapter id="misc">
<title>Misc Stuff</title>

<sect1 id="smileys">
<title>Smileys</title>

<para>
All MSN smileys (except one) are case insensitive and work without the nose too.
</para>

<variablelist>
        <varlistentry><term>(Y)</term><listitem><para>Thumbs up</para></listitem></varlistentry>
        <varlistentry><term>(N)</term><listitem><para>Thumbs down</para></listitem></varlistentry>
        <varlistentry><term>(B)</term><listitem><para>Beer mug</para></listitem></varlistentry>
        <varlistentry><term>(D)</term><listitem><para>Martini glass</para></listitem></varlistentry>
        <varlistentry><term>(X)</term><listitem><para>Girl</para></listitem></varlistentry>
        <varlistentry><term>(Z)</term><listitem><para>Boy</para></listitem></varlistentry>
        <varlistentry><term>(6)</term><listitem><para>Devil smiley</para></listitem></varlistentry>
        <varlistentry><term>:-[</term><listitem><para>Vampire bat</para></listitem></varlistentry>
        <varlistentry><term>(})</term><listitem><para>Right hug</para></listitem></varlistentry>
        <varlistentry><term>({)</term><listitem><para>Left hug</para></listitem></varlistentry>
        <varlistentry><term>(M)</term><listitem><para>MSN Messenger or Windows Messenger icon (think a BitlBee logo here ;)</para></listitem></varlistentry>
        <varlistentry><term>:-S</term><listitem><para>Crooked smiley (Confused smiley)</para></listitem></varlistentry>
        <varlistentry><term>:-$</term><listitem><para>Embarrassed smiley</para></listitem></varlistentry>
        <varlistentry><term>(H)</term><listitem><para>Smiley with sunglasses</para></listitem></varlistentry>
        <varlistentry><term>:-@</term><listitem><para>Angry smiley</para></listitem></varlistentry>
        <varlistentry><term>(A)</term><listitem><para>Angel smiley</para></listitem></varlistentry>
        <varlistentry><term>(L)</term><listitem><para>Red heart (Love)</para></listitem></varlistentry>
        <varlistentry><term>(U)</term><listitem><para>Broken heart</para></listitem></varlistentry>
        <varlistentry><term>(K)</term><listitem><para>Red lips (Kiss)</para></listitem></varlistentry>
        <varlistentry><term>(G)</term><listitem><para>Gift with bow</para></listitem></varlistentry>
        <varlistentry><term>(F)</term><listitem><para>Red rose</para></listitem></varlistentry>
        <varlistentry><term>(W)</term><listitem><para>Wilted rose</para></listitem></varlistentry>
        <varlistentry><term>(P)</term><listitem><para>Camera</para></listitem></varlistentry>
        <varlistentry><term>(~)</term><listitem><para>Film strip</para></listitem></varlistentry>
        <varlistentry><term>(T)</term><listitem><para>Telephone receiver</para></listitem></varlistentry>
        <varlistentry><term>(@)</term><listitem><para>Cat face</para></listitem></varlistentry>
        <varlistentry><term>(&amp;)</term><listitem><para>Dog's head</para></listitem></varlistentry>
        <varlistentry><term>(C)</term><listitem><para>Coffee cup</para></listitem></varlistentry>
        <varlistentry><term>(I)</term><listitem><para>Light bulb</para></listitem></varlistentry>
        <varlistentry><term>(S)</term><listitem><para>Half-moon (Case sensitive!)</para></listitem></varlistentry>
        <varlistentry><term>(*)</term><listitem><para>Star</para></listitem></varlistentry>
        <varlistentry><term>(8)</term><listitem><para>Musical eighth note</para></listitem></varlistentry>
        <varlistentry><term>(E)</term><listitem><para>Envelope</para></listitem></varlistentry>
        <varlistentry><term>(^)</term><listitem><para>Birthday cake</para></listitem></varlistentry>
        <varlistentry><term>(O)</term><listitem><para>Clock</para></listitem></varlistentry>
</variablelist>

</sect1>

<sect1 id="groupchats">
<title>Groupchats</title>
<para>
BitlBee now supports groupchats on all IM networks. This text will try to explain you how they work.
</para>

<para>
As soon as someone invites you into a groupchat, you will be force-joined or invited (depending on the protocol) into a new virtual channel with all the people in there. You can leave the channel at any time, just like you would close the window in regular IM clients. Please note that root-commands don't work in groupchat channels, they only work in the control channel (or to root directly).
</para>

<para>
Of course you can also create your own groupchats. Type <emphasis>help groupchats2</emphasis> to see how.
</para>

</sect1>

<sect1 id="groupchats2">
<title>Creating groupchats</title>

<para>
To open a groupchat, use the <emphasis>chat with</emphasis> command. For example,  to start a groupchat with the person <emphasis>lisa_msn</emphasis> in it, just type <emphasis>chat with lisa_msn</emphasis>. BitlBee will create a new virtual channel with root, you and lisa_msn in it.
</para>

<para>
Then, just use the ordinary IRC <emphasis>/invite</emphasis> command to invite more people. Please do keep in mind that all the people have to be on the same network and contact list! You can't invite Yahoo! buddies into an MSN groupchat.
</para>

<para>
Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat add</emphasis> for more information.
</para>

</sect1>

<sect1 id="away">
<title>Away states</title>

<para>
To mark yourself as away, you can just use the <emphasis>/away</emphasis> command in your IRC client. BitlBee supports most away-states supported by the protocols.
</para>

<para>
Away states have different names accross different protocols. BitlBee will try to pick the best available option for every connection:
</para>

<simplelist>
        <member>Away</member>
        <member>NA</member>
        <member>Busy, DND</member>
        <member>BRB</member>
        <member>Phone</member>
        <member>Lunch, Food</member>
        <member>Invisible, Hidden</member>
</simplelist>

<para>
So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" will be chosen.
</para>

<para>
You can also add more information to your away message. Setting it to "Busy - Fixing BitlBee bugs" will set your IM-away-states to Busy, but your away message will be more descriptive for people on IRC. Most IM-protocols can also show this additional information to your buddies.
</para>

<para>
If you want to set an away state for only one of your connections, you can use the per-account <emphasis>away</emphasis> setting. See <emphasis>help set away</emphasis>.
</para>

</sect1>

<sect1 id="nick_changes">
<title>Changing your nickname</title>

<para>
BitlBee now allows you to change your nickname. So far this was not possible because it made managing saved accounts more complicated.
</para>

<para>
The restriction no longer exists now though. When you change your nick (just using the <emphasis>/nick</emphasis> command), your logged-in status will be reset, which means any changes made to your settings/accounts will not be saved.
</para>

<para>
To restore your logged-in status, you need to either use the <emphasis>register</emphasis> command to create an account under the new nickname, or use <emphasis>identify -noload</emphasis> to re-identify yourself under the new nickname. The <emphasis>-noload</emphasis> flag tells the command to verify your password and log you in, but not load any new settings. See <emphasis>help identify</emphasis> for more information.
</para>

</sect1>

<sect1 id="channels">
<title>Dealing with channels</title>

<para>
You can have as many channels in BitlBee as you want. You maintain your channel list using the <emphasis>channel</emphasis> command. You can create new channels by just joining them, like on regular IRC networks.
</para>

<para>
You can create two kinds of channels. Control channels, and groupchat channels. By default, BitlBee will set up new channels as control channels if their name starts with an &amp;, and as chat channels if it starts with a #.
</para>

<para>
Control channels are where you see your contacts. By default, you will have one control channel called &amp;bitlbee, containing all your contacts. But you can create more, if you want, and divide your contact list accross several channels.
</para>

<para>
For example, you can have one channel with all contacts from your MSN Messenger account in it. Or all contacts from the group called "Work".
</para>

<para>
Type <emphasis>help channels2</emphasis> to read more.
</para>

</sect1>

<sect1 id="channels2">
<title>Creating a channel</title>

<para>
When you create a new channel, BitlBee will try to guess from its name which contacts to fill it with. For example, if the channel name (excluding the &amp;) matches the name of a group in which you have one or more contacts, the channel will contain all those contacts.
</para>

<para>
Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &amp;msn, it will contain all your MSN contacts. And if you have a Facebook account set up, you can see its contacts by just joining &amp;facebook.
</para>

<para>
To start a simple group chat, you simply join a channel which a name starting with #, and invite people into it. All people you invite have to be on the same IM network and contact list.
</para>

<para>
If you want to configure your own channels, you can use the <emphasis>channel set</emphasis>.
</para>

</sect1>

<sect1 id="nick_format">
<title>Nickname formatting</title>

<para>
The <emphasis>nick_format</emphasis> setting can be set globally using
the <emphasis>set</emphasis> command, or per account using <emphasis>account
set</emphasis> (so that you can set a per-account suffix/prefix or have 
nicknames generated from full names for certain accounts).
</para>

<para>
The setting is basically some kind of format string. It can contain normal
text that will be copied to the nick, combined with several variables:
</para>

<variablelist>
        <varlistentry><term>%nick</term><listitem><para>Nickname suggested for this contact by the IM protocol, or just the handle if no nickname was suggested.</para></listitem></varlistentry>
        <varlistentry><term>%handle</term><listitem><para>The handle/screenname of the contact.</para></listitem></varlistentry>
        <varlistentry><term>%full_name</term><listitem><para>The full name of the contact.</para></listitem></varlistentry>
        <varlistentry><term>%first_name</term><listitem><para>The first name of the contact (the full name up to the first space).</para></listitem></varlistentry>
        <varlistentry><term>%group</term><listitem><para>The name of the group this contact is a member of</para></listitem></varlistentry>
        <varlistentry><term>%account</term><listitem><para>Account tag of the contact</para></listitem></varlistentry>
</variablelist>

<para>
Invalid characters (like spaces) will always be stripped. Depending on your
locale settings, characters with accents will be converted to ASCII.
</para>

<para>
See <emphasis>set nick_format2</emphasis> for some more information.
</para>

</sect1>

<sect1 id="nick_format2">
<title>Nickname formatting - modifiers</title>

<para>
Two modifiers are currently available: You can include only the first few
characters of a variable by putting a number right after the %. For
example, <emphasis>[%3group]%-@nick</emphasis> will include only the first
three characters of the group name in the nick.
</para>

<para>
Also, you can truncate variables from a certain character using
the <emphasis>-</emphasis> modifier. For example, you may want to leave out
everything after the @. <emphasis>%-@handle</emphasis> will expand to
everything in the handle up to the first @.
</para>

</sect1>

</chapter>