r2l with pluggable UI
=====================

Current version: 0.5 (See file 'Changelog' for latest changes).

TOC:

1. Purpose.
2. Generally supported command-line options.
3. Compilation.
4. Bug reports.

----------------------------------------------------------------
1. Purpose:

r2l-plugins contains a set of small 'r2l' utilities, used to control
biditext. The package currently contains a terminal-mode plugin (r2lterminal),
a gnome applet (r2lgnomeapplet) and a window maker dock applet (r2ldockapp).

biditext allows controlling 2 aspects of its operation after it has been
launched:

1. enabling/disabling biditext. If enabled, it'll manipulate Implicit Hebrew
   text and try to show it properly. If disabled - all text will be displayed
   as if biditext wasn't used at all.

2. setting biditext's base bidi direction to one of LTR (assume each
   line's main language is English), RTL (assume each line's main language
   is Hebrew or Arabic) or Neutral (biditext will guess the main direction
   on its own, based on the line's contents).

----------------------------------------------------------------
2. Generally supported command-line options:

Each r2l variant supports the following command-line options(*):

  1. --title "title"  - sets the title of the applet to the given text.
                        use an empty string (--title "") to remove the title.
                        if no '--title' option is given, the default title
                        'r2l' is displayed.

  2. --thin-interface - makes r2l show a minimal user interface, taking
                         less screen space. In a graphical interface, this will
		         cause showing a title, and two buttons - one marked
		         with a '1' or '0', to enable and disable biditext.
		         the other button, marked with a '--', '->' or '<-',
                         is used to set biditext's base bidi mode to neutral,
                         LTR or RTL, respectively.

  3. --fat-interface  - makes r2l show a more complete user interface, at the
                        price of taking more screen space. the main difference
		        is that below the buttons, there is an icon showing
		        the state of biditext, and the buttons don't change
		        their labels.

* NOTE - the window maker's dock applet behaves differently, in the sense that
  it does not have buttons in its GUI. Instead, clicking the left mouse button
  on the icon disables biditext. clicking the right mouse button enables
  biditext, and clicking the middle mouse button toggles biditext's base bidi
  mode. This behavior will be changed to match the behavior of the other
  applets in a future version.

----------------------------------------------------------------
3. Compilation.

to compile, just type 'gmake'. to install - 'gmake install'.
if you want to compile only some of the plugins, edit the 'Makefile',
and change the 'program binary file name' variable 'PROGS' to contain only
the binaries you want to compile, which could be any of:
  TERMINAL_PROG - a terminal mode application.
  GNOME_PROG    - gnome applet, requires the gnome libraries and compilation
                  environment.
  WM_PROG       - window maker dock applet. requires having window maker's
                  dockapp library and header files.

----------------------------------------------------------------
4. Bug reports.

any bugs, feature requests are info requests should be emailed to
guy keren <choo@actcom.co.il>.
----------------------------------------------------------------

