----------------------------
| Pebrot (MSN Text client) |
----------------------------

INSTALL
-------

You must have Python 2.2 (or higher) installed to make this work, Python 1.5.x is not supported.

Pebrot will create its config dir .pebrot on your home dir. It also will copy supplied pebrotrc file there. But it cannot read your mind (maybe on 1.0 ;) ) so you must fill your hotmail user and password.

----------------------------------IMPORTANT-------------------------------------
Make sure you are the only one who can read and enter in your .pebrot config dir. 
There will be quite personal info there, like your user/password and your chat logs (if you enable 'log_chats')

Pebrot will change its access permissions when installing so you shouldn't worry at all.

Anyway, they should be:

drw-------

-------------------------------------------------------------------------------

This file stores config options with this format:

option= value

Right now you can define these options:
    - user: your passport name, remember it must include @hotmail.com.
    - password: your password.
      
      You can have several accounts defined in pebrotrc, Pebrot will log by 
      default to the first one. If you want to log with other just use -u
      argument.

      And if you don't want to have your password stored here (root user could 
      peek it) just leave this option undefined. Pebrot will ask for it before
      connecting.

    - state: initial state when login to your account. Must be one of the 
      following (can be entered in lowercase):
            NLN: Online
            FLN: Offline
            HDN: Appear Offline
            IDL: Idle
            AWY: Away
            BSY: Busy
            BRB: Be Right Back
            PHN: On the Phone 
            LUN: Out to Lunch

    - show_invited: Can have values 1 or 0. When value is 1 a chat is created 
      when someone talks to you. That is, when someone sends you a new message
      press tab and you'll go to the new chat.

      IMPORTANT!: Remember that if its value is 0 you will not be able to talk
      when invited to a chat with more than 1 buddy. 

    - auto_list: Can have values 1 or 0. If value is 1 user's list is shown
      when a user disconnects or changes his state.

    - auto_list_last_move: Can have values 1 or 0. If 1 and auto_list=1 Pebrot 
      will also show last move on users list (someone changed state or someone 
      logged out). Useful for knowing why the list was displayed last time.
    
    - auto_list_on_0: If 1 and auto_list=1 Pebrot will auto-show user's list 
      on window 0.
    
    - auto_list_on_0_clear: If 1 and auto_list=1 and auto_list_on_0=1 Pebrot 
      will clear window 0 before displaying user's list there.

    - beep_on_msg: Can have values 1 or 0. If value is 1 Pebrot will beep
      when a message is received.

    - beep_on_new_chat: Can have values 1 or 0. If value is 1 Pebrot will beep
      when a new chat is created, that is, when someone begins talking to you.

    - encoding: You can define encoding for sent/received messages.
      Pebrot selects system's encoding by default, but you can override it with 
      this option. Just ignore this option if pebrot displays and sends special
      chars with no problem at all.

    - send_typing: Can have values 1 or 0. If value is 1 Pebrot will send
      typing notifications when typing on a chat.
    
    - download_dir: Specifies where downloaded files should go. If not defined 
      it defaults to home dir.
    
    - max_name_size: Max size of names in chat window, that is, the ones before
      every displayed message (If size <= 0 it will show the full name). If 
      not defined it defaults to max_name_size= 0.

    - pal_connect_timeout: Number of seconds to wait for a pal when he is 
      invited to a chat.      
    
    - timestamp: Can have values 1 or 0. If value is 1 Pebrot will display
      timestamps when printing messages. 

    - timestamp_format: Format of the timestamp, more info in config file.

    - log_chats: Enable chat logs. They are saved under $HOME/.pebrot/logs.
      A dir with your MSN user is created and under it one file per pal.
      So if you are a@hotmail.com and your pal is b@hotmail.com, his log will 
      be on file $HOME/.pebrot/logs/a@hotmail.com/b@hotmail.com
      This way if you use Pebrot with different MSN logins your logs will 
      be correctly stored.

    - delete_key: If backspace key doesn't work on your system just find out
      its keycode with utils/getkeys.py and put it here. Should do the trick.

    - chat_title: How each chat appears on state bar. Can have these values:
          number: A number identifies each chat. 
          user: Name of the user you are chatting with. 'Multiple' 
                on a chat with more than one pal and 'Main' on first
                window.
          both: number + user 

    - chat_title_use_alias: This allows you to see alias on chat's title when 
      option chat_title=user

    - alias: Allows you to define fixed names for your pals here. That is, it 
      will print this instead of his/her screenname.

    - ping_time: This option is usefull if you are behind a firewall and get 
      disconnectd from MSN server. Its value refers to seconds between ping 
      sendings to MSN server. Setting it to 60 should be a safe bet.

    - logo_file: Ascii art file used on Pebrot start. If the file path doesn't 
      begin with '/' its interpreted as a relative path from pebrot 
      documentation dir (usually /usr/share/doc/pebrot).
      If you hate ascii peppers and the like just don't put any file path.

    - my_ip: Allows to specify your public IP. This is useful when using private
      IP and NAT, this way you can ensure that Pebrot sends the public ip of 
      your router. If you set this to 'auto' Pebrot will query 
      http://simple.showmyip.com for this info.

    - idle_time: this option allows to automatically change your state from
      "online" after a period of inactivity.
    
    - auto_unidle: when idle this will make Pebrot return to Online after 
      typing some text.

    - idle_state: this is the state to change to if you had defined the 
      previous option (idle_time).

    - auto_add_to_allowed: this option allows you to auto-add a user as 
      allowed when he/she adds you to his/her list.
    
    - exec_on_*: Allows to define shell commands to be executed on several 
      events (message, pal went online....). See included pebrotrc for more
      info.

    - col_*: All these options define screen colors for Pebrot. Names are self-
      explanatory, but it you don't know what does that col_option refers to
      just change it and see what happens :)
      

USE
---

Typing \? ot \h you can view Pebrot's command reference. It's pretty straightforward, but remember some things:

    - You can also use / instead of \ for commands. Better for irc fans :)
    
    - You can scroll main window with PG-UP, PG-DOWN keys. And you can edit your
      messages using LEFT, RIGHT, HOME, END for cursor movement. 
      With UP, DOWN you can browse previous input lines 'a la' BASH.
      And if you need to redraw window just pres Ctrl-l
      
    - Messages go to the active chat (can change it with tab, close it with
          \c and create a new one with \number)
    
    - You can use alt+number to change active chat too. And the key left from 
      number 1 works like 0.

    - Commands for changing things (like \s, \n) can be used to view their
          values, just use them without params.

    - When someone is typing, his name in chat bar will change color 
      (on terms without colors a '*' will appear before his name)

    - Chat number on state bar will change its color when someone has
      written a message in that chat. And will recover its usual 
      color when you write a message there. (On terms without colors a '+'
      will appear after the chat number).

If you want to enable transparent background on Pebrot you must install the supplied python extension module. More info in utils/transparent_bg/README.

CREDITS
-------

    Author: Angel Luis Jimenez Martinez <inspector_chan@ono.com>
    
    Mike Mintz, without his protocol analysis 
    (http://www.hypothetic.org/docs/msn/), this program wouldn't exist.
            
