docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Mon, 20 Aug 2012 18:22:40 +0300
changeset 20 f5318a5fd95f
parent 19 ff5884d8bbf5
permissions -rw-r--r--
Fix readme
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
19
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     1
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     2
# Aliases on steroids for MCabber
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     3
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     4
This module provides more flexible aliases with shell-like positional
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     5
argument substitution. For detailed explanation see help file for
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     6
command 'templatecmd', provided by this module. This command is marked
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     7
as safe for use in your mcabberrc (of course, after you loaded this
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     8
module).
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
     9
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    10
Example:
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    11
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    12
    module load templatecmd
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    13
    templatecmd cat = say_to -f $1 .
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    14
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    15
# Installation
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    16
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    17
To install it, you need:
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    18
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    19
 * mcabber headers
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    20
 * glib
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    21
 * loudmouth
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    22
 * cmake
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    23
 * make
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    24
 * c compiler (gcc)
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    25
 * linker (binutils)
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    26
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    27
Then do:
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    28
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    29
    $ mkdir build
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    30
    $ cd build
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    31
    $ cmake ..
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    32
    $ make edit_cache
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    33
    $ make
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    34
    # make install
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    35
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    36
Debian users can instead of make install do:
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    37
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    38
    $ make package
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    39
    # dpkg -i libmcabber-templatecmd_*.deb
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    40
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    41
Users of other distributions can select appropriate package generator,
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    42
using cache editor.
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    43
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    44
# License
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    45
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    46
This code underlies terms of GNU GPL v2 or later. You can find it in
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    47
file COPYING from this distribution or on a GNU web-site
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    48
<http://www.gnu.org/licenses/>.
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    49
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    50
# Contact
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    51
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    52
I will be happy to get feedback, patches, suggestions, etc.
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    53
You can send me email or contact via jabber <isbear@unixzone.org.ua>.
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    54
ff5884d8bbf5 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1
diff changeset
    55
  -- Myhailo Danylenko <isbear@ukrpost.net>