"Fossies" - the Fresh Open Source Software Archive

Member "yudit-3.0.7/README.TXT" (7 Jun 2020, 14385 Bytes) of package /linux/misc/yudit-3.0.7.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README.TXT": 3.0.5_vs_3.0.7.

    1 This program is GPL 2 licensed free software and
    2   
    3    IT COMES WITH ABSOLUTELY NO WARRANTY
    4 
    5 Version:   3.0.7
    6 Location:  https://yudit.org/
    7 Author:    Gaspar Sinai <gaspar@yudit.org>
    8 Copyright: Released under the GNU General Public License, version 2, 
    9            dated June 1991, worded by the Free Software Foundation.
   10            Please read the file COPYING. (GNU)
   11            
   12 Features
   13 ========
   14  o The kinput2 method is directly supported for Japanese. </li>
   15  o X Input Method support. 
   16  o Handwriting recognition support.
   17  o Easy-to-make key-input maps that can be
   18    created to input scripts with a two-way English transliteration
   19    scheme. Yudit comes with more than 100 keyboard maps
   20    contributed by Yudit users from all over the World.
   21  o Built-in printing support
   22    High quality and locale independent postscript is generated.
   23  o Direct True Type / Open Type font support.
   24    Yudit does not need X11 TTF support to show your text. 
   25  o Yudit can display and print your text with a
   26    mixture of X11 fonts/True Type fonts.
   27    Unicode glyphs are widely available these days but still there are
   28    some scripts that need this feature. 
   29  o Cut and paste, load and save your text with various encodings. 
   30    It is possible to create a unicode text file in Linux and read 
   31    it in MS Notepad on NT. (utf-16)
   32  o Keyboard input maps can be used as text converters. This means that
   33   you can make instant transliterations of your scripts.
   34   If the transliterations is reversible, it is possible to read it
   35   back get the original text back. 
   36  o Unlinimted  undo/redo.
   37  o Overstriking and OTF <strong> composing-character support. 
   38  o 31-bit Unicode support.
   39  o Drag-and-Drop </strong> (xdnd and Dnd) support. 
   40  o Full Bidirectional text support.
   41  o Hagul Jamos with mslvt encoder (hardwired for ogulim.ttf) and X11 fonts 
   42  o Arabic, Syriac,... shaping support. 
   43  o Indic scripts: Tamil,Devanagari,Bengali,Gujarati,Gurmukhi,
   44    Oriya,Malayalam,Kannada and Telugu
   45  o Hungarian Runes (rovásírás) support in Private Use Area
   46  o Software glyph mirroring (Hungarian Runes,Old Italic)
   47  o External spell-checker (Hunspell) support
   48  o Interface for external text encryption (stoolki/sedy)
   49 
   50 How to Install
   51 ==============
   52 Prerequisites:
   53 --needed: gcc-2.96 or better  http://gcc.gnu.org/
   54 --needed: gmake 3.75 or greater ftp://prep.ai.mit.edu/
   55 --needed: X11R5 or greater (www.xfree86.org)
   56 --recommended gettext 0.10 or better for multi-language message support
   57   From version-2.4.8 it is only needed when making your own messages.
   58   Reading gettext generated files are internally supported.
   59 --optional: a lot of True Type fonts are available for free:
   60   From www.microsoft.com you can get gulim (Hangul), msgothic (Japanese) for IE.
   61   From www.bitstream.com you can get cyberbit that contains a lot of glyphs.
   62   From ftp://ftp.cs.indiana.edu/pub/fidel/fonts/ 
   63       you can get Ethiopic fonts (gfzemenu).
   64 --recommended:
   65   Several UCS fonts:
   66     http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html
   67   Unifont:
   68     http://www.czyborra.com/unifont/
   69 --recommened literature:
   70   http://www.cl.cam.ac.uk/~mgk25/unicode.html
   71 
   72 Installation Process
   73 ====================
   74 Linux:
   75 
   76 1. configure --prefix=/usr/local
   77 2. make
   78 3. make install
   79 
   80 Solaris:
   81 
   82 1. configure --prefix=/opt/Misc
   83 2. make
   84 3. make install
   85 
   86 FreeBSD:
   87 
   88 1. ./configure --prefix=/usr/local
   89 2. gmake
   90 3. gmake install
   91 
   92 Windows:
   93 
   94 1. run setup.exe
   95 2. install into a directory, like:
   96    C:\Yudit
   97    * Good to know: if you don't have setup.exe or you want to move 
   98      yudit manually to another directory you just need mytool to 
   99      change installdir:
  100       C:\NewInstallBaseDir\bin\mytool -installdir "C:\NewInstallBaseDir"
  101 3. install ghostview from, for instance, http://www.ghostgum.com.au/
  102    into, like:
  103    C:\Ghostgum
  104 4. If you install ghostview into any other directory, modify
  105       %HOME%\.yudit\yudit.properties
  106    and
  107       C:\Yudit\config\yudit.properties
  108    * Note: there is an editor that can edit unix files called yudit :)
  109       yudit C:/Yudit/config/yudit.properties
  110    and set yudit.default.preview.command to the command to execute:
  111       yudit.default.preview.command="C:/Ghostgum/gsview/gsview32.exe"
  112 5. If you don't have HOME environment set, Yudit will use C:\HOME
  113 
  114 
  115 MacOS
  116 =====
  117 Please read the instructions in README-MACOS.txt.
  118 
  119 
  120 How to make an rpm package form Yudit sources
  121 =============================================
  122 1. rpm -tb yudit-3.0.7.tar.gz
  123   or if it does not work:
  124    rpmbuild -tb yudit-3.0.7.tar.gz
  125 
  126   This will tell you where to put the compresed source code.Put it there.
  127   Most likely:
  128   Suse: /usr/src/packages/SOURCES/yudit-3.0.7.tar.gz
  129   or
  130   Redhat: /usr/src/redhat/SOURCES/yudit-3.0.7.tar.gz
  131 2. rpm -i [binary rpm]
  132 
  133 Does the GUI speak my language?
  134 ==============================
  135 Yudit menus can be displayed in several languages.
  136 
  137 In  ~/.yudit/yudit.properties file you can specify:
  138 
  139     yudit.default.language=language_code
  140 
  141 The following languages are supported:
  142 
  143 Tag Country/Language      Translated and contributed by 
  144 === ===================   =============================
  145 am  Amharic/Ethiopia      Daniel Yacob <locales@geez.org>
  146 ar  Arabic/               Mohamed kebdani <kebdani1@iam.net.ma>
  147 az  Azerbaijani Turkish   Vasif İsmailoglu <azerb_linux@hotmail.com>
  148 bn  Bengali               Anirban Mitra <mitra_anirban@yahoo.co.in>
  149 bg  Bulgaria/Bulgarian    Alexander Shopov <ash@contact.bg>
  150 de  Germany/German        Thomas Wohlfarth <Thomas.Wohlfarth@gmx.net>
  151 cs  Czechia/Czech         Lubos Stanek <stanekl@atlas.cz>
  152 en  US/English            Gáspár Sinai <gaspar@yudit.org>
  153 el  Greece/Greek          Velonis Petros <velonis@freemail.gr>
  154 es  Spain/Spanish         Juan Rafael Fernández García <jrfern@bigfoot.com>
  155 fi  Finland/Finnish       Miikka-Markus Alhonen <Miikka-Markus.Alhonen@tigatieto.com>
  156 fr  France/French         Olivier Faucheux <olivier.faucheux@etu.enseeiht.fr>
  157 ga  Irish                 Kevin Patrick Scannell <scannell@slu.edu>
  158 gu  Gujarati              Vibha Sinojia <vibhavachhani@hotmail.com>
  159 hi  Hindi                 Sanjay Khatri <sk_ind@vsnl.net>
  160 hu  Hungary/Hungarian     Gáspár Sinai <gaspar@yudit.org>
  161 ja  Japan/Japanese        Inui Yuko / Gáspár Sinai <yuko@yudit.org>
  162 ko  Korea/Korean          Jungshik Shin <jshin@mailaps.org> 
  163 mn  Mongolia/Mongolian    Natsagdorj Shagdar <natsagdorj@t-online.de>
  164 mr  Marathi               Swapnil Hajare<dreamil1000a@yahoo.com>
  165 pa  Punjabi               Madhusudan Singh <chhabra@eecs.umich.edu>
  166 pl  Polish/Poland         Pawel Zawila-Niedzwiecki <zawel@wgt.com.pl>
  167 ru  Russian/Russia        Вячеслав Диконов Vyacheslav Dikonov <sdiconov@mail.ru>
  168 sl  Slovenia/Slovenian    Roman Maurer <roman.maurer@amis.net>
  169 sr  Yugoslavia/Serbian    Slobodan Marković <twiddle@eunet.yu> 
  170 ta  Tamil                 Thuraiappah Vaseeharan <t_vasee@yahoo.com>
  171 uk  Ukrainian             Solotskyy Mykola <salo@tokyo.email.ne.jp>
  172 ur  Urdu/Pakistan         S H A N <shanali@singnet.com.sg>
  173 vi  Vietnamese/Vietnam    Hoan <hoan@wanadoo.fr>
  174 yi  Israel/Yiddish        Raphael Finkel <raphael@cs.uky.edu>
  175 zh  Chinese/HongKong      Joe Man <trmetal@yahoo.com.hk>
  176 zh_CN Chinese/Simplified  Zhou Jinnian <zhoujinnian168@yahoo.com>
  177 
  178 If you specify 
  179 
  180     yudit.default.language=default
  181 
  182 The environment variable LANG will be used to determine the 
  183 language. Use this option sparingly - it is not guaranteed that
  184 the font is available.
  185 
  186 If your language does not appear properly, you might need to
  187 change 
  188  yudit.default.font=default
  189 to
  190  yudit.default.font=MyVirtualFont
  191 
  192 The default font is internally defined in swindow/SFont.ttf as:
  193 
  194   "yudit.hex,arabforms.hex,syriacforms.hex,unifont.hex,"
  195   "markus9x18.bdf,markus18x18ja.bdf,"
  196   "-*-*-medium-r-normal--16-*-*-*-c-*-iso8859-1,"
  197   "-*-*-*-*-*--16-*-*-*-c-*-iso8859-1,"
  198   "THOOLIUC.TTF:mlym,"
  199   "ani.ttf:beng,"
  200   "pothana2000.ttf:telu,"
  201   "TCRCYoutsoUnicode.ttf:tibt,"
  202   "raghu.ttf:deva,"
  203   "mangal.ttf:deva,tunga.ttf:knda,code2000.ttf:taml,"
  204   "raavi.ttf:guru,shruti.ttf:gujr,"
  205   "arialuni.ttf,cyberbit.ttf,"
  206   "code2000.ttf,code2001.ttf:unicode:RL,arial.ttf,"
  207   "yudit.ttf"
  208 
  209 How to translate yudit messages to my language
  210 ==============================================
  211 
  212 1. cd gui
  213 2. mkdir -p locale/country_and_variant/LC_MESSAGES/
  214 3. make messages
  215 4. yudit -e utf-8 locale/country_and_variant/LC_MESSAGES/messages.po
  216 5. make messages
  217 6. make install
  218 7. mail -s locale/country_and_variant \
  219      gaspar@yudit.org < locale/country_and_variant/LC_MESSAGES/messages.po
  220 8. add 
  221     yudit.default.language=country_and_variant
  222    to ~/.yudit/yudit.properties
  223    you may want to add:
  224     yudit.default.font=yourfont
  225     yudit.default.fontsize=yourfontsize
  226   A good result can be achieved if you download and install the 
  227 
  228    http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
  229 
  230   - mkdir x11fonts   (or re-use .yudit/fonts)
  231   - cd x11fonts
  232   - wget http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
  233   - tar xfz ucs-fonts.tar.gz
  234   - xset fp+ ~/x11fonts 
  235   - (optional) put the line above into ~/.Xinitrc
  236   - change ~/.yudit/yudit.properties
  237 
  238          yudit.default.font=Misc
  239          yudit.default.fontsze=15
  240 
  241 9. Sometimes you may have a translation but it does not appear.
  242   Possible and not obvious reasons:
  243   - if the original message has \n at the end the translation should
  244     have it too.
  245   - if you see the fuzzy keyword in a comment preceeding the message
  246     it won't be included. Remove the fuzzy comment.
  247 
  248 Huspell spell-checker support
  249 =============================
  250 Type the following in command area of Yudit:
  251 
  252   howto syntax
  253 
  254 This will show how Hunspell can be used within Yudit.
  255 
  256      
  257 Japanese Input
  258 ==============
  259 If you have built the Motif version you can also use Kinput2 to input Japanese.
  260 
  261 If you want to use free packages and you have an English environment
  262 you need to do the following:
  263 
  264 o Get a conversion server, 'canna' from X11 contrib directory.
  265   This server can be built in Linux. It is usually started when the machine
  266   boots and keeps running. Make sure it uses its own wide text library.
  267   No Japanese environment is needed.
  268 
  269 o Get a 'kinput2' X front-end for X11 from the same place you got canna.
  270   If you do not have Japanese environment, make sure it links with libcanna16.
  271   Kinput is started after X in .xinitrc and it provides the input windows
  272   for the applications.
  273 
  274   The current version of kinput2 has a bug - it thinks that long is 32 bit,
  275   which is true on a pentium machine. On an alpha machine you should make
  276   sure you have a version number set to less than 2.02 in your .yuditrc so
  277   that yudit knows that it should deal with a buggy kinput2. If you have a
  278   value of zero, yudit tries to determine the version number itself.
  279 
  280 Hangul Input
  281 ============
  282 Yudit comes with kmap files for Roman transliteration, 2-set and 3-set
  283 keyboards. I expect yudit to improve on this area.
  284 
  285 Adding New Mappings
  286 ===================
  287 Please read the man page for mytool. FAQ.TXT also has some information.
  288 For clues on how to create an Handwriting input please read the
  289 mytool/hwd/hiragana.hwd utf-8 encoded file, or the same file in
  290 /usr/share/yudit/data/hiragana.hwd.
  291 
  292 Undocumented Features
  293 =====================
  294 
  295 There is a Yudit command-area command 
  296 
  297   configure
  298 
  299 that brings up the configuration file.
  300 When the configuration file is edited, Yudit will not save 
  301 the current settings when it exits, so that you can save 
  302 the config file safely. (Unless another editor session is 
  303 running...)
  304 
  305 This is documented: you should know that you can use
  306 the keyboard maps as text converters. So you convert a 
  307 Devanagari transliterated text into unicode like this:
  308 
  309 uniconv -decode Devanagari < in_itrans.txt > out_utf8.txt
  310 
  311 There are many converters for ISCII character conversion
  312 written by Anirban Mitra <mitra_anirban@yahoo.co.in> and
  313 included in this Yudit package. They all start with IS_.
  314 
  315 There is a plan to make a more extensive documentation but
  316 there are too many features and not enough time :)
  317 
  318 Acknowledgements
  319 ================
  320 乾優子 <yuko@yudit.org> for her support, and her hiragana and katakana 
  321 handwriting data.
  322 Andrew Weeks at the University of Bath for releasing his True Type 
  323   to postscript (ttf2pfa) program.
  324 Anirban Mitra <mitra_anirban@yahoo.co.in> Indic (Bengali), IS_XX.mys 
  325   transliteration maps.
  326 Grisha Mokhin <mokhin@bog.msu.ru> Tibetan support.
  327 Hosszú, Gábor <hosszu@Nimrud.eet.bme.hu> Old Hungarian Support
  328 Németh László nemeth (at) OpenOffice.org  - his hunspel can be used
  329 in yudit as an external spell checker. See 'howto syntax' document
  330 Jungshik Shin <jshin@pantheon.yale.edu> Korean support
  331 Jim Breen <jwb@dgs.monash.edu.au> for the extensive tests and
  332  bug reports.
  333 Mark E. Shoulson <mark@kli.org> for helping to test the 
  334   diactritical marks.
  335 Maarten van Gompel <proycon@anaproy.homeip.net> 
  336   - syntax higlighting, word wrapping and other fixes
  337 Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk> for the unicode FAQ and the good
  338   advise.
  339 Mohammed Elzubeir <elzubeir@fakkir.net> for helping me with Arabic.
  340 Miikka-Markus Alhonen <Miikka-Markus.Alhonen@tigatieto.com> for the
  341  huge amount of help in many scripts.
  342 Peter Soos <sp@osb.hu> - cp-1251 encoded vector font (TTF).
  343 Raphael Finkel <rfinkel@mail.csse.monash.edu.au> - extensive debugging
  344 Rajkumar S. <raj2569@yahoo.com> - Malayalam, contributor of dc-font.ttf
  345 Ričardas Čepas <rch@richard.eu.org> - FreeBSD port
  346 Robert Wells for JStroke
  347 Roman Czyborra <czyborra@dds.nl> kmap files, web-page, unifont
  348 Thomas Wohlfarth <thomas.wohlfart@usa.net>, <thomas.wohlfarth@gmx.net> 
  349   - translations, tests
  350 Thuraiappah Vaseeharan <t_vasee@yahoo.com> for his help and contributions
  351  to Tamil in Yudit. 
  352 Richard Tebb <richard.tebb@convergys.com> - for 'remote debugging' on Sparc
  353 Todd David Rudick for his program JavaDict, and the kanji hwd.
  354 Tony Laszlo <laszlo@gol.com> - extensive debugging of Yudit.
  355 Mike Fabian mfabian (at) suse.de for his help
  356 ...
  357 and you...
  358 
  359 ==============================================================================
  360 Gáspár Sinai <gaspar@yudit.org>
  361 Tokyo 2020-04-26
  362