docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Mon, 20 Aug 2012 22:39:00 +0300
changeset 32 ca6ef5ecb3ce
parent 3 README@c0c84518b242
permissions -rw-r--r--
Rearrange docs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     1
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
     2
# Command output posting for MCabber
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
     3
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
     4
This is a module for mcabber, that allows you to send shell command
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
     5
output to your buddy.
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     6
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
     7
To use this module just load it (there are some options, described in
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
     8
'cmd.rc', but none of them is required for proper operation) and use
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
     9
command 'cmd'.
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    10
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    11
# Installation
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    12
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    13
To install it, you need:
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    14
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    15
 * mcabber headers
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    16
 * glib
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    17
 * cmake
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    18
 * make
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    19
 * c compiler (gcc)
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    20
 * linker (binutils)
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    21
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    22
Then do:
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    23
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    24
    $ mkdir build
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    25
    $ cd build
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    26
    $ cmake ..
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    27
    $ make edit_cache
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    28
    $ make
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    29
    # make install
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    30
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    31
Debian users can instead of make install do:
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    32
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    33
    $ make package
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    34
    # dpkg -i libmcabber-cmd_*.deb
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    35
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    36
Users of other distributions can select appropriate package generator,
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    37
using cache editor.
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    38
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    39
# License
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    40
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    41
This code underlies terms of GNU GPL v2 or later. You can find it in
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    42
file COPYING from this distribution or on a GNU web-site
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    43
<http://www.gnu.org/licenses/>.
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    44
32
ca6ef5ecb3ce Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 3
diff changeset
    45
# Contact
1
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    46
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    47
I will be happy to get feedback, patches, suggestions, etc.
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    48
You can send me email or contact via jabber <isbear@unixzone.org.ua>.
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    49
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    50
  -- Myhailo Danylenko <isbear@ukrpost.net>