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