Getting_Started.mdwn
changeset 1 1e57279b82b1
equal deleted inserted replaced
0:eff7327bcabe 1:1e57279b82b1
       
     1 
       
     2 [[!toc]]
       
     3 
       
     4 # Download
       
     5 
       
     6 Get the latest mcabber release from the [official website][mcabber]. It's
       
     7 usually a bzipped tarball, for example `mcabber-0.9.10.tar.bz2`.
       
     8 Untar it:
       
     9 
       
    10     % tar xvjf mcabber-0.9.10.tar.bz2
       
    11     % cd mcabber-0.9.10
       
    12 
       
    13 # Install
       
    14 
       
    15 Note: if you do not want to make a system-wide installation, you can use the
       
    16 `--prefix` option.
       
    17 
       
    18     % ./configure
       
    19     % make
       
    20     % make install
       
    21 
       
    22 OpenBSD users: you'll probably want to add `--enable-sigwinch` as there is no
       
    23 default SIGWINCH handler.
       
    24 
       
    25 # First run
       
    26 
       
    27 You could launch mcabber with no configuration file, but then you would have to
       
    28 set the options manually. The simpler way is to copy the sample configuration
       
    29 file provided with the source tree:
       
    30 
       
    31     % mkdir ~/.mcabber
       
    32     % chmod 0700 ~/.mcabber
       
    33     % cp mcabberrc.example ~/.mcabber/mcabberrc
       
    34 
       
    35 Now, edit the configuration file. You need to set your username and server (or
       
    36 only the `jid` option, starting from mcabber 0.10.0). (Note: if you want to use
       
    37 SSL/TLS encryption, have a look at the `ssl_verify` or `ssl_ignore_checks`
       
    38 options).
       
    39 
       
    40 Ok, you should be able to launch mcabber now!
       
    41 
       
    42 # It's running... Now how does it work??
       
    43 
       
    44 The mcabber screen is divided into 4 regions. The **roster**, alias
       
    45 **buddylist**, is on the left. The **chat window**, or chat buffer, is on the
       
    46 right. The **input line** lies at the bottom of the screen, under a small **log
       
    47 window**. Two status lines surround the log window. The bottom status line is
       
    48 the "main status line" and reflects mcabber general status. The other line is
       
    49 the "chat status line" and shows the status of the currently selected buddy. To
       
    50 display buddies chat buffers, you will have to enter [[Chat_Mode]]. You can
       
    51 enter _chat mode_ by pressing enter, and leave _chat mode_ with the ESC key.
       
    52 Simply sending a message will also enable _chat mode_. Use PageUp/PageDown to
       
    53 move inside the roster.
       
    54 
       
    55 Take a look at the small [User Guide][userguide] to get a quick overview.
       
    56 
       
    57 All commands in mcabber have an online help (use `/help` or `/help command`)!
       
    58 
       
    59 # Configuration etc.
       
    60 
       
    61 Read The (F) [Manpage][mcabber_man] for more details, and the [sample
       
    62 configuration file][sample_rc] to see all the available options. You can use the
       
    63 online help (command `/help`). If mcabber's help files have been translated into
       
    64 your language, you can set the corresponding `lang` option (see the config.
       
    65 file).
       
    66 
       
    67 [mcabber]:     http://mcabber.com/
       
    68 [userguide]:   http://mcabber.com/files/mcabber_guide.pdf
       
    69 [mcabber_man]: http://lilotux.net/~mikael/mcabber/files/mcabber.1.html
       
    70 [sample_rc]:   https://bitbucket.org/McKael/mcabber-crew/raw/tip/mcabber/mcabberrc.example