added a biditext man page. it's not very up to date, nor is it
particularly pretty, but it's a start. patches welcome.

-- 
mulix

http://vipe.technion.ac.il/~mulix/
http://syscalltrack.sf.net/


---------- Forwarded message ----------
Date: Tue, 25 Dec 2001 23:39:48 +0200 (IST)
From: [EMAIL PROTECTED]
To: [EMAIL PROTECTED], [EMAIL PROTECTED]
Subject: [LinPrj] CVS: r2l/biditext biditext.1,NONE,1.1 ChangeLog,1.1.1.1,1.2

Update of /archive/cvs/repos/r2l/biditext
In directory alhambra:/system/backup/src/r2l/biditext

Modified Files:
        ChangeLog
Added Files:
        biditext.1
Log Message:
2001-12-25  mulix  <[EMAIL PROTECTED]>

        * biditext.1: added man page for biditext


--- NEW FILE: biditext.1 ---
.\" Process this file with
.\" groff -man -Tascii biditext.1
.\"
.TH Biditext 1 "December 2001" Linux "User Manuals"
.SH NAME
biditext \- enable showing bidirectional texts in X programs
.SH SYNOPSIS
.B biditext program [
.I arguments
.B ]
.SH DESCRIPTION
.B biditext.so
is a shared library that replaces the XDrawString,
xXDrawImageString and XDrawString16 functions from the libX11 library,
with ones that supports bidirectional printing. It will perform reversing
only on fonts with Hebrew encodings (iso8859-8, microsoft-cp1255 and
iso10646-1).
.B biditext
is a convenience script which sets the LD_PRELOAD environment variable
and then runs the original program.
.PP
XDrawString changes the direction of the text only when a file .rev in
your HOME directory exists, so when it does not exist, it behaves, exactly
like the normal function from libX11.so. Creating or removing this file
takes affect immediately, so it can be used when using Netscape to browse
Hebrew sites, and moving between pages that use Visual / Logical Hebrew.
.PP
If you want to use another name (instead of $HOME/.rev) set the environment
variable BIDITEXT_FILENAME to that file name before running biditext. e.g.
(works with bash):

  BIDITEXT_FILENAME=$HOME/.rev-ns biditext netscape
.PP
See http://linuxclub.il.eu.org/R2L/ for some programs thet provide simple
graphical interfaces for this feature.
.PP
This version also allows you to set the base directionality. See:
http://www.mail-archive.com/lin-club%40vipe.technion.ac.il/msg00323.html for
the exact details, and
http://www.mail-archive.com/lin-club%40vipe.technion.ac.il/msg00327.html for
some demostrations.
.PP
r2llib also provides a simple
.BR r2l (1)
command line program to query and
set the r2l state and biditext base state.
.PP
Note that the approach used by biditext has some inherent limitations. The
program is not aware of the logical->visual conversion and thus:
.PP
May draw parts of the line in seperate XDrawString calls (e.g: when
editing a text, or when selecting it)
.PP
When you decide to create (or delete) the .rev file, the program's
window will not update immedietly. The change will take effect only
once the text will be redrawn (e.g.: by refreshing the whole window)
.PP
(The refreshd package of the r2l project is meant to answer the second
problem. It's available from the afore mentioned locations)
.PP
It seems that the standard text box of qt2 programs does not suffer from the
first limitation, and editing text with QT2 programs (like kedit and licq)
works well, if you have got past the fonts problem.
.SH FILES
.I $HOME/.rev
.RS
This file's contents determine biditext's exact operation. It should
not be handled directly, use the
.BR r2l (1)
utility to manipulate it.
.SH ENVIRONMENT
.IP PROFILE
Enable printing of profiling information to stderr.
.IP CHECK_CHARSET
Enable checking of the string's character set to decide if it should
be reversed.
.IP TRACE_ANY
TODO
.IP TRACE_CHARSET
TODO
.IP TRACE_LOG2VIS
TODO
.SH REQUIRES
.I fribidi
Dov Grobgeld's fribidi library (version >=0.1.6), which
is available from http://fribidi.sourceforge.net, that requires glib.
.PP
.I r2llib
Biditext requires r2llib (version >= 0.32) which should have been
already supplied with it. If not, it is available from
http://technion.ac.il/~tzafrir/r2l
.SH BUGS
.PP
Occasional Bus errors, usually when quiting netscape.
.PP
May have problems with programs that do some manipulations with the
loader, e.g.: licq
.PP
0.9 added recognition of the character set, and reverses only Hebrew
strings. Thus if you use netscape 4 with web fonts, it won't revesse
your text (because it is not exactly hebrew). Apply the turkish patch
to netscape.
.PP
Regarding the changes of 0.9 and the Elmar fonts: See
http://plasma-gate.weizmann.ac.il/Linux/maillists/01/07/msg00242.html
.PP
There is another function of similar functionality to XDrawString that
is used for anti-aliased text (XftDrawString). This function is
currently not handled by biditext.
.SH AUTHORS
Matan Ziv-Av ([EMAIL PROTECTED])
.PP
Ilya Konstantinov ([EMAIL PROTECTED])
.PP
mulix ([EMAIL PROTECTED])
.PP
Tzafrir Cohen ([EMAIL PROTECTED])
.SH "SEE ALSO"
.BR r2l (1)

Index: ChangeLog
===================================================================
RCS file: /archive/cvs/repos/r2l/biditext/ChangeLog,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- ChangeLog   2001/09/13 12:42:16     1.1.1.1
+++ ChangeLog   2001/12/25 21:39:44     1.2
@@ -1,3 +1,7 @@
+2001-12-25  mulix  <[EMAIL PROTECTED]>
+
+       * biditext.1: added man page for biditext
+
 2001-09-13  tzafrir <[EMAIL PROTECTED]> (0.9.6.1)

        * added uninstall target


-------------------------------------------------------------------------
Haifa Linux Club Projects Mailing List (http://linuxclub.il.eu.org)
To unsub send an empty message to [EMAIL PROTECTED]


Reply via email to