docs/readme.mdwn
changeset 19 ff5884d8bbf5
parent 1 9eb794ebef85
child 20 f5318a5fd95f
equal deleted inserted replaced
18:aeb36f2945de 19:ff5884d8bbf5
       
     1 
       
     2 # Aliases on steroids for MCabber
       
     3 
       
     4 This module provides more flexible aliases with shell-like positional
       
     5 argument substitution. For detailed explanation see help file for
       
     6 command 'templatecmd', provided by this module. This command is marked
       
     7 as safe for use in your mcabberrc (of course, after you loaded this
       
     8 module).
       
     9 
       
    10 Example:
       
    11 
       
    12     module load templatecmd
       
    13     templatecmd cat = say_to -f $1 .
       
    14 
       
    15 # Installation
       
    16 
       
    17 To install it, you need:
       
    18 
       
    19  * mcabber headers
       
    20  * glib
       
    21  * loudmouth
       
    22  * cmake
       
    23  * make
       
    24  * c compiler (gcc)
       
    25  * linker (binutils)
       
    26 
       
    27 Then do:
       
    28 
       
    29     $ mkdir build
       
    30     $ cd build
       
    31     $ cmake ..
       
    32     $ make edit_cache
       
    33     $ make
       
    34     # make install
       
    35 
       
    36 Debian users can instead of make install do:
       
    37 
       
    38     $ make package
       
    39     # dpkg -i libmcabber-templatecmd_*.deb
       
    40 
       
    41 Users of other distributions can select appropriate package generator,
       
    42 using cache editor.
       
    43 
       
    44 # License
       
    45 
       
    46 This code underlies terms of GNU GPL v2 or later. You can find it in
       
    47 file COPYING from this distribution or on a GNU web-site
       
    48 <http://www.gnu.org/licenses/>.
       
    49 
       
    50 # Contact
       
    51 
       
    52 I will be happy to get feedback, patches, suggestions, etc.
       
    53 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
       
    54 
       
    55   -- Myhailo Danylenko <isbear@ukrpost.net>
       
    56 
       
    57 This is a module to allow more flexible aliases with shell-like positional
       
    58 variable substitution. Provides command '/templatecmd'.
       
    59 
       
    60 INSTALLATION
       
    61 
       
    62 To install it, you need:
       
    63 cmake
       
    64 gcc
       
    65 make
       
    66 mcabber headers
       
    67 glib
       
    68 
       
    69 Then do
       
    70 $ mkdir build
       
    71 $ cd build
       
    72 $ cmake ..
       
    73 $ make edit_cache
       
    74 $ make
       
    75 # make install
       
    76 
       
    77 Debian users can instead of make install do
       
    78 $ fakeroot make package
       
    79 # dpkg -i libmcbaber-templatecmd*.deb
       
    80 
       
    81 Users of other distributions can select appropriate package
       
    82 generator, using cache editor.
       
    83 
       
    84 LICENSE
       
    85 
       
    86 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
       
    87 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
       
    88 
       
    89 CONTACTS
       
    90 
       
    91 I will be happy to get feedback, patches, suggestions, etc.
       
    92 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
       
    93 
       
    94   -- Myhailo Danylenko <isbear@ukrpost.net>
       
    95