docs/readme.mdwn
changeset 29 5d86c5fefef6
parent 25 8cfd42325d38
child 30 3a18a8bf797b
equal deleted inserted replaced
28:4e171209caee 29:5d86c5fefef6
     1 
     1 
     2 # Welcome to Yet Another Yuseless Built-In Language!
     2 # Welcome to Yet Another Yuseless Built-In Language!
     3 
     3 
     4 It provides conditional and command grouping expressions,
     4 This module provides next commands:
     5 as well as some arithmetic expression evaluation and string
     5 
     6 concatenation. String splitting is not yet implemented,
     6  * 'multi' allows to execute several mcabber commands at once.
     7 but is planned.
     7    Handy for bindings, aliases, hooks and other. Use semicolons
       
     8    to separate commands (note, however, that commands itself cannot
       
     9    contain semicolon).
       
    10  * 'if', 'then' and 'else' provide crude conditional construction.
       
    11    'if' evaluates given expression (see 'eval' for rules) and stores
       
    12    result. After that, 'then' and 'else' can be executed as many times,
       
    13    as you need, they will use stored value.
       
    14  * 'let' works like 'set', but assigned value is evaluated first
       
    15    (see 'eval' for rules).
       
    16  * 'eval' evaluates expression and then executes it as mcabber command.
       
    17    Expression can contain unquoted variable names, double-quoted strings,
       
    18    numbers and next operators:
       
    19 
       
    20     * . string concatenation
       
    21     * : string head
       
    22     * \^ string tail
       
    23     * + binary plus / string concatenation
       
    24     * - binary minus
       
    25     * \* multiplication / string replication
       
    26     * / division
       
    27     * % division remain
       
    28     * \< binary / string less than
       
    29     * \> binary / string greater than
       
    30     * = binary / string equality
       
    31 
       
    32    All operators have the same priority, and there is no grouping.
       
    33 
       
    34 All commands are marked as safe to use in initial config file.
     8 
    35 
     9 # Installation
    36 # Installation
    10 
    37 
    11 To install it, you need:
    38 To install it, you need:
    12 
    39 
    25     $ make
    52     $ make
    26     # make install
    53     # make install
    27 
    54 
    28 Debian users can instead of make install do
    55 Debian users can instead of make install do
    29 
    56 
    30     $ fakeroot make package
    57     $ make package
    31     # dpkg -i libmcbber-yaubil*.deb
    58     # dpkg -i libmcabber-yaubil*.deb
    32 
    59 
    33 Users of other distributions can select appropriate package
    60 Users of other distributions can select appropriate package
    34 generator, using cache editor.
    61 generator, using cache editor.
    35 
    62 
    36 # License
    63 # License