README.bidi

comment -*- mode: text; tab-width:2; indent-tabs-mode:nil -*-

mlterm BIDI support

Following is a instruction of setting up mlterm BIDI support.

* Requirement
  mlterm depends on FriBidi (http://fribidi.sourceforge.net,
  https://github.com/fribidi/fribidi) for BIDI rendering, so install fribidi
  in advance.

* Installation
  $ ./configure --enable-fribidi ...
  ...
  checking for FRIBIDI... yes
  ...
  $ make
  $ make install

* Usage
  All you have to do is specify -E utf8 option, that enables bidi by default.
  If your system locale is xx_XX.UTF-8 where UTF-8 encoding is automatically
  selected, you don't have to do anything to enable bidi support.
  
* Note
  o mlterm also supports arabic shaping, but not a few unicode fonts has no glyphs
    for it.
    So you may have to add fonts with arabic presentation glyphs to "font"
    configuration file explicitly.

  o Harfbuzz (http://harfbuzz.org) with open type fonts is also available for
    BIDI rendering, though all glyphs are left-justified.

    $ ./configure --enable-otl ...
    ...
    checking for HB... yes
    ...
    $ make
    $ make install
    $ mlterm -otl