Difference between revisions of "Documentation"

From CenterIM
Jump to: navigation, search
(Add initial cim5 documentation)
(Update key bindings)
Line 43: Line 43:
 
  Ctrl-Q      : Quit CenterIM5
 
  Ctrl-Q      : Quit CenterIM5
 
  Esc        : Close current menu or conversation
 
  Esc        : Close current menu or conversation
  Arrow Keys : Universal navigation through menus and lists
+
  Arrow keys : Universal navigation through menus and lists
 
  Ctrl-L      : Redraw screen
 
  Ctrl-L      : Redraw screen
 
   
 
   
Line 50: Line 50:
 
  F3          : Open the account status menu
 
  F3          : Open the account status menu
 
  F4          : Open the general menu
 
  F4          : Open the general menu
 +
F5          : Toggle displaying of offline buddies
 +
F6          : Switch to the fullscreen mode (this requires that there is at least one opened conversation)
  
 
'''Buddy list'''
 
'''Buddy list'''
Line 63: Line 65:
 
  PgUp        : Scroll up through current conversation history
 
  PgUp        : Scroll up through current conversation history
 
  PgDn        : Scroll down through current conversation history
 
  PgDn        : Scroll down through current conversation history
 +
Ctrl-X      : Send a composed message
  
  
Line 69: Line 72:
 
== Key Bindings ==
 
== Key Bindings ==
  
TODO
+
Default key bindings can be changed by editing the <tt>binds.xml</tt> file which can be usually found in the <tt>$HOME/.centerim5</tt> directory. The file has a simple structure, each bind consists of context, action and key definitions. After modifying the file, open the options window and press the ''Reload key bindings'' button in order to load modified key bindings. If the file cannot be parsed correctly, an error description will be added to the log window and the default key bindings will be loaded.
 +
 
 +
For example, to change a default key bind for sending messages from <tt>Ctrl-X</tt> to <tt>Enter</tt>, locate this line:
 +
<bind context='conversation' action='send' key='Ctrl-x'/>
 +
and modify it to:
 +
<bind context='conversation' action='send' key='Enter'/>
  
 
== Color Schemes ==
 
== Color Schemes ==
  
 
TODO
 
TODO

Revision as of 17:33, 12 June 2012

This page contains the CenterIM5 documentation. If you're a CenterIM4 then you should read the CenterIM4 documentation.

Overview

About CenterIM5

CenterIM5 is a text-mode multi-protocol instant messaging client for Linux, *BSD, Solaris and other Unices.

Supported Protocols

CenterIM5 supports many different messaging protocols due to the use of libpurple.

These protocols are supported by default by libpurple:

  • AIM (AOL Instant Messenger)
  • Bonjour
  • Gadu-Gadu
  • Groupwise
  • ICQ
  • IRC
  • MSN/Windows Live
  • MXit
  • MySpaceIM
  • QQ
  • SILC (Secure IRC)
  • SIMPLE
  • Sametime
  • XMPP (Jabber and GoogleTalk)
  • Yahoo
  • Yahoo JAPAN
  • Zephyr

Support for other protocols is provided by third-party libpurple plugins.

First Time Start

TODO

Default Key Bindings

Universal commands (Not dependent on where focus lies)

Ctrl-Q      : Quit CenterIM5
Esc         : Close current menu or conversation
Arrow keys  : Universal navigation through menus and lists
Ctrl-L      : Redraw screen

F1          : Move navigation to the buddy list
F2          : Move navigation to the active conversation
F3          : Open the account status menu
F4          : Open the general menu
F5          : Toggle displaying of offline buddies
F6          : Switch to the fullscreen mode (this requires that there is at least one opened conversation)

Buddy list

Ctrl-D      : Open the context menu for a currently selected buddy list item
- / +       : Close / Expand tree branch
Enter       : Open a conversation with a currently selected buddy

Conversation

Ctrl-N      : Jump to the next conversation window
Ctrl-P      : Jump to the previous conversation window
PgUp        : Scroll up through current conversation history
PgDn        : Scroll down through current conversation history
Ctrl-X      : Send a composed message


Customization

Key Bindings

Default key bindings can be changed by editing the binds.xml file which can be usually found in the $HOME/.centerim5 directory. The file has a simple structure, each bind consists of context, action and key definitions. After modifying the file, open the options window and press the Reload key bindings button in order to load modified key bindings. If the file cannot be parsed correctly, an error description will be added to the log window and the default key bindings will be loaded.

For example, to change a default key bind for sending messages from Ctrl-X to Enter, locate this line:

<bind context='conversation' action='send' key='Ctrl-x'/>

and modify it to:

<bind context='conversation' action='send' key='Enter'/>

Color Schemes

TODO